v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

ORDERS

Return an order

Retrieves all or a part of an order. An order must be paid or fulfilled for any part of the order to display.

post/v1/orders/{orderId}/returns

orderIdstring required

Order identifier.

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

expandstring[]

Additional information is provided as an expanded response, for example, related objects nested within the parent. See Use expandable fields.

Successful response. Order is successfully returned.

amountinteger required

Total amount for the return in the smallest monetary unit of the merchant's currency.

createdinteger required

Creation time of the object (Unix timestamp in milliseconds).

currencystring required

Three-letter ISO 4217 currency code (in lowercase).

idstring required

Unique object identifier.

livemodeboolean required

Set to true if the object is in production. Set to false if the object is in sandbox.

object'order_return' required

Object type. Objects with the same type have the same value.

orderstring

Order identifier.

refundstring

Refund identifier.