Skip to main content

Create Receipt

POST 
/api/inbound-shipments/:inbound_shipment/receipts

Creates a native InboundShipmentReceipt with lines and posts FIFO/inventory directly via the new IS-first path (Phase 1 of the InboundShipment / PurchaseOrderShipment unification). Coexists with the legacy /receive endpoint, which delegates through the PO shipment receipt path.

Required scope: purchase-orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Fields:

  • received_at (required, datetime): Date/time of receipt
  • warehouse_id (required, exists:warehouses): Receiving warehouse for this receipt
  • notes (optional, string): Free-text notes attached to the receipt
  • receipt_lines (required, min 1):
    • inbound_shipment_line_id (required, exists:inbound_shipment_lines): Must belong to this inbound shipment
    • quantity (required, numeric, min 0.0001)

Side effects:

  • Creates an inbound_shipment_receipts row + per-line inbound_shipment_receipt_lines rows
  • Creates a FIFO layer + InventoryMovement per line (TYPE_PURCHASE_RECEIPT) at the receipt's warehouse
  • Increments received_quantity on each InboundShipmentLine and the matching PurchaseOrderLine
  • Transitions the InboundShipment to partially_received or received (sets fully_received_at when all lines are fully received)

Request​

Responses​

OK

Response Headers
    Content-Type