System Status

Fulfillment returns

When Digital River coordinates an order's physical fulfillment, you can use the Fulfillment Returns API to manage the return process.

Gets a fulfillment return by its unique identifier

get

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

Path parameters
idstringRequired

Return ID

Responses
200
OK.
application/json
get
GET /fulfillment-returns/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "id": "ret_5823594809",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  },
  "fulfillmentOrderId": "ord_6645940010",
  "upstreamId": "ord_6645940010",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "inventoryItemId": "5823594809",
      "quantity": 1,
      "quantityAccepted": 1,
      "state": "accepted",
      "location": {
        "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]"
      },
      "unitAttributes": [
        {
          "serialNumber": ".",
          "imeiNumber": ".",
          "simCardNumber": "."
        }
      ],
      "unitAttributesAccepted": [
        {
          "serialNumber": ".",
          "imeiNumber": ".",
          "simCardNumber": "."
        }
      ]
    }
  ],
  "reason": "requested_by_customer",
  "state": "pending",
  "type": "client",
  "location": {
    "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]"
  },
  "livemode": false
}

Gets a Fulfillment by unique identifier

get

Retrieves the details of a Fulfillment.

Authorizations
Path parameters
idstringRequired

The unique identifier of a Fulfillment.

Responses
200
OK.
application/json
get
GET /fulfillments/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "ful_25c651d0-8079-48d7-b22e-eb1e2f451966",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  },
  "orderId": "ord_5678901234",
  "shipmentId": "321765",
  "items": [
    {
      "itemId": "98784590336",
      "skuId": "98784590336",
      "shipmentItemId": "321765",
      "quantity": 1,
      "cancelQuantity": 1
    }
  ],
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234"
}

Returns a list of Fulfillments

get

Gets all the Fulfillments specified in the request.

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 identifier of the order associated with the Fulfillment you want to retrieve.

skuIdstringOptional

The identifier of the SKU associated with the Fulfillments you want to retrieve.

trackingCompanystringOptional

The tracking company associated with the Fulfillments you want to retrieve.

trackingNumberstringOptional

The tracking number associated with the Fulfillments you want to retrieve.

Responses
200
200 OK
application/json
get
GET /fulfillments HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "ful_25c651d0-8079-48d7-b22e-eb1e2f451966",
      "createdTime": {
        "offset": {
          "totalSeconds": 0,
          "id": "Z",
          "rules": {
            "fixedOffset": true,
            "transitions": [],
            "transitionRules": []
          }
        },
        "nano": 0,
        "year": 2018,
        "monthValue": 4,
        "dayOfMonth": 25,
        "hour": 20,
        "minute": 36,
        "second": 0,
        "dayOfWeek": "WEDNESDAY",
        "dayOfYear": 115,
        "month": "APRIL"
      },
      "orderId": "ord_5678901234",
      "shipmentId": "321765",
      "items": [
        {
          "itemId": "98784590336",
          "skuId": "98784590336",
          "shipmentItemId": "321765",
          "quantity": 1,
          "cancelQuantity": 1
        }
      ],
      "liveMode": false,
      "metadata": {
        "coupon": "iOS"
      },
      "trackingCompany": "Fedex",
      "trackingNumber": "5678901234",
      "trackingUrl": "http://www.digitalriver.com?code=5678901234"
    }
  ]
}
PreviousFulfillment ordersNextFulfillments

Last updated