get https://uat-api.synapsefi.com/v3.1/users//nodes//subnets//ship
View Card Subnet Shipments
Card Shipment Object
This Feature is in Open Beta
This product has successfully progressed through closed beta and is ready for general customer use. We are finalizing product and reliability improvements to ensure all features will properly scale.
| Key | Type | Description |
|---|---|---|
| error_code | string | See Common Errors for more information |
| http_code | string | See Common Errors for more information |
| limit | integer | Number of card shipments to display per page |
| page | integer | Page number |
| page_count | integer | Number of pages |
| ship_count | integer | Total number of card shipments |
| ships[] | array of objects | List of card shipment objects |
| ships.{}._id | string | Object ID of card shipment |
| ships.{}.address | object | Object containing the address shipment information |
| ships.{}.address.address_care_of | string | Optional field for a "care of" portion of the address, when the recipient at the mailing address may not be the primary/normal recipient at that address. Note: If provided (e.g. w/ Add Mailing Address call) this will be printed under the first address line on the card as a secondary label (unless a separate secondary_label was provided). |
| ships.{}.address.address_city | string | City for the card shipment address. |
| ships.{}.address.address_country_code | string | Country code card shipment. This value needs to be in ISO Alpha-2 (e.g. US). |
| ships.{}.address.address_street | string | Street address for the card shipment. This can be home address of a person or business address of a corp. Please include apartment, suite, or unit numbers. |
| ships.{}.address_subdivision | string | State or province abbreviation for the card shipment. This value needs to be in ISO Alpha-2 (e.g. CA). |
| ships.{}.address.address_postal_code | string | Postal code (e.g. ZIP code) for the card shipment. |
| ships.{}.card_style_id | string | Style ID of card |
| ships.{}.created_on | integer | Card creation date |
| ships.{}.delivery | string | Shipping speed of card. STANDARD, STANDARD|TRACKING, EXPEDITE, or OVERNIGHT |
| ships.{}.name | string | Name printed on card |
| ships.{}.secondary_label | string | Optional field beneath the cardholder name Note: If provided this will be printed under the first address line on the card as a secondary label. If secondary_label was not provided, please note that the address_care_of portion of a mailing address may still be printed on the card as a secondary label. |
| ships.{}.status | string | Card shipment status: BATCHED -- The card data has been sent to our vendor for printing SHIPPED -- The vendor has indicated the card has been shipped RETURNED -- The shipping carrier was unable to deliver the card. It has been returned to the vendor for destruction |
| ships.{}.subnet_id | string | Object ID of subnet |
| ships.{}.tracking | string | Tracking ID for card if it was shipped with a tracking number (Defaults as null) |
| success | boolean | Request success |