Actions14
Create Shipment
AI-generatedSummary
Create shipments in a Miva store by grouping order line items marked for shipment in the input data and submitting them via the Miva API.
Inputs
- Store Code (required) — The Miva store code identifier.
- Order ID Field (required) — Field in input data that contains the order ID.
- Line ID Field (required) — Field in input data that contains the order line item ID.
- Create Shipment Field (required) — Field in input data that indicates whether to create a shipment; must be boolean true to trigger shipment creation.
- Return Fields — Select which shipment response fields to return; defaults to success, order_id, line_ids, and shipment_id.
Output shape
a list of shipment creation result objects, one per grouped order, each containing the requested return fields plus error information if shipment creation failed for that group.
Input items are grouped by order ID. Only items where the 'Create Shipment Field' is true are included in shipment creation. If no valid shipments are created, a single item with a message indicates none were created. Errors per order group are returned within the corresponding output object. The operation supports batch processing on multiple inputs.
Examples
Example 1: Typical Usage
Set 'Store Code' to your Miva store identifier. Map 'Order ID Field', 'Line ID Field', and 'Create Shipment Field' to input fields that contain the order IDs, order line item IDs, and a boolean flag indicating shipment creation respectively. Optionally configure which shipment response fields to return. The node processes input data items, creates shipments for each order with lines marked for shipment, and outputs the shipment details or errors.