GraphQL API
Warehouse API
Warehouse / Returns

returnReceiptCreate

Create a return receipt

Arguments

1 argument
stagedUrl•String

Staged URL.

orderId•ID

ID of the order (creates return request automatically if none exists)

remarks•String

Remarks about the return receipt

organizationId•ID

ID of the organization

reference•String

Reference of the return request (auto-generated when not provided)

senderAddress•ReturnReceiptSenderAddressInput

Sender address for this return

returnRequestId•ID

ID of the return request

undeliverableReturnReason•UndeliverableReturnReason

Reason why the return was undeliverable

ADDRESS_INCORRECTDAMAGEDNOT_COLLECTED_AT_PICKUP_POINTNOT_HOMEOTHERREFUSED

Possible return

completedAt•DateTimeTz

When the return receipt was completed.

createdAt•DateTimeTz!

When the return receipt was created.

id•ID!

Unique primary key.

remarks•String

Remarks about the return receipt

status•ReturnReceiptStatus

Status of the return receipt

COMPLETEDCREATEDPENDING
undeliverableReturnReason•UndeliverableReturnReason

Reason why the return was undeliverable

ADDRESS_INCORRECTDAMAGEDNOT_COLLECTED_AT_PICKUP_POINTNOT_HOMEOTHERREFUSED
updatedAt•DateTimeTz!

When the return receipt was last updated.

field•[String!]
message•String!