Skip to main content
POST
Acknowledge Shipment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Details of shipment acknowledgement

shipmentId
string

Shipment ID

Example:

"78974156816152"

attributes
object

Response

Ok

Shipment details

shipmentId
string

24-character fabric-generated unique ID of shipment

Example:

"627963716b19511e8a3a631b"

shipmentNum
string

Shipment number (external)

Example:

"78974156816152"

invoiceId
string

fabric-generated Invoice ID

Example:

"5674156816152"

allocationId
string

Allocation ID for an order, generated from allocation service

Example:

"112345678912340"

orderNumber
string[]

Order number. It's usually generated by another system, such as an external checkout system.

Example:
poNumber
string

Purchase order number (generally, vendor-generated)

Example:

"1125"

vendorId
string

Vendor ID

Example:

"56"

statusCode
enum<string>

Shipment status code

Available options:
SHIPMENT_CREATED,
SHIPMENT_CANCELLED,
PICKUP_CREATED,
PICKUP_COMPLETED,
SHIPMENT_RETURN_PENDING,
SHIPMENT_RETURN_RECEIVED,
SHIPMENT_PARTIALLY_DELIVERED,
SHIPMENT_DELIVERED
Example:

"SHIPPED"

type
enum<string>

shipment type

Available options:
STANDARD,
RESHIP,
RETURN,
SCRATCH,
PICKUP
Example:

"STANDARD"

reshipmentReasonCode
string

Reason code for reshipment

Example:

"Order went missing"

shipDate
string<date-time>

Time of shipping

Example:

"2022-06-06T07:58:30.996Z"

locationNum
string

location number from location service to get exact address.

Example:

"132412"

locationType
string

Location type based on location service such as store, distribution center (DC)

Example:

"DC"

totalCartons
integer<int32>

Total number of cartons

Example:

2

masterTrackingNumber
string

Main tracking number, to track fulfillment of all the orders

Example:

"TX112345678"

shipToId
string

Ship-to ID refers to item's delivery address

Example:

"1"

shipToAddress
object

Details of delivery address

recipient
object[]
cartons
object[]
scratchedItems
object[]

details of scratched items

createdAt
string<date-time>

Time of shipment creation

Example:

"2022-06-06T07:58:30.996Z"

updatedAt
string<date-time>

Time of last update

Example:

"2022-06-06T07:58:30.996Z"

auditLogs
object[]

Details of audit logs

attributes
object

Attribute details for additional information