POST
/
allocation
/
query
curl --request POST \
  --url https://prod01.oms.fabric.inc/api/v2/allocation/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "limit": 10,
  "offset": 0,
  "sortBy": "updatedAt",
  "sortDirection": "desc",
  "filters": {
    "retail": {
      "locationNum": 12
    },
    "orderSubTotal": {
      "gte": 1300,
      "lt": 1400
    },
    "orderNumber": "order-*Z",
    "statusCode": [
      "ORDER_CREATED"
    ],
    "createdAt": {
      "lt": "2022-09-11T23:12:00.123Z"
    },
    "shipInfo": {
      "shipToId": [
        "23434",
        "23436"
      ]
    }
  }
}'
[
  {
    "allocationId": "62ff5c0bec0aed3c86202c32",
    "version": 2,
    "allocationRequestId": "62ff5c0bec0aed3c86202c32",
    "allocationNum": "xxyyzz12345",
    "parentAllocationId": "62ff5c0bec0aed3c86202c32",
    "sentToPPSDate": "2022-08-01T18:03:28.483971941Z",
    "allocationDate": "2022-08-01T18:03:28.483971941Z",
    "updatedAt": "2022-08-01T20:03:28.483971941Z",
    "type": "ALLOCATED",
    "previousAllocationLocationNum": 410,
    "poNumber": "1125",
    "itemsType": "WEB_SHIP",
    "orderSubType": "BORDERFREE",
    "vendorId": "56",
    "shipDate": null,
    "shipType": "SHIP_TO_ADDRESS",
    "shipMethod": "Overnight Delivery",
    "shipToId": "98ff5c0bec0aed3c86202c32",
    "statusCode": "PENDING_PICK",
    "locationNum": "1234B",
    "locationType": "1234B",
    "shipToAddress": {},
    "recipient": [
      {
        "name": {
          "first": "John",
          "middle": "Middle",
          "last": "Doe"
        },
        "email": "demo@xyz.inc",
        "phone": {
          "number": "55555555555",
          "type": "MOBILE"
        },
        "pickupType": "Primary"
      }
    ],
    "items": [
      {
        "orderLineId": "134fqfaa532qrf",
        "itemId": "100064",
        "sku": "123k4h123k",
        "orderId": "123k4h123k",
        "orderDate": "2022-08-01T18:03:28.483971941Z",
        "estimatedDeliveryDate": "2022-08-01T18:03:28.483971941Z",
        "quantity": 3,
        "allocationLineNumber": 3,
        "parentAllocationLineNumber": 3,
        "reallocationRequestId": "123k4h123k",
        "shippedQuantity": 1,
        "scratchQuantity": 1,
        "scratchedReasonCode": "Scratched during shipment",
        "reshipReasonCode": "Reshipping during shipment",
        "reallocationReasonCode": "Reallocating due to unavailability of location number",
        "channelId": "12",
        "segment": null,
        "vendorId": "56",
        "title": "Demo",
        "weight": 5.5,
        "cost": 500.2,
        "price": 50.2,
        "itemStatus": "ALLOCATED",
        "attributes": {},
        "uom": "KG"
      }
    ],
    "auditLogs": [
      {
        "lineItemId": "4",
        "auditId": "62272e917b12209e68751d94",
        "auditType": "UPDATE",
        "employeeId": "62272e917b12209e68751d94",
        "auditTimestamp": "2022-05-12T09:24:54.804Z",
        "source": "POS",
        "reasonCode": "POS",
        "subReasonCode": "POS",
        "policyCode": "POS",
        "note": "Note",
        "lineItemNumber": 1,
        "sku": "F5F",
        "quantity": 1,
        "amount": 2.4,
        "paymentToken": {
          "token": "pi_34tr6787rt",
          "paymentType": "VISA"
        },
        "success": true,
        "paymentResponse": {},
        "updatedFields": [
          {
            "fieldName": "UOM",
            "fieldOriginalValue": "PK"
          }
        ],
        "attributes": {}
      }
    ]
  }
]

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\"}"

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.

Example:
{
  "retail": { "locationNum": 12 },
  "orderSubTotal": { "gte": 1300, "lt": 1400 },
  "orderNumber": "order-*Z",
  "statusCode": ["ORDER_CREATED"],
  "createdAt": { "lt": "2022-09-11T23:12:00.123Z" },
  "shipInfo": { "shipToId": ["23434", "23436"] }
}
​
limit
integer
default:10

Numbers of records to be returned

Example:

10

​
offset
integer
default:0

Number of records to skipped

Example:

0

​
sortBy
string
default:updatedAt

Sorting criteria based on attributes

Example:

"updatedAt"

​
sortDirection
enum<string>
default:desc

Sorting direction such as ascending or descending

Available options:
asc,
desc
Example:

"desc"

Response

200
application/json
Matched Allocations
​
allocationId
string
required

Unique ID for an allocation document

Example:

"62ff5c0bec0aed3c86202c32"

​
parentAllocationId
string
required

Same as previous allocation document while creating new allocation

Example:

"62ff5c0bec0aed3c86202c32"

​
locationNum
string
required

Tenant's ship-from location ID

Example:

"1234B"

​
items
object[]
required

List of items to be shipped

Details of allocation items

​
version
integer

Current version of allocation document

Example:

2

​
allocationRequestId
string

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

Example:

"62ff5c0bec0aed3c86202c32"

​
allocationNum
string

Allocation number for client tracking

Example:

"xxyyzz12345"

​
sentToPPSDate
string

Time of sending allocation event to PPS

Example:

"2022-08-01T18:03:28.483971941Z"

​
allocationDate
string

Time of allocation creation and when it was stored in database

Example:

"2022-08-01T18:03:28.483971941Z"

​
updatedAt
string

Time of allocation update

Example:

"2022-08-01T20:03:28.483971941Z"

​
type
enum<string>

Allocation type

Available options:
ALLOCATED,
SCRATCHED,
RETURNED
Example:

"ALLOCATED"

​
previousAllocationLocationNum
number

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

Example:

410

​
poNumber
string | null

Purchase order number (generally, vendor-generated)

Example:

"1125"

​
itemsType
enum<string>

Items type

Available options:
WEB_SHIP,
POS,
WEB
Example:

"WEB_SHIP"

​
orderSubType
enum<string>

Sub-type of order

Available options:
IOS,
Android,
International,
Borderfree
Example:

"BORDERFREE"

​
vendorId
string | null

Vendor ID

Example:

"56"

​
shipDate
string

Estimated ship date

Example:

null

​
shipType
string

Optional field for shipment type

Example:

"SHIP_TO_ADDRESS"

​
shipMethod
string

Optional field for shipment method

Example:

"Overnight Delivery"

​
shipToId
string

Unique Id for delivery address

Example:

"98ff5c0bec0aed3c86202c32"

​
statusCode
enum<string>

Allocation status code

Available options:
ALLOCATED,
PENDING_DROP,
PENDING_PICK,
SHIPPED,
PARTIALLY_SHIPPED,
REALLOCATED,
CANCELLED,
PARTIALLY_CANCELLED
Example:

"PENDING_PICK"

​
locationType
string

Tenant's ship-from location type

Example:

"1234B"

​
shipToAddress
object
​
recipient
object[]

Recipient details such as phone number, email, and name

Order pickup details

​
auditLogs
object[]

Logs with updated fields

Details of order audit log

Was this page helpful?