Skip to main content

shipments

Search and retrieve shipments with comprehensive filtering and pagination capabilities.

Provides flexible search across shipment data including order references, shipment status, carrier information, delivery dates, and tracking details. Results are paginated and can be filtered based on various fulfillment and logistics criteria to support warehouse operations and customer service needs.

Possible errors:

  • SHIPMENT_LIST_ERROR: Failed to retrieve shipments due to system error
  • FORBIDDEN: Insufficient permissions to access shipments
  • VALIDATION_ERROR: Invalid search parameters provided

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')

shipments(
  input: ShipmentSearchInput
): ShipmentResponse!

Arguments​

shipments.input ● ShipmentSearchInput input​

Search criteria and pagination parameters for filtering shipments.

All fields are optional - if no criteria provided, returns all accessible shipments with default pagination settings.

Type​

ShipmentResponse object​

Paginated response containing shipment search results with metadata for efficient data retrieval and navigation