TransferOrders
transferOrders
Service to get all Transfer Orders. By default, the service will return orders with status ORDER_APPROVED. This supports filtering on the basis of parameters orderId, orderStatusId, itemStatusId, originFacilityId, destinationFacilityId and orderName.
The ID of the Transfer Order in OMS.
The ID of the status of the Transfer Order in OMS.
The ID of the status of the Transfer Order Item in OMS.
The ID of the source facility of the Transfer Order in OMS.
The ID of the destination facility of the Transfer Order in OMS.
The order name of Transfer Order.
Page number to return, starting with zero.
Number of records per page (default 20).
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
GET /rest/s1/oms/transferOrders/ HTTP/1.1
Host: demo-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"orders": [],
"ordersCount": 1
}Create a Transfer Order
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/oms/transferOrders/ HTTP/1.1
Host: demo-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"payload": {}
}{
"orderId": "text"
}Service to get Transfer Order Details.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
GET /rest/s1/oms/transferOrders/{orderId} HTTP/1.1
Host: demo-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"order": {
"orderId": "text",
"status": "text",
"orderName": "text",
"externalId": "text",
"statusId": "text",
"maySplit": "text",
"currencyUom": "text",
"facilityId": "text",
"orderFacilityId": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"grandTotal": "text",
"items": [
{
"orderItemSeqId": "text",
"shipGroupSeqId": "text",
"quantity": "text",
"statusId": "text",
"status": "text",
"itemDescription": "text",
"cancelQuantity": "text",
"productId": "text",
"maySplit": "text",
"totalIssuedQuantity": "text",
"totalReceivedQuantity": "text",
"unitPrice": "text"
}
]
}
}Service to approve transfer orders where fulfillment is done by OMS i.e. Store to Store and Store to Warehouse Transfer Orders. The Order will be updated to ORDER_APPROVED status. The Items will be updated to the next eligible Item Status based on the statusFlowId associated with the Transfer Order i.e. ITEM_PENDING_FULFILL.
The ID of the Transfer Order in OMS.
Authentication required
No content
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/oms/transferOrders/{orderId}/approve HTTP/1.1
Host: demo-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
No content
Service to bulk approve transfer orders where fulfillment is done by third party i.e. Warehouse to Store Transfer Orders. The Order will be updated to ORDER_APPROVED status. The Items will be updated to the next eligible Item Status based on the statusFlowId associated with the Transfer Order i.e. ITEM_PENDING_RECEIPT.
The ID of the Transfer Order in OMS.
Authentication required
No content
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/oms/transferOrders/{orderId}/approveWhFulfill HTTP/1.1
Host: demo-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
No content
1Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/oms/transferOrders/orderItem HTTP/1.1
Host: demo-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"orderId": "text",
"productId": "text",
"quantity": "1",
"shipGroupSeqId": "text",
"unitPrice": 1
}{
"orderId": "text",
"orderItemSeqId": "text"
}Service to update the Transfer Order Item Quantity.
Authentication required
No content
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
PUT /rest/s1/oms/transferOrders/orderItem HTTP/1.1
Host: demo-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 55
{
"orderId": "text",
"orderItemSeqId": "text",
"quantity": 1
}No content
Was this helpful?