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

Gets allocation details by allocation ID

Request
path Parameters
allocationId
required
string

24-character system-generated allocation ID

Example: 633f216c68f1b4456659161c
header Parameters
required
object

x-site-context value

Responses
200

Allocation Details

400

AllocationId not found/valid

500

Internal Server Error

get/allocation/{allocationId}
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": [
    ],
  • "items": [
    ],
  • "auditLogs": [
    ]
}