Skip to main content

shipmentCreate

Create a new shipment for order fulfillment with items and tracking information.

Establishes a new shipment record for fulfilling part or all of an order. The shipment can include specific order items with quantities, expected delivery information, and initial tracking data. This operation is essential for warehouse operations and order fulfillment workflows.

The shipment creation process includes:

  • Shipment header with order reference and delivery expectations
  • Shipment items linking to specific order items with fulfillment quantities
  • Initial tracking information with carrier details
  • Status initialization for shipment lifecycle management

Validation requirements:

  • Order ID must reference an existing, accessible order
  • Shipment items must reference valid order items from the specified order
  • Item quantities must not exceed remaining unfulfilled quantities
  • Expected delivery date must be in the future if provided
  • Tracking information must include valid carrier references

The created shipment will be assigned a unique UUID and will trigger shipment creation events for downstream systems including inventory management and customer notifications.

Possible errors:

  • SHIPMENT_CREATE_ERROR: Failed to create the shipment due to system error
  • ORDER_NOT_FOUND: Referenced order does not exist or is not accessible
  • ORDER_ITEM_NOT_FOUND: Referenced order items do not exist
  • VALIDATION_ERROR: Input validation failed (invalid quantities, dates, or references)
  • FORBIDDEN: Insufficient permissions to create shipments

AUTH: Role=[order.OWNER,order.EDITOR]

shipmentCreate(
  input: ShipmentCreateInput!
): Shipment!

Arguments​

shipmentCreate.input ● ShipmentCreateInput! non-null input​

Complete shipment creation data including order reference, items, and tracking information.

Required components:

  • Order ID: Valid order identifier that the shipment will fulfill
  • Expected delivery date: Estimated delivery date for customer communication (optional)

Optional components:

  • Shipment items: Specific order items and quantities to include in this shipment
  • Tracking information: Initial carrier and tracking details for shipment monitoring

If no items are specified, the shipment will be created without specific item allocations. Items can be added later through separate operations.

Type​

Shipment object​

Shipment entity representing a package or delivery containing order items with tracking and fulfillment information