TransferShipments
transferShipments
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.
The ID of the Transfer Order in OMS.
The ID of the Shipment for Transfer Order in OMS.
The ID of the Shipment Status in OMS for Transfer Order.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
GET /rest/s1/poorti/transferShipments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"shipments": [
{
"orderId": "text",
"orderDate": "2025-08-08T09:10:54.384Z",
"orderTypeId": "text",
"webSiteId": "text",
"externalId": "text",
"orderName": "text",
"statusId": "text",
"originFacilityId": "text",
"shipGroupSeqId": "text",
"orderFacilityId": "text",
"facilityId": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"shipmentId": "text",
"shipmentTypeId": "text",
"shipmentStatusId": "text",
"shipmentCreatedDate": "2025-08-08T09:10:54.384Z",
"shipmentShippedDate": "2025-08-08T09:10:54.384Z",
"trackingIdNumber": "text",
"shipmentRouteSegmentId": "text",
"routeSegShipmentMethodDescription": "text",
"statusDate": "2025-08-08T09:10:54.384Z",
"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"
}
]
}
]
}
]
}Creates Shipment of type OUT_TRANSFER for the Transfer Order Items to be fulfilled.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
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
}
]
}
]
}
}{
"shipmentId": "text"
}Ship a Transfer Order Shipment. The service will update the trackingIdNumber, create Item Issuance, Inventory Item Detail and update the Shipment as SHIPMENT_SHIPPED.
The ID of the Transfer Order Shipment in OMS.
The ID of the Transfer Order Shipment in OMS.
The tracking number for the Shipment.
The ID of the Shipment Route Segment in OMS.
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
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: 79
{
"shipmentId": "text",
"trackingIdNumber": "text",
"shipmentRouteSegmentId": "text"
}No content
The ID of the Transfer Order in OMS.
The ID of the origin 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.
The ID of the Shipment Status in OMS. By default it returns Shipment in SHIPMENT_SHIPPED status.
The shipment shipped date 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/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
}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.
The ID of the Transfer Order in OMS.
The ID of the Transfer Order in OMS.
The ID of the Shipment for Transfer Order in OMS.
The ID of the origin facility of the Transfer Order Shipment in OMS.
The ID of the destination facility of the Transfer Order Shipment in OMS.
The ID of the Shipment Status in OMS for Transfer Order. By default it returns Shipment Packages for Shipments in SHIPMENT_SHIPPED status.
The tracking number of the Shipment Package for Transfer Order.
The created date of Shipment Package for 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/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"
}
]
}Was this helpful?