Create Shipment
Creates shipment. An event is generated at this point to Invoice service for invoice creation. The response includes shipmentId, which is required for subsequent calls such as GET /shipment/{shipmentId} and PUT /shipment/{shipmentId}.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.
Body
Shipment and reshipment details
Shipment number
Allocation ID for an order, generated from allocation service
fabric-generated Invoice ID
Purchase order number (generally, vendor-generated)
Vendor ID
Shipment status code
SHIPMENT_CREATED, SHIPMENT_CANCELLED, PICKUP_CREATED, PICKUP_COMPLETED, SHIPMENT_RETURN_PENDING, SHIPMENT_RETURN_RECEIVED, SHIPMENT_PARTIALLY_DELIVERED, SHIPMENT_DELIVERED Shipment type
STANDARD, RESHIP, RETURN, SCRATCH, PICKUP Reason code for reshipment
Shipping time
Location number from the location service
Location type based on location service such as store, distribution center (DC)
Total number of cartons
Main tracking number, to track fulfillment of all the orders
Ship-to ID
Details of delivery address
Shipment attributes
Response
Shipment details
24-character fabric-generated unique ID of shipment
Shipment number (external)
fabric-generated Invoice ID
Allocation ID for an order, generated from allocation service
Order number. It's usually generated by another system, such as an external checkout system.
Purchase order number (generally, vendor-generated)
Vendor ID
Shipment status code
SHIPMENT_CREATED, SHIPMENT_CANCELLED, PICKUP_CREATED, PICKUP_COMPLETED, SHIPMENT_RETURN_PENDING, SHIPMENT_RETURN_RECEIVED, SHIPMENT_PARTIALLY_DELIVERED, SHIPMENT_DELIVERED shipment type
STANDARD, RESHIP, RETURN, SCRATCH, PICKUP Reason code for reshipment
Time of shipping
location number from location service to get exact address.
Location type based on location service such as store, distribution center (DC)
Total number of cartons
Main tracking number, to track fulfillment of all the orders
Ship-to ID refers to item's delivery address
Details of delivery address
details of scratched items
Time of shipment creation
Time of last update
Details of audit logs
Attribute details for additional information
Was this page helpful?