DEV

Input.

ShipmentReturnCreateWorkflowInput

No description

Fields

generateLabel

Boolean

Whether to buy the return Label in this same request. Set false to buy it later, in which case the shipment has neither a label nor tracking until labelCreate runs against it.

labelSpec

LabelSpecInput

The optional label specifications for the return Label to be generated

orderId

ID!

Required

The Order the return belongs to.
Optional references to be added on the Label and CI

rootId

ID!

Required

The Root the return was quoted against. Supplies the parties, items and cartons, so the parcel ships against what was priced. On a return the ORIGIN party is the customer and the DESTINATION is wherever returns are received. That reversal belongs to whoever creates the parties; it is not inferred here.

serviceLevel

String!

Required

ID or code of the ServiceLevel for the return. Required: a return has no landed cost to resolve one from, and the order's rating priced the outbound service, not this one.

Was this page helpful?


Get support·Legal docs·© 2026 Zonos