ReturnReason
A reason from the shop's catalog of return reasons. ReturnOrderLineItem.reason refers to a reason by its technicalName. The catalog holds Pickware's default reasons and the reasons the merchant added.
type ReturnReason implements Node {
id: ID!
active: Boolean!
createdAt: DateTime!
description: String
isCustom: Boolean!
name: String
notAvailable: Boolean!
position: Int!
technicalName: String!
updatedAt: DateTime
}
Fields
ReturnReason.id ● ID! non-null scalar
Global identifier for this entity.
ReturnReason.active ● Boolean! non-null scalar
True when the merchant offers the reason for new returns.
ReturnReason.createdAt ● DateTime! non-null scalar
Timestamp the reason was created.
ReturnReason.description ● String scalar
Explanation of the reason in the language of the request. Null when the reason has none.
ReturnReason.isCustom ● Boolean! non-null scalar
True for a reason the merchant added, false for one of Pickware's default reasons.
ReturnReason.name ● String scalar
Name of the reason in the language of the request.
ReturnReason.notAvailable ● Boolean! non-null scalar
True when the reason was withdrawn from the catalog. A withdrawn reason must not be offered for new returns, but it remains on the return orders that already carry it.
ReturnReason.position ● Int! non-null scalar
Sort position of the reason within the catalog, ascending.
ReturnReason.technicalName ● String! non-null scalar
Stable identifier of the reason, used as ReturnOrderLineItem.reason. The default reasons have the same technical name in every shop.
ReturnReason.updatedAt ● DateTime scalar
Timestamp the reason was last changed.
Interfaces
Node interface
Any entity that can be loaded by its global id through the node(id: ID!) query.
Returned By
returnReason query
Member Of
ReturnReasonEdge object