Cancel Shipment

Shipment

DELETE https://api.synapsefi.com/v3.1/users/:user_id/nodes/:node_id/subnets/:subnet_id/ship/:ship_id

This endpoint allows you to cancel a specific shipment.

Path Parameters

Name	Type	Description
ship_id	string	ID of the shipment.
subnet_id	string	ID of the subnet.
node_id	string	ID of the node.
user_id	string	ID of the user.

Headers

Name	Type	Description
X-SP-USER	string	User's OAuth key and device fingerprint, separated by a pipe.
X-SP-USER-IP	string	IP address of your device.
X-SP-GATEWAY	string	Your Client ID and Secret, separated by a pipe.

200 Subnet successfully retrieved.

{
    "_id": "5fe393ccbc382e002d9c40f8",
    "address": {
        "address_care_of": "Some User",
        "address_city": "SAN FRANCISCO",
        "address_country_code": "US",
        "address_postal_code": "94105",
        "address_street": "101 2ND ST STE 1500",
        "address_subdivision": "CA"
    },
    "card_style_id": "555",
    "created_on": 1608750028716,
    "delivery": "STANDARD",
    "delivery_carrier": "6070 Poplar Avenue, Suite 100 Memphis, Tennessee 38119",
    "name": "Test User",
    "secondary_label": false,
    "status": "CANCELED",
    "subnet_id": "5fe393cac55b7036478223be",
    "tracking": "cancelled_on_request -- transaction cancelled by platform on 1608751186000."
}

400 Query failing

{
    "error": {
        "code": "missing_user_ip",
        "en": "User IP is missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

Example Request

Please note that the Shipment has to be in CREATED status for cancellation to work. Go to Possible Status Values to learn more.

HTTP

DELETE /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fe393cac55b7036478223be/ship/5fe393ccbc382e002d9c40f8 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_5FhywpZgtn0GPqkMidJCazIKmSc0UjQ1bW8VEYOL|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{}

cURL

curl --location --request DELETE 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fe393cac55b7036478223be/ship/5fe393ccbc382e002d9c40f8' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_5FhywpZgtn0GPqkMidJCazIKmSc0UjQ1bW8VEYOL|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Python

node_id = '594e606212e17a002f2e3251'
subn_id = '59c9f77cd412960028b99d2b'
ship_id = '6101f4062846db14581f19e6'
user.cancel_card_shipment(node_id,subn_id,ship_id)

JS

node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'
ship_id = '6101f4062846db14581f19e6'
user.deleteCardShipment(node_id, subnet_id, ship_id)

PHP

//

GO

//