Update allocation
Updates allocation for the given order or item. Primary use cases are to update location number (related to warehouse), allocation number (external use), item details, etc. To specifically update Location Number, the PUT /allocation/reallocate endpoint is recommended
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.
Path Parameters
Body
Allocation details
Unique ID for an allocation document
List of items to be shipped
Tenant's ship-from location ID
Same as previous allocation document while creating new allocation
Time of allocation creation and when it was stored in database
Allocation number for client tracking
Allocation request ID used for tracking internal communication. Required to update allocation details.
Logs with updated fields
Items type
WEB_SHIP, POS, WEB Tenant's ship-from location type
Sub-type of order
IOS, Android, International, Borderfree Purchase order number (generally, vendor-generated)
In reallocation scenarios, keeps track of the previously allocation location numbers
Recipient details such as phone number, email, and name
Time of sending allocation event to PPS
Estimated ship date
Optional field for shipment method
Unique Id for delivery address
Optional field for shipment type
Allocation status code
ALLOCATED, PENDING_DROP, PENDING_PICK, SHIPPED, PARTIALLY_SHIPPED, REALLOCATED, CANCELLED, PARTIALLY_CANCELLED Allocation type
ALLOCATED, SCRATCHED, RETURNED Time of allocation update
Vendor ID
Current version of allocation document
Response
Allocation details
Unique ID for an allocation document
List of items to be shipped
Tenant's ship-from location ID
Same as previous allocation document while creating new allocation
Time of allocation creation and when it was stored in database
Allocation number for client tracking
Allocation request ID used for tracking internal communication. Required to update allocation details.
Logs with updated fields
Items type
WEB_SHIP, POS, WEB Tenant's ship-from location type
Sub-type of order
IOS, Android, International, Borderfree Purchase order number (generally, vendor-generated)
In reallocation scenarios, keeps track of the previously allocation location numbers
Recipient details such as phone number, email, and name
Time of sending allocation event to PPS
Estimated ship date
Optional field for shipment method
Unique Id for delivery address
Optional field for shipment type
Allocation status code
ALLOCATED, PENDING_DROP, PENDING_PICK, SHIPPED, PARTIALLY_SHIPPED, REALLOCATED, CANCELLED, PARTIALLY_CANCELLED Allocation type
ALLOCATED, SCRATCHED, RETURNED Time of allocation update
Vendor ID
Current version of allocation document
Was this page helpful?