Return GraphQL

Served by ReturnModule on commercetools.

Each operation has its own page with its arguments, an example and the engines that serve it. The types link to their fields on the return types page.

Operations

Operation	Description	Served by
`returnEstimate`Query	What a return of these lines would withhold and pay back, before it is requested.	commercetools
`returnExchangeOptions`Query	What a line of one of the customer's own orders can be exchanged for: the other variants of its product that are in stock and cost no more than was paid.	commercetools
`returnReasons`Query	Reasons a buyer may give, in the store's language	commercetools
`returnAttachmentUpload`Mutation	A signed URL to upload one attachment to	commercetools
`returnCancel`Mutation	Withdraw a return that is still cancellable	commercetools
`returnCreate`Mutation	Request a return for delivered lines, for the session's active business unit or, without one, the customer; every order must belong to it.	commercetools

Types

Type	Description
`Invoice`Object
`Return`Object	A return raised against one or more orders
`ReturnableLine`Object	An order line that can still be returned, and how many.
`ReturnAttachment`Object	A photo or document attached to a returned line
`ReturnAttachmentUpload`Object	A signed URL to PUT one attachment to, before it is named in returnCreate
`ReturnAttachmentUploadError`Union
`ReturnAttachmentUploadResponse`Object
`ReturnCancelError`Union
`ReturnCancelResponse`Object
`ReturnCreateError`Union
`ReturnCreateResponse`Object
`ReturnCreditNote`Object	The credit note that settles a credited return against its invoice
`ReturnDropOff`Object	What the buyer shows at a service point to hand the parcel in.
`ReturnError`Object	A return the server refuses for a reason of the domain rather than of one field
`ReturnErrorCodeType`Enum
`ReturnEstimate`Object	What a return of these lines would withhold and pay back, to show before it is requested
`ReturnEstimateLine`Object
`ReturnExchange`Object	What a returned line is exchanged for, in the same quantity, instead of being refunded.
`ReturnExchangeInput`Input object
`ReturnItem`Object	A single returned line within a return
`ReturnItemInput`Input object
`ReturnReason`Object	Why a return or one of its lines was raised
`ReturnReasonInput`Input object
`ReturnReasonOption`Object	A reason a buyer may give for returning a line, with what it requires.
`ReturnRefund`Object	Where a consumer's refund goes, and what was paid back
`ReturnRefundMethodType`Enum	Where a consumer's refund goes
`ReturnResolutionType`Enum	How a completed return was settled
`ReturnResult`Object
`ReturnShipping`Object
`ReturnShippingInput`Input object
`ReturnShippingMethodType`Enum	How the goods go back to the seller
`ReturnStatusType`Enum	Where a return is in the process, normalized across engines

Fields on other types

This domain adds these fields to types that another domain defines.

`BusinessUnit`

Field	Type	Description
`returns`	`ReturnResult!`	Returns for the unit's orders the associate can see, newest firstArguments: `page`, `pageSize`, `status`
`return`	`Return`	One of the unit's returns the associate can see; null otherwiseArguments: `id`

`Customer`

Field	Type	Description
`returns`	`ReturnResult!`	The signed-in customer's returns, newest firstArguments: `page`, `pageSize`, `status`
`return`	`Return`	One of the signed-in customer's returns; null when it is not theirsArguments: `id`

`Order`

Field	Type	Description
`returnableLines`	`[ReturnableLine!]!`	Lines that can still be returned; empty when nothing was delivered or all went back
`returnRefundMethods`	`[ReturnRefundMethodType!]!`	How a consumer's return of this order may be refunded; a refundMethod outside it is refused. Empty for a business unit's order, which is settled by credit note instead.