POST
/
allocation
/
query

Authorizations

Authorization
string
headerrequired

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.

Body

application/json

Filter criteria

filters
object
required

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

limit
integer
default: 10

Numbers of records to be returned

offset
integer
default: 0

Number of records to skipped

sortBy
string
default: updatedAt

Sorting criteria based on attributes

sortDirection
enum<string>
default: desc

Sorting direction such as ascending or descending

Available options:
asc,
desc

Response

200 - application/json
allocationId
string
required

Unique ID for an allocation document

version
integer

Current version of allocation document

allocationRequestId
string

Allocation request ID used for tracking internal communication. Required to update allocation details.

allocationNum
string

Allocation number for client tracking

parentAllocationId
string
required

Same as previous allocation document while creating new allocation

sentToPPSDate
string

Time of sending allocation event to PPS

allocationDate
string

Time of allocation creation and when it was stored in database

updatedAt
string

Time of allocation update

type
enum<string>

Allocation type

Available options:
ALLOCATED,
SCRATCHED,
RETURNED
previousAllocationLocationNum
number

In reallocation scenarios, keeps track of the previously allocation location numbers

poNumber
string | null

Purchase order number (generally, vendor-generated)

itemsType
enum<string>

Items type

Available options:
WEB_SHIP,
POS,
WEB
orderSubType
enum<string>

Sub-type of order

Available options:
IOS,
Android,
International,
Borderfree
vendorId
string | null

Vendor ID

shipDate
string

Estimated ship date

shipType
string

Optional field for shipment type

shipMethod
string

Optional field for shipment method

shipToId
string

Unique Id for delivery address

statusCode
enum<string>

Allocation status code

Available options:
ALLOCATED,
PENDING_DROP,
PENDING_PICK,
SHIPPED,
PARTIALLY_SHIPPED,
REALLOCATED,
CANCELLED,
PARTIALLY_CANCELLED
locationNum
string
required

Tenant's ship-from location ID

locationType
string

Tenant's ship-from location type

shipToAddress
object
recipient
object[]

Recipient details such as phone number, email, and name

items
object[]
required

List of items to be shipped

auditLogs
object[]

Logs with updated fields

Was this page helpful?

Update allocationReallocate location