OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Complete API → Set Shipment

AI-generated

Summary

Create a shipment for an order or update an existing shipment by sending its order ID, shipment details, and optional shipment ID or tracking number to OnPrintShop. The operation writes to OnPrintShop; Safe Mode blocks Complete API mutations.

Inputs

  • Safe Mode — Defaults to false. When enabled, blocks mutations in Complete API.
  • Input Mode — Choose Fields to provide arguments separately, or JSON Object to provide them together.
  • Order ID — Integer order_id identifying the order. The UI does not mark this field required, though the shipment mutation uses it.
  • Shipment ID — Integer shipment_id; omit or use 0 to create a new shipment, or supply an ID to update an existing one.
  • Shipmentinfo — JSON scalar sent as shipmentinfo. Provide the shipment payload as a JSON object or array; the UI default is an empty object.
  • Tracking Number — Optional tracking_number string.
  • Arguments JSON — In JSON Object mode, provide the mutation arguments as a JSON object, such as order_id, shipmentinfo, and optional shipment_id and tracking_number.
  • Partial Response — Choose whether errors fail the operation or partial data is returned. Reconcile every row if using partial data before further writes.
  • Return Fields Mode — Return all mutation fields or select a custom subset.
  • Return Fields — When Custom Selection is chosen, select id, message, and/or result.

Output shape

A single item containing the setShipment mutation result.

The mutation selects result, message, and id; the default return mode includes all three, while Custom Selection can filter them. GraphQL errors fail the operation unless partial response handling is configured. Safe Mode blocks this write when enabled.

Links

Discussion