Get allocation by query

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

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.

Filter criteria. <br /> Note: To filter records, the json structure should be similar to target entity structure. That is, order, shipment, etc.

Numbers of records to be returned

Number of records to skipped

Sorting criteria based on attributes

Sorting direction such as ascending or descending

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

Tenant's ship-from location type

Sub-type of order

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

Allocation type

Time of allocation update

Vendor ID

Current version of allocation document