Update shipment

Updates shipment details by shipment ID

Authorizations

Authorization · string · header · required

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

Headers

x-site-context · string · required

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

shipmentId · string · required

Body

application/json

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:

["112345678912340", "112345678912340"]

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

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

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

Show child attributes

shipToAddress. addressLine1 · string

Line 1 of address

Example:

"888 Broadway"

shipToAddress. addressLine2 · string

Line 2 of address

Example:

"505 suite"

shipToAddress. addressLine3 · string

Line 3 of address

shipToAddress. addressLine4 · string

Line 3 of address

shipToAddress. city · string

City of delivery

Example:

"New York"

shipToAddress. state · string

State of delivery

Example:

"NY"

shipToAddress. country · string

Country name

Example:

"USA"

shipToAddress. postalCode · string

Postal code

Example:

"1003"

shipToAddress. type · string

Address type

Example:

"home"

shipToAddress. latitude · number

Geo-latitude of delivery address

Example:

134.13413

shipToAddress. longitude · number

Geo-longitude of delivery address

Example:

757.0435

recipient · object[]

Recipient details for shipment

Show child attributes

recipient. name · object

Primary contact details

Show child attributes

recipient.name. first · string

First name of primary contact

Example:

"John"

recipient.name. middle · string

Middle name of primary contact

recipient.name. last · string

Last name of primary contact

Example:

"Doe"

recipient. email · string

Email address of primary contact for delivery

Example:

"[e-mail]"

recipient. phone · object

Phone number of primary contact

Show child attributes

recipient.phone. number · string

Phone number of primary contact

Example:

10612345678

recipient.phone. type · string

Phone type of primary contact

Example:

"MOBILE"

cartons · object[]

Carton details

Show child attributes

cartons. cartonNum · string

Carton number to identify packages

Example:

"1"

cartons. cartonType · string

Cartoon type

Example:

"Package"

cartons. promisedDeliveryDate · string

Promised delivery date

Example:

"2022-05-26T07:58:30.996Z"

cartons. estimatedShipDate · string

Estimated shipping date

Example:

"2022-05-25T07:58:30.996Z"

cartons. estimatedDeliveryDate · string

Estimated delivery date

Example:

"2022-05-26T07:58:30.996Z"

cartons. shipmentMethod · string

Shipment method

Example:

"ground"

cartons. shipmentCarrier · string

Shipment carrier

Example:

"FEDEX"

cartons. weight · string

Shipment weight

Example:

"500 gram"

cartons. trackingNumber · string

Courier tracking number for the carton

Example:

"1Z999AA10123456784"

cartons. trackingURL · string

Shipment tracking URL

Example:

"https://fedex.com/tracking"

cartons. trackingDetails · object[]

Shipment tracking details

Details of shipment tracking generated once shipment is picked up from store

Show child attributes

cartons.trackingDetails. event · string

Event status

Example:

"picked up"

cartons.trackingDetails. eventId · string

24-character system-generated unique event ID

Example:

"627963716b19511e8a3a631b"

cartons.trackingDetails. timestamp · string

Time of event creation

Example:

"2019-09-30T07:58:30.996Z"

cartons.trackingDetails. shipmentCarrier · string

Shipment carrier name. Applicable in case of a different carrier

Example:

"FEDEX"

cartons.trackingDetails. location · string

Current location

Example:

"Reno, NV"

cartons.trackingDetails. notes · object

shipment notes

Show child attributes

cartons.trackingDetails.notes. {key} · string

Shipment notes, for reference

cartons. items · object[]

Item details

Item details of a shipment

Show child attributes

cartons.items. shipmentLineItemId · string

Line item ID of shipment

Example:

"607f1f77bcf86cd799439011"

cartons.items. orderId · string

Order ID (fabric-generated)

Example:

"317736896"

cartons.items. orderNumber · string

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

Example:

"507f1f77bcf86cd799439011"

cartons.items. lineItemId · string

Line item ID to identify item in the order

Example:

"1"

cartons.items. itemId · string

Item ID

Example:

"100023"

cartons.items. sku · string

SKU of item

Example:

"SKU0023"

cartons.items. channelId · string

Sales channel ID

Example:

"12"

cartons.items. segment · string

Segment associated with item

Example:

null

cartons.items. vendorId · string

Vendor ID

Example:

"56"

cartons.items. orderedQuantity · integer

Items ordered. Currently, there is no validation in place

Example:

2

cartons.items. shippedQuantity · integer

Items shipped

Example:

2

cartons.items. returnQuantity · integer

Items returned

Example:

1

cartons.items. returnAmount · number

Return amount

Example:

10

cartons.items. fees · object[]

Fee details for returned shipments

Show child attributes

cartons.items.fees. type · string

Component of shipment fee

Example:

"tax"

cartons.items.fees. value · number

Value corresponding to type

Example:

34.56

cartons.items.fees. quantity · integer

Shipment quantity

Example:

12

cartons.items.fees. refundAmount · number

Refund amount

Example:

10.4

cartons.items. giftCard · object[]

Gift card details

Show child attributes

cartons.items.giftCard. giftCardNum · string

Gift card number

Example:

"453456765"

cartons.items.giftCard. amount · number

Gift card amount

Example:

50

cartons.items.giftCard. giftCardStatus · string

Gift card status

Example:

"ACTIVE"

cartons.items.giftCard. giftCardActiveRequestDate · string

Time of placing gift card activation request

Example:

"2022-05-26T07:58:30.996Z"

cartons.items.giftCard. giftCardActiveDate · string

Time of gift card activation

Example:

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

cartons.items. attributes · object

Show child attributes

cartons.items.attributes. {key} · object

cartons.items. uom · string

Unit of measure

Example:

null

scratchedItems · object[]

details of scratched items

Shipment details of return items

Show child attributes

scratchedItems. orderId · string

Order ID (fabric-generated)

Example:

"507f1f77bcf86cd799439012"

scratchedItems. lineItemId · string

Line item ID to identify item in the order

Example:

"2"

scratchedItems. itemId · string

Item ID

Example:

"100043"

scratchedItems. sku · string

SKU number

Example:

"SKU00043"

scratchedItems. quantity · integer

Item quantity

Example:

1

scratchedItems. reasonCode · string

Reason code for return

scratchedItems. subReasonCode · string

sub-reason code for return

scratchedItems. attributes · object

Additional details of scratched item

Show child attributes

scratchedItems.attributes. {key} · object

scratchedItems. uom · string

Unit of measure

Example:

null

createdAt · string

Time of shipment creation

Example:

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

updatedAt · string

Time of last update

Example:

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

auditLogs · object[]

Details of audit logs

Audit details

Show child attributes

auditLogs. auditType · string

Audit type

Example:

"create"

auditLogs. employeeId · string

Employee ID (store context)

Example:

"62272e917b12209e68751d94"

auditLogs. auditTimestamp · string

Time of audit

Example:

"2022-05-12T09:24:54.804Z"

auditLogs. source · string

Source of audit

Example:

"POS"

auditLogs. note · string

Notes related audit, for future reference

Example:

"Note"

auditLogs. attributes · object

Show child attributes

auditLogs.attributes. {key} · object

auditLogs. updatedFields · object[]

Details of updated attributes

Show child attributes

auditLogs.updatedFields. attributeName · string

Attribute name

Example:

"UOM"

auditLogs.updatedFields. attributeOriginalValue · string

Original value of attribute, to track change in values for the given attributeName

Example:

"PK"

attributes · object

Attribute details for additional information

Show child attributes

attributes. {key} · object

Details of additional attributes, if applicable

Response

200

application/json

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:

["112345678912340", "112345678912340"]

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

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

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

Show child attributes

shipToAddress. addressLine1 · string

Line 1 of address

Example:

"888 Broadway"

shipToAddress. addressLine2 · string

Line 2 of address

Example:

"505 suite"

shipToAddress. addressLine3 · string

Line 3 of address

shipToAddress. addressLine4 · string

Line 3 of address

shipToAddress. city · string

City of delivery

Example:

"New York"

shipToAddress. state · string

State of delivery

Example:

"NY"

shipToAddress. country · string

Country name

Example:

"USA"

shipToAddress. postalCode · string

Postal code

Example:

"1003"

shipToAddress. type · string

Address type

Example:

"home"

shipToAddress. latitude · number

Geo-latitude of delivery address

Example:

134.13413

shipToAddress. longitude · number

Geo-longitude of delivery address

Example:

757.0435

recipient · object[]

Recipient details for shipment

Show child attributes

recipient. name · object

Primary contact details

Show child attributes

recipient.name. first · string

First name of primary contact

Example:

"John"

recipient.name. middle · string

Middle name of primary contact

recipient.name. last · string

Last name of primary contact

Example:

"Doe"

recipient. email · string

Email address of primary contact for delivery

Example:

"[e-mail]"

recipient. phone · object

Phone number of primary contact

Show child attributes

recipient.phone. number · string

Phone number of primary contact

Example:

10612345678

recipient.phone. type · string

Phone type of primary contact

Example:

"MOBILE"

cartons · object[]

Carton details

Show child attributes

cartons. cartonNum · string

Carton number to identify packages

Example:

"1"

cartons. cartonType · string

Cartoon type

Example:

"Package"

cartons. promisedDeliveryDate · string

Promised delivery date

Example:

"2022-05-26T07:58:30.996Z"

cartons. estimatedShipDate · string

Estimated shipping date

Example:

"2022-05-25T07:58:30.996Z"

cartons. estimatedDeliveryDate · string

Estimated delivery date

Example:

"2022-05-26T07:58:30.996Z"

cartons. shipmentMethod · string

Shipment method

Example:

"ground"

cartons. shipmentCarrier · string

Shipment carrier

Example:

"FEDEX"

cartons. weight · string

Shipment weight

Example:

"500 gram"

cartons. trackingNumber · string

Courier tracking number for the carton

Example:

"1Z999AA10123456784"

cartons. trackingURL · string

Shipment tracking URL

Example:

"https://fedex.com/tracking"

cartons. trackingDetails · object[]

Shipment tracking details

Details of shipment tracking generated once shipment is picked up from store

Show child attributes

cartons.trackingDetails. event · string

Event status

Example:

"picked up"

cartons.trackingDetails. eventId · string

24-character system-generated unique event ID

Example:

"627963716b19511e8a3a631b"

cartons.trackingDetails. timestamp · string

Time of event creation

Example:

"2019-09-30T07:58:30.996Z"

cartons.trackingDetails. shipmentCarrier · string

Shipment carrier name. Applicable in case of a different carrier

Example:

"FEDEX"

cartons.trackingDetails. location · string

Current location

Example:

"Reno, NV"

cartons.trackingDetails. notes · object

shipment notes

Show child attributes

cartons.trackingDetails.notes. {key} · string

Shipment notes, for reference

cartons. items · object[]

Item details

Item details of a shipment

Show child attributes

cartons.items. shipmentLineItemId · string

Line item ID of shipment

Example:

"607f1f77bcf86cd799439011"

cartons.items. orderId · string

Order ID (fabric-generated)

Example:

"317736896"

cartons.items. orderNumber · string

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

Example:

"507f1f77bcf86cd799439011"

cartons.items. lineItemId · string

Line item ID to identify item in the order

Example:

"1"

cartons.items. itemId · string

Item ID

Example:

"100023"

cartons.items. sku · string

SKU of item

Example:

"SKU0023"

cartons.items. channelId · string

Sales channel ID

Example:

"12"

cartons.items. segment · string

Segment associated with item

Example:

null

cartons.items. vendorId · string

Vendor ID

Example:

"56"

cartons.items. orderedQuantity · integer

Items ordered. Currently, there is no validation in place

Example:

2

cartons.items. shippedQuantity · integer

Items shipped

Example:

2

cartons.items. returnQuantity · integer

Items returned

Example:

1

cartons.items. returnAmount · number

Return amount

Example:

10

cartons.items. fees · object[]

Fee details for returned shipments

Show child attributes

cartons.items.fees. type · string

Component of shipment fee

Example:

"tax"

cartons.items.fees. value · number

Value corresponding to type

Example:

34.56

cartons.items.fees. quantity · integer

Shipment quantity

Example:

12

cartons.items.fees. refundAmount · number

Refund amount

Example:

10.4

cartons.items. giftCard · object[]

Gift card details

Show child attributes

cartons.items.giftCard. giftCardNum · string

Gift card number

Example:

"453456765"

cartons.items.giftCard. amount · number

Gift card amount

Example:

50

cartons.items.giftCard. giftCardStatus · string

Gift card status

Example:

"ACTIVE"

cartons.items.giftCard. giftCardActiveRequestDate · string

Time of placing gift card activation request

Example:

"2022-05-26T07:58:30.996Z"

cartons.items.giftCard. giftCardActiveDate · string

Time of gift card activation

Example:

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

cartons.items. attributes · object

Show child attributes

cartons.items.attributes. {key} · object

cartons.items. uom · string

Unit of measure

Example:

null

scratchedItems · object[]

details of scratched items

Shipment details of return items

Show child attributes

scratchedItems. orderId · string

Order ID (fabric-generated)

Example:

"507f1f77bcf86cd799439012"

scratchedItems. lineItemId · string

Line item ID to identify item in the order

Example:

"2"

scratchedItems. itemId · string

Item ID

Example:

"100043"

scratchedItems. sku · string

SKU number

Example:

"SKU00043"

scratchedItems. quantity · integer

Item quantity

Example:

1

scratchedItems. reasonCode · string

Reason code for return

scratchedItems. subReasonCode · string

sub-reason code for return

scratchedItems. attributes · object

Additional details of scratched item

Show child attributes

scratchedItems.attributes. {key} · object

scratchedItems. uom · string

Unit of measure

Example:

null

createdAt · string

Time of shipment creation

Example:

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

updatedAt · string

Time of last update

Example:

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

auditLogs · object[]

Details of audit logs

Audit details

Show child attributes

auditLogs. auditType · string

Audit type

Example:

"create"

auditLogs. employeeId · string

Employee ID (store context)

Example:

"62272e917b12209e68751d94"

auditLogs. auditTimestamp · string

Time of audit

Example:

"2022-05-12T09:24:54.804Z"

auditLogs. source · string

Source of audit

Example:

"POS"

auditLogs. note · string

Notes related audit, for future reference

Example:

"Note"

auditLogs. attributes · object

Show child attributes

auditLogs.attributes. {key} · object

auditLogs. updatedFields · object[]

Details of updated attributes

Show child attributes

auditLogs.updatedFields. attributeName · string

Attribute name

Example:

"UOM"

auditLogs.updatedFields. attributeOriginalValue · string

Original value of attribute, to track change in values for the given attributeName

Example:

"PK"

attributes · object

Attribute details for additional information

Show child attributes

attributes. {key} · object

Details of additional attributes, if applicable