Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Logistics Returns

Creates a return

Returns all or part of a previously created order.

post/logistics-returns

Request body

orderIdstring required

The unique identifier of the order associated with the return.

rmaNumberstring required

The return merchandise authorization number.

reasonstring

The reason for the return.

Example request

{
  "orderId": "6645940010",
  "rmaNumber": "2343256645940010",
  "reason": "requested_by_customer",
  "items": [
    {
      "itemId": "99341140336",
      "quantity": 1
    }
  ]
}

Response

201 Created

idstring

The unique identifier of the return.

createdTimestring date-time

The time at which the return was created.

orderIdstring

The unique identifier of the order associated with the return.

rmaNumberstring

The return merchandise authorization number.

reasonstring

The reason for the return.

type'authorization' | 'received' | 'refused' | 'undeliverable'
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.

Example response

{
  "id": "ret_5823594809",
  "createdTime": "2018-04-25T20:36:00Z",
  "orderId": "6645940010",
  "rmaNumber": "2343256645940010",
  "reason": "requested_by_customer",
  "type": "authorized",
  "returnTo": {
    "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",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "items": [
    {
      "itemId": "99341140336",
      "productDetails": {
        "id": "100067660336",
        "skuGroupId": "wireless-keyboards",
        "name": "Keyboard",
        "description": "Top rated keyboard",
        "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
        "url": "https://producturl.com",
        "countryOfOrigin": "US",
        "image": "https://imageurl.com",
        "weight": 20.5,
        "weightUnit": "oz",
        "partNumber": "SWG1224J10L",
        "partnerAccountId": "00g6atnynbl2wFsFG357"
      },
      "quantity": 1,
      "condition": "broken"
    }
  ]
}