Logistics returns

The Logistics Returns resource streamlines handling returns in supply chain operations. It provides a comprehensive framework for managing returned goods, ensuring that processes are carried out smoothly and cost-effectively. By leveraging this resource, businesses can enhance customer satisfaction, minimize wastage, and optimize inventory management. Whether dealing with defective products or handling buyer's remorse, this resource equips logistics teams with the tools to handle returns seamlessly.

Returns a list of returns

get

Get all returns.

Authorizations
Query parameters
endingBeforestringOptional

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.

startingAfterstringOptional

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.

limitinteger · min: 1 · max: 100Optional

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

idsstring[]Optional

Only return objects with these IDs.

orderIdstringOptional

The order to retrieve returns for.

typestringOptional

The type of return.

rmaNumberstringOptional
Responses
200
200 OK
application/json
get
GET /logistics-returns HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "hasMore": true,
  "data": [
    {
      "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",
          "line2": "text",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "name": "John Smith",
        "phone": "952-111-1111",
        "email": "[email protected]",
        "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"
        }
      ],
      "liveMode": false
    }
  ]
}

Creates a return

post

Returns all or part of a previously created order.

Authorizations
Body
orderIdstringRequired

The unique identifier of the order associated with the return.

Example: 6645940010
rmaNumberstringRequired

The return merchandise authorization number.

Example: 2343256645940010
reasonstring · max: 64Optional

The reason for the return.

Example: requested_by_customer
Responses
201
201 Created
application/json
post
POST /logistics-returns HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "orderId": "6645940010",
  "rmaNumber": "2343256645940010",
  "reason": "requested_by_customer",
  "items": [
    {
      "itemId": "99341140336",
      "quantity": 1
    }
  ]
}
{
  "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",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]",
    "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"
    }
  ],
  "liveMode": false
}

Gets a return by ID

get

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

Authorizations
Path parameters
idstringRequired

Return ID

Responses
200
OK.
application/json
get
GET /logistics-returns/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "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",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]",
    "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"
    }
  ],
  "liveMode": false
}

Last updated