Get allocation by query

We have a brand new Developer Portal!

This page will be expiring soon; be sure to bookmark the new link.

Take me there

Get allocation by query

Finds allocation details based on filter criteria

Request

header Parameters

required

object

x-site-context value

Request Body schema: application/json

limit	integer <int32> Default: 10 Numbers of records to be returned
offset	integer <int64> Default: 0 Number of records to skipped
sortBy	string Default: "updatedAt" Sorting criteria based on attributes
sortDirection	string Default: "desc" Sorting direction such as ascending or descending Enum: "asc" "desc"
required	object Default: {} Filter criteria. Note: To filter records, the json structure should be similar to target entity structure. That is, order, shipment, etc.

Responses

200

Matched Allocations

404

Data Not Found/Valid

500

Internal Server Error

post/allocation/query

Request samples

Payload

application/json

{"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"
]
}
}
}

Response samples

application/json

[{"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": {"property1": { },
"property2": { }
},
"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": {"property1": { },
"property2": { }
}
}
]
}
]