SalesOrders

Creates another pick transfer for whatever lines are not yet covered (the app's "Create transfer").

Requires ManageSalesOrders and an Idempotency-Key header; no body. Unlike /fulfill it writes no status entry and works in any non-terminal status: the transfer covers only the quantity of live lines not already on a live transfer, from the order's source locations (else the warehouses), using available stock; the history records "Transfer created (via API key '…')" and the order's status is recalculated. Refused (409 Error creating transfer: …) when there is no source location or nothing left to cover / no available stock. Next: /pick.

post/api/v1/sales-orders/{id}/transfers

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/sales-orders/{id}/transfers
  • Auth: HTTP bearer

Path parameters

idinteger required

Sales-order id. Example: 318.

Response

Created; transferId is the new transfer, status the recalculated order status.

salesOrderIdinteger

The sales order's id. Example: 318.

statusstring

Order status after the step: Pending, Picking, Packed, Shipped, Delivered, Complete or Cancelled. Recalculated from the order's transfers, so always read it rather than assuming the next status. Example: Packed.

fulfillmentStatusstring nullable

Aggregate status of the order's transfers (None, Pending, InTransit, AtWaypoint, Completed, Cancelled…), as fulfillmentStatus on the order. Example: InTransit.

transferIdinteger nullable

The transfer the step acted on (resolved when the request did not name one); null for /complete and /cancel. Example: 904.

messagestring nullable

Human-readable confirmation, as the app shows it. Example: Transfer status updated to In Transit.

unitsPickedinteger

/pick: units marked picked by this call (0 for other steps). Example: 10.

itemsReturnedinteger

/cancel: delivered units returned to inventory (0 for other steps). Example: 0.

transfersCancelledinteger

/cancel: transfers cancelled (0 for other steps). Example: 1.

Changes

No recorded changes to this operation across all 1 revision of this API.