DEV

Type.

OrderReturn

No description

Fields

Required

No description

carrier

String

No description

createdAt

DateTime!

Required

No description

createdBy

ID!

Required

No description

customerNote

String

No description

id

ID!

Required

No description

Required

No description

labelUrl

String

Only set for EXTERNAL labels, which have no Zonos shipment to read through. Null on ZONOS_GENERATED returns by design — a stored presigned URL expires. Read shipment { shipmentCartons { label { url } } } instead.

Required

No description

linkedRefunds

[OrderRefund!]!

Required

No description

merchantNote

String

No description

order

Order!

Required

No description

rootId

ID

The Root this return was quoted against. Supplies the parties and cartons the shipment is built from, so the parcel ships against what was priced. Null until quoted.

serviceLevel

String

The ServiceLevel accepted off that quote, as an ID or code. Required before a label can be created — otherwise the shipment inherits the outbound one's, often a carrier that cannot label.

shipment

Shipment

The RETURN-direction Shipment this return produced. Resolves live, so tracking and status reflect the carrier rather than what was true when the label was bought. The label lives under it — shipment { shipmentCartons { label } } — rather than being duplicated here, so it survives a void-and-reissue and its url cannot expire.

Required

No description

Required

No description

trackingNumber

String

No description

updatedAt

DateTime!

Required

No description

updatedBy

ID!

Required

No description
Book a demo

Was this page helpful?