View all Subnet Shipments

Shipments

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

This endpoint allows you to get all shipments linked to a subnet.

Path Parameters

Name	Type	Description
subnet_id	string	ID of Subnet.
node_id	string	ID of Node.
user_id	string	ID of User.

Query Parameters

Name	Type	Description
per_page	integer	Maximum documents to return per page. Default and max allowed is 20.
page	integer	Page number of the paginated request. Default is 1.

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 user's device.
X-SP-GATEWAY	string	Your Client ID and Secret, separated by a pipe.

200 Users successfully retrieved.

{
   "error_code": "0",
   "http_code": "200",
   "limit": 20,
   "page": 1,
   "page_count": 1,
   "ship_count": 1,
   "ships": [
      {
         "_id": "5fe29cfb900ce3002d55e745",
         "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": 1608686843900,
         "delivery": "STANDARD",
         "delivery_carrier": "6070 Poplar Avenue, Suite 100 Memphis, Tennessee 38119",
         "name": "Test User",
         "secondary_label": false,
         "status": "CREATED",
         "subnet_id": "5fe29cf56a72f3b1e1179931",
         "tracking": null
      }
   ],
   "success": true
}

400 Query failing

{
    "error": {
        "code": "missing_user_credentials",
        "en": "User credentials are missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

Example Request

HTTP

GET /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fe29cfb900ce3002d55e745/ship 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 GET 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fe29cfb900ce3002d55e745/ship' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_5FhywpZgtn0GPqkMidJCazIKmSc0UjQ1bW8VEYOL|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json'

Python

node_id = '594e606212e17a002f2e3251'
subn_id = '59c9f77cd412960028b99d2b'
page = 1
per_page = 10
user.view_all_card_shipments(node_id,subn_id,per_page=per_page,page=page)

JS

node_id = '594e606212e17a002f2e3251'
subn_id = '59c9f77cd412960028b99d2b'
page = 1
per_page = 10
user.getAllCardShipments(node_id, subn_id, {
  per_page: per_page,
  page = page
})

PHP

//

GO

//