Create shipment
Create a new shipment with a tracking code for a specific payment within a company.
Required permissions:
shipment:createpayment:basic:read
Authorizations
A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
Body
Parameters for CreateShipment
The unique identifier of the company to create the shipment for, starting with 'biz_'.
"biz_xxxxxxxxxxxxxx"
The unique identifier of the payment to associate the shipment with.
"pay_xxxxxxxxxxxxxx"
The carrier tracking code for the shipment, such as a USPS, UPS, or FedEx tracking number.
Response
A successful response
A physical shipment associated with a payment, including carrier details and tracking information.
The shipping carrier responsible for delivering this shipment.
accurate, amazon_mws, amazon_shipping, apc, asendia_usa, australia_post, axlehire_v3, better_trucks, canada_post, canpar, columbus_last_mile, chronopost, cloud_sort, courier_express, couriers_please, cs_logistics, dai_post, deutsche_post_uk, deutsche_post, dhl_ecommerce_asia, dhl_ecs, dhl_express, dhl_paket, door_dash, dpd_nl, dpd_uk, dpd, epost_global, estafeta, evri, fastway, fedex_cross_border, fedex_default, fedex_mailview, fedex_smartpost, fedex, first_choice, first_mile, flexport, gio, gio_express, gso, hailify, henry, interlink_express, jet, kuroneko_yamato, la_post, lasership_v2, loomis_express, lso, ontrac, optima, osm_worldwide, parcelforce, parcll, passport_global, post_nl, purolator, quick, royal_mail, omni_parcel, sendle, sf_express, smart_kargo, sonic, spee_dee, swyft, tforce, uds, ups_iparcel, ups_mail_innovations, ups, usps, veho, yanwen The datetime the shipment was created.
"2023-12-01T05:00:00.401Z"
The estimated delivery date for this shipment. Null if the carrier has not provided an estimate.
"2023-12-01T05:00:00.401Z"
The unique identifier for the shipment.
"ship_xxxxxxxxxxxxx"
The payment associated with this shipment. Null if the payment has been deleted or is inaccessible.
The shipping service level used for this shipment. Null if the carrier does not specify a service tier.
"Priority"
The current delivery status of this shipment.
unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error A more granular status providing additional detail about the shipment's current state. Null if no substatus applies.
address_correction, arrived_at_destination, arrived_at_facility, arrived_at_pickup_location, awaiting_information, substatus_cancelled, damaged, delayed, delivery_exception, departed_facility, departed_origin_facility, expired, substatus_failure, held, substatus_in_transit, label_created, lost, missorted, substatus_out_for_delivery, received_at_destination_facility, received_at_origin_facility, refused, return, status_update, transferred_to_destination_carrier, transit_exception, substatus_unknown, weather_delay The carrier-assigned tracking number used to look up shipment progress.
"9400111899223456789012"
The datetime the shipment was last updated.
"2023-12-01T05:00:00.401Z"

