OnPrintShop Orders icon

OnPrintShop Orders

Read and update OnPrintShop orders, order products, shipments, batches, quotes, and statuses

Order → Get

AI-generated

Summary

Retrieve one OnPrintShop order by its required Order ID, selecting which order, customer, product, and address or shipment fields to return. Safe Mode is available to block mutations in Complete API use; for this legacy action, it retains reduced-response behavior.

Inputs

  • Order ID (required) — ID of the order to retrieve.
  • Safe Mode — In legacy actions, retains the existing reduced-response behavior.
  • Order Fields Mode and Order Fields — Choose custom fields, all available order fields, or no fields; in Custom Selection, select fields such as order status, totals, dates, payment, and shipping details.
  • Customer Fields Mode and Customer Fields — Choose custom fields, all available customer fields, or no fields; custom selection includes customer name, email, phone, company, and account details.
  • Product Fields Mode and Product Fields — Choose custom fields, all available product fields, or no fields; custom selection includes product identifiers, names, quantities, prices, and status.
  • Blind Detail Fields Mode and Blind Detail Fields — Choose custom fields, all available fields, or no fields for blind shipping address details.
  • Delivery Detail Fields Mode and Delivery Detail Fields — Choose custom fields, all available fields, or no fields for delivery address and contact details.
  • Billing Detail Fields Mode and Billing Detail Fields — Choose custom fields, all available fields, or no fields for billing address and contact details.
  • Shipment Detail Fields Mode and Shipment Detail Fields — Choose custom fields, all available fields, or no fields for shipment tracking, company, package, shipping type, and weight details.

Output shape

A single order record.

The fields returned depend on the selected modes and fields. The UI notes that root GraphQL reads usually require at least one field; No Fields is mainly intended for optional nested groups. Use Order Products when line-item proof, design, or production status data is needed.

Examples

Example 1: Retrieve an order's status and total

Provide the Order ID and select Order Status and Total Amount, retaining the default customer, product, and detail selections if needed.

Example 2: Get shipment tracking details

Provide the Order ID and select Shipment Tracking Number, with shipment company or package fields as needed.

Example 3: Look up customer contact details for an order

Provide the Order ID and select Customer Email and Customer Phone, or use All Fields in Customer Fields Mode.

Links

Discussion