System Status

Inventory items

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

Returns a list of inventory items

get

Get all inventory items.

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.

partNumberstringOptional

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

manufacturerIdstringOptional

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

Responses
200
200 OK
application/json
get
GET /inventory-items HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "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"
      },
      "manufacturerId": "84f18544-e6ab-44bb-b543-56c7b30fb6ca",
      "eccn": "EAR99",
      "hsCode": "6404.20",
      "partNumber": "SWG1224J10L",
      "countryOfOrigin": "US",
      "allowOversell": false,
      "liveMode": false,
      "updatedTime": {
        "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"
      }
    }
  ]
}

Creates an inventory item

post

Creates an inventory item.

Body
idstringOptional

Unique identifier of an inventory item.

Example: 5823594809
manufacturerIdstringOptional

Unique Digital River manufacturer identifier.

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

Manufacturer part number.

Example: SWG1224J10L
eccnstringOptional

Export control classification number.

Example: EAR99
hsCodestringOptional

International & US HS Code & Harmonized Tariff Code.

Example: 6404.20
countryOfOriginstringOptional

An ISO 3166-1 alpha-2 country code.

Example: US
allowOversellbooleanOptional

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

Example: false
Responses
201
201 Created
application/json
post
POST /inventory-items HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "id": "5823594809",
  "manufacturerId": "84f18544-e6ab-44bb-b543-56c7b30fb6ca",
  "partNumber": "SWG1224J10L",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "countryOfOrigin": "US",
  "allowOversell": false
}
{
  "id": "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"
  },
  "manufacturerId": "84f18544-e6ab-44bb-b543-56c7b30fb6ca",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "partNumber": "SWG1224J10L",
  "countryOfOrigin": "US",
  "allowOversell": false,
  "liveMode": false,
  "updatedTime": {
    "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"
  }
}

Gets an inventory item by ID

get

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

Path parameters
idstringRequired

Inventory item identifier.

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

{
  "id": "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"
  },
  "manufacturerId": "84f18544-e6ab-44bb-b543-56c7b30fb6ca",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "partNumber": "SWG1224J10L",
  "countryOfOrigin": "US",
  "allowOversell": false,
  "liveMode": false,
  "updatedTime": {
    "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"
  }
}

Deletes an inventory item by ID

delete

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

Path parameters
idstringRequired

Inventory item identifier

Responses
204
204 No Content
delete
DELETE /inventory-items/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

No content

Updates an inventory item

post

Updates an inventory item.

Path parameters
idstringRequired

Inventory item identifier.

Body
manufacturerIdstringOptional

Unique Digital River manufacturer identifier.

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

Manufacturer part number.

Example: SWG1224J10L
eccnstringOptional

Export control classification number.

Example: EAR99
hsCodestringOptional

International & US HS Code & Harmonized Tariff Code.

Example: 6404.20
countryOfOriginstringOptional

An ISO 3166-1 alpha-2 country code.

Example: US
allowOversellbooleanOptional

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

Example: false
Responses
201
201 Created
application/json
post
POST /inventory-items/{id} HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "manufacturerId": "84f18544-e6ab-44bb-b543-56c7b30fb6ca",
  "partNumber": "SWG1224J10L",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "countryOfOrigin": "US",
  "allowOversell": false
}
{
  "id": "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"
  },
  "manufacturerId": "84f18544-e6ab-44bb-b543-56c7b30fb6ca",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "partNumber": "SWG1224J10L",
  "countryOfOrigin": "US",
  "allowOversell": false,
  "liveMode": false,
  "updatedTime": {
    "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"
  }
}
PreviousFulfillmentsNextInventory levels

Last updated