Skip to main content

ReturnOrder

Goods a customer sends back against an order. A return order carries priced line items, one refund whose amount equals the return order's total, and a state that follows the return from the request to its completion.

type ReturnOrder implements Node {
id: ID!
amountNet: Float
amountTotal: Float
createdAt: DateTime!
internalComment: String
number: String!
orderId: ID!
positionPrice: Float
state: ReturnOrderState!
taxStatus: String
updatedAt: DateTime
warehouseId: ID
destinationStockMovements(
first: Int = 10
after: String
filter: StockMovementFilterInput
): StockMovementConnection
goodsReceiptLineItems(
first: Int = 10
after: String
filter: GoodsReceiptLineItemFilterInput
): GoodsReceiptLineItemConnection
goodsReceipts(
first: Int = 10
after: String
filter: GoodsReceiptFilterInput
): GoodsReceiptConnection
lineItems(
first: Int = 10
after: String
filter: ReturnOrderLineItemFilterInput
): ReturnOrderLineItemConnection
order: Order
refund: ReturnOrderRefund
sourceStockMovements(
first: Int = 10
after: String
filter: StockMovementFilterInput
): StockMovementConnection
stocks(
first: Int = 10
after: String
filter: StockFilterInput
): StockConnection
tags(
first: Int = 10
after: String
filter: TagFilterInput
): TagConnection
warehouse: Warehouse
}

Fields​

ReturnOrder.id ● ID! non-null scalar​

Global identifier for this entity.

ReturnOrder.amountNet ● Float scalar​

Total refund amount in the order's currency, excluding tax.

ReturnOrder.amountTotal ● Float scalar​

Total refund amount in the order's currency, including tax: the sum of the line item totals plus the refunded shipping costs.

ReturnOrder.createdAt ● DateTime! non-null scalar​

Timestamp the return order was created.

ReturnOrder.internalComment ● String scalar​

Free-form internal note of the merchant.

ReturnOrder.number ● String! non-null scalar​

Human-readable return order number.

ReturnOrder.orderId ● ID! non-null scalar​

ID of the order the goods are returned against.

ReturnOrder.positionPrice ● Float scalar​

Sum of the line item totals in the order's currency, without shipping costs.

ReturnOrder.state ● ReturnOrderState! non-null enum​

State of the return order.

ReturnOrder.taxStatus ● String scalar​

Tax status taken from the order: gross, net or tax-free.

ReturnOrder.updatedAt ● DateTime scalar​

Timestamp the return order was last changed. A change of its state counts as a change.

ReturnOrder.warehouseId ● ID scalar​

ID of the warehouse the returned goods are received into. Null until a warehouse is assigned.

ReturnOrder.destinationStockMovements ● StockMovementConnection object​

ReturnOrder.destinationStockMovements.first ● Int scalar​
ReturnOrder.destinationStockMovements.after ● String scalar​
ReturnOrder.destinationStockMovements.filter ● StockMovementFilterInput input​

ReturnOrder.goodsReceiptLineItems ● GoodsReceiptLineItemConnection object​

ReturnOrder.goodsReceiptLineItems.first ● Int scalar​
ReturnOrder.goodsReceiptLineItems.after ● String scalar​
ReturnOrder.goodsReceiptLineItems.filter ● GoodsReceiptLineItemFilterInput input​

ReturnOrder.goodsReceipts ● GoodsReceiptConnection object​

ReturnOrder.goodsReceipts.first ● Int scalar​
ReturnOrder.goodsReceipts.after ● String scalar​
ReturnOrder.goodsReceipts.filter ● GoodsReceiptFilterInput input​

ReturnOrder.lineItems ● ReturnOrderLineItemConnection object​

ReturnOrder.lineItems.first ● Int scalar​
ReturnOrder.lineItems.after ● String scalar​
ReturnOrder.lineItems.filter ● ReturnOrderLineItemFilterInput input​

ReturnOrder.order ● Order object​

ReturnOrder.refund ● ReturnOrderRefund object​

ReturnOrder.sourceStockMovements ● StockMovementConnection object​

ReturnOrder.sourceStockMovements.first ● Int scalar​
ReturnOrder.sourceStockMovements.after ● String scalar​
ReturnOrder.sourceStockMovements.filter ● StockMovementFilterInput input​

ReturnOrder.stocks ● StockConnection object​

ReturnOrder.stocks.first ● Int scalar​
ReturnOrder.stocks.after ● String scalar​
ReturnOrder.stocks.filter ● StockFilterInput input​

ReturnOrder.tags ● TagConnection object​

ReturnOrder.tags.first ● Int scalar​
ReturnOrder.tags.after ● String scalar​
ReturnOrder.tags.filter ● TagFilterInput input​

ReturnOrder.warehouse ● Warehouse object​

Interfaces​

Node interface​

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By​

approveReturnOrder mutation ● cancelReturnOrder mutation ● declineReturnOrder mutation ● requestReturnOrder mutation ● returnOrder query

Member Of​

GoodsReceiptLineItem object ● ReturnOrderEdge object ● ReturnOrderLineItem object ● ReturnOrderRefund object ● Stock object ● StockMovement object

Webhook topics​

TopicFires when
return-order/announced
Required scopereturn_orders:read
A requested return order is approved and the shop now expects the goods.
return-order/cancelled
Required scopereturn_orders:read
A return order is cancelled, regardless of its previous state.
return-order/completed
Required scopereturn_orders:read
A return order is completed. A return order is always completed as a whole. A completed return order that is reopened and completed again fires again.
return-order/declined
Required scopereturn_orders:read
A requested return order is declined. Only requested return orders can be declined.
return-order/partially-received
Required scopereturn_orders:read
A return order reaches the state partially received because some, but not all, of the announced goods have arrived. A return order that is reopened from completed does not fire.
return-order/received
Required scopereturn_orders:read
A return order reaches the state received because all announced goods have arrived, whether with one goods receipt or with the last of several. A return order that is reopened from completed does not fire.
return-order/requested
Required scopereturn_orders:read
A return order is requested. A return order that is created already approved fires return-order/requested and then return-order/announced.

The webhooks guide explains how to subscribe to a topic and verify the notifications it sends.