Inventory items

An inventory item represents a physical good whose fulfillment Digital River coordinates.

PreviousFulfillments NextInventory levels

Last updated 3 months ago

Returns a list of inventory items

Get all inventory items.

get

/inventory-items

Query parameters

createdTimeobject

A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq—return values where the createdTime field equals to this timestamp
gt—return values where the createdTime field is after this timestamp
gte—return values where the createdTime field is after or equal to this timestamp
lt—return values where the createdTime field is before this timestamp
lte—return values where the createdTime field is before or equal to this timestamp

Example: createdTime[gt]=2020-09-22T12:09:44Z

updatedTimeobject

A filter on the list based on the updatedTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq—return values where the updatedTime field equals this timestamp
gt—return values where the updatedTime field is after this timestamp
gte—return values where the updatedTime field is after or equal to this timestamp
lt—return values where the updatedTime field is before this timestamp
lte—return values where the updatedTime field is before or equal to this timestamp

Example: updatedTime[gt]=2020-09-22T12:09:44Z

endingBeforestring

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.

startingAfterstring

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: 100

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

idsstring[]

Only return objects with these IDs.

partNumberstring

The partNumber associated with the inventory items you want to retrieve.

manufacturerIdstring

The manufacturer identifier associated with the inventory items you want to retrieve.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/inventory-items'

200

400

401

403

405

406

408

429

500

502

503

504

{
  "hasMore": true,
  "data": [
    {
      "id": "5823594809",
      "manufacturerId": "84f18544-e6ab-44bb-b543-56c7b30fb6ca",
      "eccn": "EAR99",
      "hsCode": "6404.20",
      "partNumber": "SWG1224J10L",
      "countryOfOrigin": "US",
      "allowOversell": false,
      "liveMode": false,
      "createdTime": {
        "nano": 0,
        "year": 2018,
        "monthValue": 4,
        "dayOfMonth": 25,
        "hour": 20,
        "minute": 36,
        "second": 0,
        "dayOfWeek": "WEDNESDAY",
        "dayOfYear": 115,
        "month": "APRIL",
        "offset": {
          "totalSeconds": 0,
          "id": "Z",
          "rules": {
            "fixedOffset": true,
            "transitions": [],
            "transitionRules": []
          }
        }
      },
      "updatedTime": {
        "nano": 0,
        "year": 2018,
        "monthValue": 4,
        "dayOfMonth": 25,
        "hour": 20,
        "minute": 36,
        "second": 0,
        "dayOfWeek": "WEDNESDAY",
        "dayOfYear": 115,
        "month": "APRIL",
        "offset": {
          "totalSeconds": 0,
          "id": "Z",
          "rules": {
            "fixedOffset": true,
            "transitions": [],
            "transitionRules": []
          }
        }
      }
    }
  ]
}

200 OK

Creates an inventory item

Creates an inventory item.

post

/inventory-items

Body

idstring

Unique identifier of an inventory item.

Example: 5823594809

manufacturerIdstring

Unique Digital River manufacturer identifier.

Example: 84f18544-e6ab-44bb-b543-56c7b30fb6ca

partNumberstringrequired

Manufacturer part number.

Example: SWG1224J10L

eccnstring

Export control classification number.

Example: EAR99

hsCodestring

International & US HS Code & Harmonized Tariff Code.

Example: 6404.20

countryOfOriginstring

An ISO 3166-1 alpha-2 country code.

Example: US

allowOversellboolean

If true, customers are allowed to reserve inventory of the item when it is out of stock.

Example: false

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/inventory-items' \
  --header 'Content-Type: application/json' \
  --data '{"id":"5823594809","manufacturerId":"84f18544-e6ab-44bb-b543-56c7b30fb6ca","partNumber":"SWG1224J10L","eccn":"EAR99","hsCode":"6404.20","countryOfOrigin":"US","allowOversell":false}'

201

400

401

403

405

406

408

409

429

500

502

503

504

{
  "id": "5823594809",
  "manufacturerId": "84f18544-e6ab-44bb-b543-56c7b30fb6ca",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "partNumber": "SWG1224J10L",
  "countryOfOrigin": "US",
  "allowOversell": false,
  "liveMode": false,
  "createdTime": {
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL",
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    }
  },
  "updatedTime": {
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL",
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    }
  }
}

201 Created

Gets an inventory item by ID

Retrieves the details of an inventory item. You must supply the unique identifier of the inventory item.

get

/inventory-items/{id}

Path parameters

idstringrequired

Inventory item identifier.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/inventory-items/{id}'

200

400

401

403

404

405

406

408

429

500

502

503

504

{
  "id": "5823594809",
  "manufacturerId": "84f18544-e6ab-44bb-b543-56c7b30fb6ca",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "partNumber": "SWG1224J10L",
  "countryOfOrigin": "US",
  "allowOversell": false,
  "liveMode": false,
  "createdTime": {
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL",
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    }
  },
  "updatedTime": {
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL",
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    }
  }
}

OK.

Deletes an inventory item by ID

Permanently deletes an inventory item. Supply the unique identifier of the inventory item.

delete

/inventory-items/{id}

Path parameters

idstringrequired

Inventory item identifier

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.digitalriver.com/inventory-items/{id}'

204

400

401

403

404

405

406

408

409

429

500

502

503

504

No body

204 No Content

Updates an inventory item

Updates an inventory item.

post

/inventory-items/{id}

Path parameters

idstringrequired

Inventory item identifier.

Body

manufacturerIdstring

Unique Digital River manufacturer identifier.

Example: 84f18544-e6ab-44bb-b543-56c7b30fb6ca

partNumberstring

Manufacturer part number.

Example: SWG1224J10L

eccnstring

Export control classification number.

Example: EAR99

hsCodestring

International & US HS Code & Harmonized Tariff Code.

Example: 6404.20

countryOfOriginstring

An ISO 3166-1 alpha-2 country code.

Example: US

allowOversellboolean

If true, customers are allowed to reserve inventory of the item when it is out of stock.

Example: false

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/inventory-items/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"manufacturerId":"84f18544-e6ab-44bb-b543-56c7b30fb6ca","partNumber":"SWG1224J10L","eccn":"EAR99","hsCode":"6404.20","countryOfOrigin":"US","allowOversell":false}'

201

400

401

403

405

406

408

409

429

500

502

503

504

{
  "id": "5823594809",
  "manufacturerId": "84f18544-e6ab-44bb-b543-56c7b30fb6ca",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "partNumber": "SWG1224J10L",
  "countryOfOrigin": "US",
  "allowOversell": false,
  "liveMode": false,
  "createdTime": {
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL",
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    }
  },
  "updatedTime": {
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL",
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    }
  }
}

201 Created