Get Shipment by Order ID and Shipment ID

View as Markdown
Retrieves detailed shipment information for a specific order and shipment combination, including shipment status, tracking information, fulfillment center location, and contained products.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Path parameters

orderIdstringRequiredformat: "int32"
The order id to get the shipment for
shipmentIdstringRequiredformat: "int32"
The shipment id to get

Headers

shipbob_channel_idstringOptionalformat: "int32"
Channel Id for Operation

Response

Success
actual_fulfillment_datedatetime or null

The datetime of ShipBob’s completion of the fulfillment operation as promised. Currently, this means the shipment has been picked, packed, and label has been printed.

created_datedatetime
Date this shipment was created
delivery_datedatetime or null
The datetime of Shipment delivered to customer.
estimated_fulfillment_datedatetime or null

The datetime of ShipBob’s commitment for completing the shipment and handing to the carrier for delivery.

estimated_fulfillment_date_statusenum
gift_messagestring or null<=500 characters
Gift message associated with the shipment
idinteger
Unique id of the shipment
insurance_valuedouble or null
Monetary amount that this shipment was insured for
invoice_amountdouble or null
Monetary amount that was invoiced for this shipment
invoice_currency_codestring or null
is_tracking_uploadedboolean

Indicates whether the Shipment was marked with tracking information uploaded to a third-party system where the order originated.

last_tracking_update_atdatetime or null
Timestamp for the last time this shipment had a tracking update
last_update_atdatetime or null
Date this shipment was last updated
locationobject
Information about a fulfillment center that a shipment can belong to
measurementsobject
Measurements of a shipment
order_idinteger
Id of the order this shipment belongs to
package_material_typeenum
parent_cartonslist of objects or null
Carton information for this shipment
productslist of objects or null
Information about the products contained in this shipment
recipientobject
Information about the recipient of a shipment
reference_idstring or null

Client-defined external unique id of the order this shipment belongs to

require_signatureboolean
If a shipment requires signature
ship_optionstring or null
Name of the shipping option used for this shipment
statusenum
status_detailslist of objects or null
Additional details about the shipment status
trackingobject
Tracking information for a shipment

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error