Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Returns

Gets a return by ID

Retrieves the details of a return. Supply the unique identifier of the return.

get/returns/{id}

Path parameters

idstring required

Return ID

Response

OK.

idstring

The unique identifier of the return.

createdTimestring date-time

The time at which the return was created.

updatedTimestring date-time

The time at which the return was updated.

orderIdstring

The unique identifier of the order.

currencystring

A three-letter ISO currency code.

reasonstring

The reason for the return.

failureReasonstring

An enumeration indicating the reason for the return failure, if known.

state'created' | 'accepted'

An enumeration indicating the state of the return.

liveModeboolean

Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

refundIdsstring[]

Example response

{
  "id": "ret_5823594809",
  "createdTime": "2018-04-25T20:36:00Z",
  "updatedTime": "2018-04-25T20:36:00Z",
  "orderId": "ord_6645940010",
  "currency": "USD",
  "items": [
    {
      "itemId": "99341140336",
      "skuId": "sku_5823594809",
      "amount": 899,
      "quantity": 1,
      "quantityAccepted": 1,
      "state": "created"
    }
  ],
  "reason": "requested_by_customer",
  "state": "created",
  "location": {
    "address": {
      "line1": "10380 Bren Rd W",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "jsmith@digitalriver.com"
  },
  "metadata": {
    "coupon": "iOS"
  },
  "refundIds": [
    "0848750667"
  ]
}