OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Complete API → Order Shipment Details

AI-generated

Summary

Fetch order shipment details from the OnPrintShop Complete API using GraphQL queries, optionally filtering by order ID and paginating results.

Inputs

  • Safe Mode — A boolean to block mutations in Complete API or reduce nested response fields in legacy actions.
  • Limit — Maximum number of results to return per request.
  • Offset — Number of results to skip for pagination.
  • Orders ID — Filter to fetch shipment details for a specific order ID.
  • Return Fields Mode — Select whether to return all fields or a custom selection of fields.
  • Return Fields — When using custom selection mode, specify which shipment detail fields to retrieve (e.g., shipment company, package, tracking number, total weight).

Output shape

a list of shipment detail objects corresponding to the order shipments queried.

The response includes shipment details as an array, each element representing a shipment associated with the specified order(s). Supports pagination via limit and offset parameters. Errors from the GraphQL API throw node execution errors. If no shipments are found for a given order, a message object indicating no shipment details is returned.

Examples

Example 1: Retrieve tracking numbers and shipment companies for shipments of a specific order ID 12345

Set 'Orders ID' to 12345, choose 'Return Fields Mode' as 'Custom Selection', and select 'Shipment Tracking Number' and 'Order Shipment Details / Shipment Company' in 'Return Fields'.

Example 2: Fetch all shipment details with default fields for shipments across all orders with pagination

Leave 'Orders ID' empty, set 'Limit' to 50, 'Offset' to 0, and 'Return Fields Mode' to 'All Fields'.

Links

Discussion