CreateShippingRunCommandRequestInput
Starts a shipping run: delivers many sales orders in one go. The run works asynchronously; read its state with GetShippingRun and the result per sales order with QueryShippingRunOrdersByShippingRunId. First every sales order is checked like a single delivery: blocked or not deliverable orders are skipped and their blockers recorded. Then all remaining orders are delivered together in one transaction, each completely (or what is in stock with ‘allowPartialDelivery’) with one package with the shipping method of the order; if the delivery fails technically, no order of the run is delivered and the run fails. Then, if requested, a label is requested for every new package (see CreatePackageShippingLabel) and failed labels are recorded per order without undoing the delivery, or the new packages are marked as shipped. Printing is done by the print service. This is the one set-wise write of the domain, justified by the volume of a shipping day; the single delivery stays CreateSalesOrderDelivery. errorCode is one of: SALES_ORDER_IDS_INVALID (the list is empty, has more than 2000 entries or names a sales order twice); SHIPPING_RUN_ID_CONFLICT (a shipping run with this ID exists with a different request); WAREHOUSE_NOT_FOUND (a given warehouse was not found or does not deliver). - Request
CreateShippingRunCommandRequestInputFields
The ID of the new shipping run, generated by the client (UUID, version 7 recommended). Sending the same ID again with the same request returns the existing run and starts nothing; with a different request it is refused.
The sales orders to deliver, at least 1 and at most 2000, each at most once. The order of the list is the order of processing.
Whether what is in stock is delivered for orders that cannot be delivered completely. Defaults to false: such orders are skipped.
The warehouses to take the stock from, in this order. Defaults to all warehouses that deliver, by their delivery priority.
Whether a label is requested for every new package whose shipping method is mapped to a shipping service; a created label also marks the package as shipped. Defaults to false.
Whether the new packages of own warehouses are marked as shipped at the end of the run. Defaults to false.
Suppresses the automatic workflow triggers of this call. Defaults to false when omitted.
Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.
Was this page helpful?