Shipment Object Details

Shipment Schema

Key	Type	Required	Description
_id	String	N.A. Included in API response	Primary Key of the user object.
card_style_id	String	Yes	Style ID of card. Go to Intro to Spec Sheets to learn more.
fee_node_id	String	Yes. Not included in response.	ID of the node where the shipment fee should be charged. This can only be a node that is linked to your user ID or the end user's user ID.
name	String	No	Name of the card holder. By default grabbed from the base document.
secondary_label	String	No	Optional field to include with as an additional line beneath the cardholder name (e.g. a business name).
address.address_line_1	String	N.A. Included in API response	Address street where the shipment was sent. By default grabbed from the base document unless MAILING_ADDRESS is avaliable on social_docs.
address.address_city	String	N.A. Included in API response	Address city where the shipment was sent. By default grabbed from the base document unless MAILING_ADDRESS is avaliable on social_docs.
address.address_state	String	N.A. Included in API response	Address state where the shipment was sent. By default grabbed from the base document unless MAILING_ADDRESS is avaliable on social_docs.
address.address_zipcode	String	N.A. Included in API response	Address zipcode where the shipment was sent. By default grabbed from the base document unless MAILING_ADDRESS is avaliable on social_docs.
address.address_country_code	String	N.A. Included in API response	ISO Alpha-2 formatted Address country code where the shipment was sent. By default grabbed from the base document unless MAILING_ADDRESS is avaliable on social_docs.
address.address_care_of	String	N.A. Included in API response	When address taken from MAILING_ADDRESSand address_care_of field is supplied there it auto-populates here.
subnet_id	String	N.A. Included in API response	Subnet ID associated with the shipment.
delivery	String	Yes	Delivery speed of the shipment. Go to Possible delivery Values.
delivery_carrier	String	N.A. Included in API response	Carrier of the shipment. Go to Possible delivery_carrier Values.
tracking	String	N.A. Included in API response	Tracking number of the shipment. Only avaliable if delivery is STANDARD|TRACKING, EXPEDITE or OVERNIGHT.
created_on	String	N.A. Included in API response	Unix timestamp (in ms) value of when the shipment was created.
status	String	N.A. Included in API response	Status of the shipment. Go to Possible status Values.

Possible delivery Values

Value	Description
STANDARD	Shipment will go through regular mail.
STANDARD|TRACKING	Shipment will go through regular mail with tracking.
EXPEDITE	Shipment will be expedited for faster delivery.
OVERNIGHT	Shipment will be spent overnight.

Possible delivery_carrier Values

Value	Description
USPS	Delivery Carrier for this shipment is USPS.
FEDEX	Delivery Carrier for this shipment is FedEx.
UPS	Delivery Carrier for this shipment is UPS.

Possible status Values

Value	Description
CREATED	Shipment has been created but not shipped yet.
BATCHED	Shipment has been issued to the card printer.
ACCEPTED	Shipment has been accepted by our card printer.
SHIPPED	Shipment has been shipped.
RETURNED	Shipment was shipped but returned.
CANCELED	Shipment was canceled and not shipped.