TransferShipments

transferShipments

get TransferOrderShipments

get

Service to get Transfer Order Shipments and its details. This is being used to fetch all details for the Completed tab of transfer-order-details page and transfer-shipment-review page in Fulfillment app.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Query parameters

orderIdstringOptional

The ID of the Transfer Order in OMS.

shipmentIdstringOptional

The ID of the Shipment for Transfer Order in OMS.

shipmentStatusIdstringOptional

The ID of the Shipment Status in OMS for Transfer Order.

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/transferShipments

HTTPcURLJavaScriptPython

GET /rest/s1/poorti/transferShipments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "shipments": [
    {
      "orderId": "text",
      "orderDate": "2026-01-30T19:29:12.748Z",
      "orderTypeId": "text",
      "webSiteId": "text",
      "externalId": "text",
      "orderName": "text",
      "statusId": "text",
      "originFacilityId": "text",
      "currencyUom": "text",
      "shipGroupSeqId": "text",
      "orderFacilityId": "text",
      "facilityId": "text",
      "carrierPartyId": "text",
      "shipmentMethodTypeId": "text",
      "shipmentId": "text",
      "shipmentTypeId": "text",
      "shipmentStatusId": "text",
      "shipmentCreatedDate": "2026-01-30T19:29:12.748Z",
      "shipmentShippedDate": "2026-01-30T19:29:12.748Z",
      "shippingEstimateAmount": 1,
      "trackingIdNumber": "text",
      "shipmentRouteSegmentId": "text",
      "routeSegShipmentMethodDescription": "text",
      "statusDate": "2026-01-30T19:29:12.748Z",
      "packages": [
        {
          "shipmentPackageSeqId": "text",
          "trackingCode": "text",
          "labelImageUrl": "text",
          "items": [
            {
              "orderItemSeqId": "text",
              "productId": "text",
              "unitPrice": "text",
              "quantity": "text",
              "orderId": "text",
              "orderItemStatusId": "text",
              "orderedQuantity": "text",
              "shipmentItemSeqId": "text",
              "totalIssuedQuantity": "text",
              "shipmentPackageSeqId": "text",
              "shipmentStatusId": "text"
            }
          ]
        }
      ]
    }
  ]
}

create TransferOrderShipment

post

Creates Shipment of type OUT_TRANSFER for the Transfer Order Items to be fulfilled.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/transferShipments

HTTPcURLJavaScriptPython

POST /rest/s1/poorti/transferShipments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 214

{
  "payload": {
    "orderId": "text",
    "externalId": "text",
    "shipmentStatusId": "SHIPMENT_PACKED",
    "packages": [
      {
        "trackingNumber": "text",
        "items": [
          {
            "orderItemSeqId": "text",
            "externalId": "text",
            "productId": "text",
            "quantity": 1
          }
        ]
      }
    ]
  }
}

application/jsonmultipart/form-data

{
  "shipmentId": "text"
}

ship TransferOrderShipment

post

Ship a Transfer Order Shipment. The service will update the trackingIdNumber, create Item Issuance, Inventory Item Detail and update the Shipment as SHIPMENT_SHIPPED.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

shipmentIdstringRequired

The ID of the Transfer Order Shipment in OMS.

Body

application/jsonmultipart/form-data

shipmentIdstringRequired

The ID of the Transfer Order Shipment in OMS.

trackingIdNumberstringOptional

The tracking number for the Shipment.

shipmentRouteSegmentIdstringRequired

The ID of the Shipment Route Segment in OMS.

carrierPartyIdstringOptional

The ID of carrier party in OMS.

shipmentMethodTypeIdstringOptional

The Shipment Method Type in OMS.

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/transferShipments/{shipmentId}/ship

HTTPcURLJavaScriptPython

POST /rest/s1/poorti/transferShipments/{shipmentId}/ship HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "shipmentId": "text",
  "trackingIdNumber": "text",
  "shipmentRouteSegmentId": "text",
  "carrierPartyId": "text",
  "shipmentMethodTypeId": "text"
}

application/jsonmultipart/form-data

No content

get TransferShipmentOrders

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Query parameters

orderIdstringOptional

The ID of the Transfer Order in OMS.

originFacilityIdstringOptional

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

destinationFacilityIdstringOptional

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

orderNamestringOptional

The order name of Transfer Order.

shipmentStatusIdstringOptional

The ID of the Shipment Status in OMS. By default it returns Shipment in SHIPMENT_SHIPPED status.

fromShipmentShippedDatestringOptional

The shipment shipped date of Transfer Order.

pageIndexinteger · int32Optional

Page number to return, starting with zero.

limitinteger · int32Optional

Number of records per page (default 20).

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/transferShipments/orders

HTTPcURLJavaScriptPython

GET /rest/s1/poorti/transferShipments/orders HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "orders": [
    {
      "orderId": "text",
      "externalId": "text",
      "orderName": "text",
      "shipmentShippedDate": "text",
      "statusId": "text"
    }
  ],
  "ordersCount": 1
}

get TransferOrderShipmentPackage

get

Service to get Transfer Order Shipment Packages. This is being used to fetch the package level details for the Shipped TOs be able to search by tracking number and order name in the Receiving app.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Query parameters

orderIdstringOptional

The ID of the Transfer Order in OMS.

orderNamestringOptional

The ID of the Transfer Order in OMS.

shipmentIdstringOptional

The ID of the Shipment for Transfer Order in OMS.

originFacilityIdstringOptional

The ID of the origin facility of the Transfer Order Shipment in OMS.

destinationFacilityIdstringOptional

The ID of the destination facility of the Transfer Order Shipment in OMS.

shipmentStatusIdstringOptional

The ID of the Shipment Status in OMS for Transfer Order. By default it returns Shipment Packages for Shipments in SHIPMENT_SHIPPED status.

trackingNumberstringOptional

The tracking number of the Shipment Package for Transfer Order.

fromShipmentPackageCreatedDatestringOptional

The created date of Shipment Package for Transfer Order.

pageIndexinteger · int32Optional

Page number to return, starting with zero.

limitinteger · int32Optional

Number of records per page (default 20).

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/transferShipments/packages

HTTPcURLJavaScriptPython

GET /rest/s1/poorti/transferShipments/packages HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "shipmentPackagesCount": 1,
  "shipmentPackages": [
    {
      "orderId": "text",
      "orderName": "text",
      "orderExternalId": "text",
      "shipmentId": "text",
      "shipmentPackageSeqId": "text",
      "shipmentPackageCreatedDate": "text",
      "trackingCode": "text"
    }
  ]
}