TransferOrders

transferOrders

print TransferOrderPicklist

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderIdstringRequired

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/transferOrders/{orderId}/printPicklist

HTTPcURLJavaScriptPython

GET /rest/s1/poorti/transferOrders/{orderId}/printPicklist HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

No content

list TransferOrderItemReceipt

get

View to get ShipmentReceipt records for Transfer Order Items. This view is being used in the Receiving App to show the history of receipts for an item per datetimeReceived.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderIdstringRequired

Query parameters

pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

orderItemSeqIdstringOptional

datetimeReceivedstring · date-timeOptional

quantityAcceptednumberOptional

quantityRejectednumberOptional

receivedByUserLoginIdstringOptional

productStoreIdstringOptional

productIdstringOptional

quantitynumberOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/transferOrders/{orderId}/receipts

HTTPcURLJavaScriptPython

GET /rest/s1/poorti/transferOrders/{orderId}/receipts HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "co.hotwax.shipment.TransferOrderItemReceipt",
    "orderId": "text",
    "orderItemSeqId": "text",
    "datetimeReceived": "2026-01-30T19:21:08.943Z",
    "quantityAccepted": 1,
    "quantityRejected": 1,
    "receivedByUserLoginId": "text",
    "productStoreId": "text",
    "productId": "text",
    "quantity": 1
  }
]

receive TransferOrder

post

Service to receive Transfer Order Items.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderIdstringRequired

The ID of the Transfer Order in OMS.

Body

application/jsonmultipart/form-data

orderIdstringRequired

The ID of the Transfer Order in OMS.

facilityIdstringRequired

The ID of the facility in OMS where Transfer Order is being received.

receivedDateTimestring · date-timeOptional

The date time at which the Transfer Order is being received in OMS.

Default: {ec.user.nowTimestamp}

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/transferOrders/{orderId}/receipts

HTTPcURLJavaScriptPython

POST /rest/s1/poorti/transferOrders/{orderId}/receipts HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 219

{
  "orderId": "text",
  "facilityId": "text",
  "receivedDateTime": "{ec.user.nowTimestamp}",
  "items": [
    {
      "orderItemSeqId": "text",
      "productId": "text",
      "quantityAccepted": 1,
      "quantityRejected": 1,
      "reasonEnumId": "text",
      "statusId": "text"
    }
  ]
}

application/jsonmultipart/form-data

No content

reject TransferOrder

post

Service to reject the Transfer Order. The Transfer Order will be moved to REJECTED_ITM_PARKING facility and the reservations will be cancelled. The Inventory Variance will be logged as per handling in reject#OrderItem oms service.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderIdstringRequired

Body

application/jsonmultipart/form-data

orderIdstringRequired

rejectToFacilityIdstringOptional

The ID of the rejected facility of the Transfer Order in OMS.

Default: REJECTED_ITM_PARKING

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/transferOrders/{orderId}/reject

HTTPcURLJavaScriptPython

POST /rest/s1/poorti/transferOrders/{orderId}/reject HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "orderId": "text",
  "rejectToFacilityId": "REJECTED_ITM_PARKING",
  "items": [
    {
      "orderItemSeqId": "text",
      "rejectionReasonId": "text"
    }
  ]
}

application/jsonmultipart/form-data

No content

close TransferOrderItemFulfillment

post

Service to close Transfer Order Item Fulfillment. This will set the OrderItem.cancelQuantity for the remaining quantity to be fulfilled if any, cancel the remaining reservations and set the item status to the next eligible Item Status based on the statusFlowId associated with the Transfer Order i.e. either ITEM_COMPLETED or ITEM_PENDING_RECEIPT for TO_Fulfill_Only and TO_Fulfill_And_Receive orders respectively. If the item is not yet shipped i.e. 0 quantity fulfilled, the item will be Cancelled in that scenario. The Order Status will be updated according to the item status change.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderIdstringRequired

The ID of the Transfer Order in OMS.

Body

application/jsonmultipart/form-data

orderIdstringRequired

The ID of the Transfer Order in OMS.

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/transferOrders/{orderId}/closeFulfillment

HTTPcURLJavaScriptPython

POST /rest/s1/poorti/transferOrders/{orderId}/closeFulfillment HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "orderId": "text",
  "items": [
    {
      "orderItemSeqId": "text"
    }
  ]
}

application/jsonmultipart/form-data

No content