Update allocation

We have a brand new Developer Portal!

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

Update allocation

Updates allocation for the given order or item. Primary use cases are to update location number (related to warehouse), allocation number (external use), item details, etc. To specifically update Location Number, the PUT /allocation/reallocate endpoint is recommended

Request

path Parameters

allocationId

required

string

header Parameters

required

object

x-site-context value

Request Body schema: application/json

allocationId required	string Unique ID for an allocation document
version	integer <int64> 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 required	string Same as previous allocation document while creating new allocation
sentToPPSDate	string <date-time> Time of sending allocation event to PPS
allocationDate	string <date-time> Time of allocation creation and when it was stored in database
updatedAt	string <date-time> Time of allocation update
type	string Allocation type Enum: "ALLOCATED" "SCRATCHED" "RETURNED"
previousAllocationLocationNum	number In reallocation scenarios, keeps track of the previously allocation location numbers
poNumber	string or null Purchase order number (generally, vendor-generated)
itemsType	string Items type Enum: "WEB_SHIP" "POS" "WEB"
orderSubType	string Sub-type of order Enum: "IOS" "Android" "International" "Borderfree"
vendorId	string or null Vendor ID
shipDate	string <date-time> Estimated ship date
shipType	string <date-time> Optional field for shipment type
shipMethod	string <date-time> Optional field for shipment method
shipToId	string Unique Id for delivery address
statusCode	string Allocation status code Enum: "ALLOCATED" "PENDING_DROP" "PENDING_PICK" "SHIPPED" "PARTIALLY_SHIPPED" "REALLOCATED" "CANCELLED" "PARTIALLY_CANCELLED"
locationNum required	string Tenant's ship-from location ID
locationType	string Tenant's ship-from location type
shipToAddress	object
	Array of objects Recipient details such as phone number, email, and name
required	Array of objects List of items to be shipped
	Array of objects Logs with updated fields

Responses

200

Allocation Updated

400

Order/item/Details Not Found/Valid

500

Internal Server Error

put/allocation/{allocationId}

Request samples

Payload

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

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