Skip to main content

RepaymentRequest

A repayment request (return): a customer's request to send goods back, with its lifecycle status, the lines selected for repayment, the return shipping, the warehouse evaluation rows, the credit note and the refund transactions.

type RepaymentRequest {
causal: RepaymentCausal
createdAt: ISO8601DateTime
fiscalDocument: AccountingCreditDocument
id: ID
lines: [RepaymentLine!]
number: String
order: Order
refundTransactions: [Transaction!]
returnedLines: [RepaymentReturnedLine!]
shipping: RepaymentShipping
status: RepaymentStatus
updatedAt: ISO8601DateTime
}

Fields​

RepaymentRequest.causal ● RepaymentCausal object​

The return reason (causal) of the repayment request.

RepaymentRequest.createdAt ● ISO8601DateTime scalar​

When the record was created.

RepaymentRequest.fiscalDocument ● AccountingCreditDocument object​

The fiscal document (credit note) issued for the return.

RepaymentRequest.id ● ID scalar​

The unique identifier of the record.

RepaymentRequest.lines ● [RepaymentLine!] list object​

The lines selected for repayment.

RepaymentRequest.number ● String scalar​

The number code identifying the repayment request.

RepaymentRequest.order ● Order object​

The order the return (repayment request) belongs to.

RepaymentRequest.refundTransactions ● [Transaction!] list interface​

The refund payment transactions linked to the return, matched through their referenceCode.

RepaymentRequest.returnedLines ● [RepaymentReturnedLine!] list object​

The warehouse evaluation rows of the return, with expected, received and compliant quantities.

RepaymentRequest.shipping ● RepaymentShipping object​

The return shipping, travelling from the customer back to the warehouse. Uses the same ShippingStatus values as order shippings, read in the context of a return (delivered means the returned goods reached the warehouse).

RepaymentRequest.status ● RepaymentStatus enum​

The lifecycle status of the return.

RepaymentRequest.updatedAt ● ISO8601DateTime scalar​

When the record was last updated.

Returned By​

repaymentRequest query ● repaymentReturnLinesEvaluationConfirm mutation

Member Of​

AdyenTransaction object ● HeylightTransaction object ● NexiTransaction object ● Order object ● PaymentBasicTransaction object ● PaymentExternalTransaction object ● PaypalTransaction object ● RepaymentRequestConnection object ● RepaymentRequestEdge object ● ScalaPayTransaction object ● ShopifyTransaction object ● StripeTransaction object ● Transaction interface