returnRequestCreate
Create a new return request
Arguments
1 argumentbrandId•IDID of the brand
customerId•IDID of the customer
orderLineId•IDID of the order line
quantityExpected•IntQuantity that is expected
returnReasonId•IDID of the return reason
subReturnReasonId•IDID of the sub return reason
reference•StringReference of the return request
remarks•StringRemarks about the return request
currency•String!ISO 4217 currency code
value•String!Amount
returnShippingServiceMethodId•IDID of the shipping method used for return shipment
address•StringStreet / first address line
address2•StringSecond address line
city•StringCity
companyName•StringCompany name (required when no name provided)
countryCode•StringISO code 3166 alpha 2
email•StringEmail address
eori•StringEconomic Operators Registration and Identification number
houseNumber•StringHouse number and addition
name•StringContact person name (required when no company name provided)
oss•StringOne-Stop Shop (OSS) number
phone•StringPhone number
postalCode•StringPostal code
stateCode•StringState code
vat•StringVAT identification number
status•ReturnRequestStatusStatus of the return request
ACCEPTEDCANCELEDCOMPLETEDDRAFTEXPIREDPENDINGRECEIVEDREFUNDREJECTEDPossible return
completedAt•DateTimeTzWhen the return request was completed.
createdAt•DateTimeTz!When the return request was created.
id•ID!Unique primary key.
locale•StringBCP-47 locale used for communication templates
reference•StringReference of the return request
remarks•StringRemarks about the return request
returnShippingPaymentStatus•ReturnShippingPaymentStatusPayment status for the customer return shipping contribution
FREEPAIDUNPAIDstatus•ReturnRequestStatusStatus of the return request
ACCEPTEDCANCELEDCOMPLETEDDRAFTEXPIREDPENDINGRECEIVEDREFUNDREJECTEDupdatedAt•DateTimeTz!When the return request was last updated.
field•[String!]message•String!