For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Skip to content

Purchase Shipments

purchaseShipments

get PurchaseShipments

get

PURCHASE_SHIPMENT shipments, paged (PurchaseShipmentSummary), each with the quantity received against it (the sum of its ShipmentReceipt.quantityAccepted) and the quantity rejected on receipt. The purchase order is optional: a shipment without one comes back with null primaryOrderId, orderName and orderExternalId. The keyword matches the shipment id, external id, purchase order id and purchase order name, case-insensitively; the arrival dates filter estimatedArrivalDate, inclusive of the whole thru day. primaryOrderId and shipmentId narrow to one purchase order's or one shipment's. productStoreId keeps the shipments bound for the store's facilities (its current ProductStoreFacility rows); a store with none matches nothing.

Authorizations
AuthorizationstringRequired
Query parameters
keywordstringOptional
productStoreIdstringOptional
statusIdstringOptional

Comma-separated shipment statusIds.

destinationFacilityIdstringOptional
arrivalDateFromstringOptional
arrivalDateThrustringOptional
primaryOrderIdstringOptional
shipmentIdstringOptional
orderBystringOptional
pageIndexinteger · int32Optional
pageSizeinteger · int32Optional
Responses
200

Success

application/json
shipmentsarrayOptional
shipmentsCountinteger · int64Optional
get/purchaseShipments
GET /rest/s1/poorti/purchaseShipments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
  "shipments": [],
  "shipmentsCount": 1
}

create PurchaseShipment

post

Creates an inbound PURCHASE_SHIPMENT for open lines of one approved purchase order (POST purchaseShipments, hotwax/preorder-maarg#84): per line, a quantity up to what is still unshipped, and the arrival date. The shipment goes to the purchase order's destination and each item is linked to its line by oms create#IncomingShipment (OrderShipment), and a line with an ACTIVE future inventory batch carves a shipment batch out of it for the shipped quantity, with the arrival date as its promise date (oms store#PurchaseShipmentFutureInventory; waiting reservations stay on the purchase order line's batch). externalId is the retry key within the order: its PURCHASE_SHIPMENT with the same externalId, lines and arrival date is returned; with other lines, quantities or date it is refused. Another order's shipment or another kind of shipment with the same externalId is not a retry, and a new shipment is created. The arrival date of a retry is matched whatever the retrying caller's time zone. The order row is locked, so two creates for one order run one after the other.

Authorizations
AuthorizationstringRequired
Body
orderIdstringRequired
externalIdstringRequired
arrivalDatestringRequired

yyyy-MM-dd in the user's time zone: the end of that day. A retry names the same day, from any time zone.

Responses
200

Success

application/json
shipmentIdstringOptional
futureInventoryItemIdsarrayOptional
post/purchaseShipments
POST /rest/s1/poorti/purchaseShipments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "orderId": "text",
  "externalId": "text",
  "arrivalDate": "text",
  "items": [
    {
      "orderItemSeqId": "text",
      "quantity": 1
    }
  ]
}
{
  "shipmentId": "text",
  "futureInventoryItemIds": []
}

get PurchaseShipment

get

One PURCHASE_SHIPMENT: its get#PurchaseShipments row, its items with the quantity accepted and rejected against each, and its receipts.

Authorizations
AuthorizationstringRequired
Path parameters
shipmentIdstringRequired
Responses
200

Success

application/json
shipmentobjectOptional
get/purchaseShipments/{shipmentId}
GET /rest/s1/poorti/purchaseShipments/{shipmentId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
  "shipment": {}
}

receive PurchaseShipmentItems

post

Receives an inbound PURCHASE_SHIPMENT (POST purchaseShipments/{shipmentId}/receive, hotwax/preorder-maarg#84), in part or in full, through poorti receive#ProductInventory, which writes the ShipmentReceipt and the stock: the receipt issues the shipment item's future inventory batch (QOO and ATP fall equally) in this transaction through oms issue#ReceiptFutureInventory. Reservations waiting on that batch are not moved to the received stock. items names the shipment items and the quantity accepted and rejected of each; with no items, everything still unreceived is accepted (the final receipt). A quantity over what an item has left, or an accepted quantity over the purchase order line's open quantity (summed over the shipment items of that line), is refused, and nothing is received. The shipment becomes PURCH_SHIP_RECEIVED once every item is fully received; a shipment already received receives nothing and returns, so a repeated final receipt changes nothing. The shipment row is locked, so two receipts of one shipment run one after the other.

Authorizations
AuthorizationstringRequired
Path parameters
shipmentIdstringRequired
Body
shipmentIdstringRequired
Responses
200

Success

application/json
receiptIdsarrayOptional
fullyReceivedbooleanOptional
post/purchaseShipments/{shipmentId}/receive
POST /rest/s1/poorti/purchaseShipments/{shipmentId}/receive HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "shipmentId": "text",
  "items": [
    {
      "shipmentItemSeqId": "text",
      "quantityAccepted": 1,
      "quantityRejected": 1
    }
  ]
}
{
  "receiptIds": [],
  "fullyReceived": true
}

Last updated

Was this helpful?