SKUs

The SKUs (stock keeping units) resource serves as a unique identifier for each product variation within an inventory. It is crucial for managing stock, tracking sales, and ensuring efficient inventory control. Each SKU allows businesses to differentiate between products based on traits such as size, color, or model, enabling streamlined operations and improved customer satisfaction.

PreviousReturns NextSales summaries

Last updated 3 months ago

Returns a list of SKUs

Get all SKUs.

get

/skus

Query parameters

createdTimestring · date-time

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:

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

updatedTimestring · date-time

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:

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

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.

eccnstring

The Export Control Classification Number (ECCN) associated with the SKUs you want to retrieve.

partNumberstring

The partNumber associated with the SKUs you want to retrieve.

hsCodestring

The hsCode associated with the SKUs you want to retrieve.

taxCodestring

The taxCode associated with the SKUs you want to retrieve.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

405

406

408

429

500

502

503

504

{
  "hasMore": true,
  "data": [
    {
      "createdTime": "2025-02-22T19:45:05.150Z",
      "id": "sku_5823594809",
      "eccn": "EAR99",
      "hsCode": "6404.20",
      "partNumber": "SWG1224J10L",
      "taxCode": "4323.310_A",
      "name": "Athena Womens Running Shoes",
      "description": "Athena Womens Running Shoes",
      "image": "https://imageurl.com",
      "url": "https://producturl.com",
      "countryOfOrigin": "US",
      "weight": 20.5,
      "liveMode": false,
      "updatedTime": "2025-02-22T19:45:05.150Z",
      "weightUnit": "oz",
      "metadata": {
        "coupon": "iOS"
      }
    }
  ]
}

200 OK

Creates a SKU

Creates a SKU.

post

/skus

Body

idstring

Unique identifier of a SKU.

Example: 5823594809

eccnstringrequired

Export control classification number.

Example: EAR99

hsCodestring

International & US HS Code & Harmonized Tariff Code.

Example: 6404.20

partNumberstring

Manufacturer part number.

Example: SWG1224J10L

taxCodestringrequired

Sabrix tax code.

Example: 4323.310_A

namestringrequired

The product’s name.

Example: Athena Womens Running Shoes

descriptionstring

A description of the product.

Example: Athena Womens Running Shoes

imagestring

An image of the product.

Example: https://imageurl.com

urlstring

A product url.

Example: https://producturl.com

weightnumber · double

The weight of the sku in the unit system specified with weightUnit.

Example: 20.5

countryOfOriginstringrequired

2-letter country code.

Example: US

weightUnitstring · enum

The unit of measurement that applies to the sku weight. If you do not specify a value for weightUnit, then the default unit of measurement is applied.

Example: oz

Options: oz, lb, g, kg

metadataany of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/skus' \
  --header 'Content-Type: application/json' \
  --data '{"id":"5823594809","eccn":"EAR99","hsCode":"6404.20","partNumber":"SWG1224J10L","taxCode":"4323.310_A","name":"Athena Womens Running Shoes","description":"Athena Womens Running Shoes","image":"https://imageurl.com","url":"https://producturl.com","weight":20.5,"countryOfOrigin":"US","weightUnit":"oz","metadata":{"coupon":"iOS"}}'

201

400

401

403

405

406

408

409

429

500

502

503

504

{
  "createdTime": "2025-02-22T19:45:05.150Z",
  "id": "sku_5823594809",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "partNumber": "SWG1224J10L",
  "taxCode": "4323.310_A",
  "name": "Athena Womens Running Shoes",
  "description": "Athena Womens Running Shoes",
  "image": "https://imageurl.com",
  "url": "https://producturl.com",
  "countryOfOrigin": "US",
  "weight": 20.5,
  "liveMode": false,
  "updatedTime": "2025-02-22T19:45:05.150Z",
  "weightUnit": "oz",
  "metadata": {
    "coupon": "iOS"
  }
}

201 Created

Gets a SKU by ID

Retrieves the details of a SKU. You must supply the unique identifier of the SKU.

get

/skus/{id}

Path parameters

idstringrequired

SKU identifier.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

405

406

408

429

500

502

503

504

{
  "createdTime": "2025-02-22T19:45:05.150Z",
  "id": "sku_5823594809",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "partNumber": "SWG1224J10L",
  "taxCode": "4323.310_A",
  "name": "Athena Womens Running Shoes",
  "description": "Athena Womens Running Shoes",
  "image": "https://imageurl.com",
  "url": "https://producturl.com",
  "countryOfOrigin": "US",
  "weight": 20.5,
  "liveMode": false,
  "updatedTime": "2025-02-22T19:45:05.150Z",
  "weightUnit": "oz",
  "metadata": {
    "coupon": "iOS"
  }
}

OK.

Upserts a SKU

Upserts a SKU.

put

/skus/{id}

Path parameters

idstringrequired

SKU identifier.

Body

eccnstringrequired

Export control classification number.

Example: EAR99

hsCodestring

International & US HS Code & Harmonized Tariff Code.

Example: 6404.20

partNumberstring

Manufacturer part number.

Example: SWG1224J10L

taxCodestringrequired

Sabrix tax code.

Example: 4323.310_A

namestringrequired

The product’s name.

Example: Athena Womens Running Shoes

descriptionstring

A description of the product.

Example: Athena Womens Running Shoes

imagestring

An image of the product.

Example: https://imageurl.com

urlstring

A product url.

Example: https://producturl.com

countryOfOriginstringrequired

2-letter country code.

Example: US

weightnumber · double

The weight of the sku in the unit system specified with weightUnit.

Example: 20.5

weightUnitstring · enum

The unit of measurement that applies to the sku weight. If you do not specify a value for weightUnit, then the default unit of measurement is applied.

Example: oz

Options: oz, lb, g, kg

metadataany of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.digitalriver.com/skus/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"eccn":"EAR99","hsCode":"6404.20","partNumber":"SWG1224J10L","taxCode":"4323.310_A","name":"Athena Womens Running Shoes","description":"Athena Womens Running Shoes","image":"https://imageurl.com","url":"https://producturl.com","countryOfOrigin":"US","weight":20.5,"weightUnit":"oz","metadata":{"coupon":"iOS"}}'

200

201

400

401

403

405

406

408

409

429

500

502

503

504

{
  "createdTime": "2025-02-22T19:45:05.150Z",
  "id": "sku_5823594809",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "partNumber": "SWG1224J10L",
  "taxCode": "4323.310_A",
  "name": "Athena Womens Running Shoes",
  "description": "Athena Womens Running Shoes",
  "image": "https://imageurl.com",
  "url": "https://producturl.com",
  "countryOfOrigin": "US",
  "weight": 20.5,
  "liveMode": false,
  "updatedTime": "2025-02-22T19:45:05.150Z",
  "weightUnit": "oz",
  "metadata": {
    "coupon": "iOS"
  }
}

200 OK

Updates a SKU

Updates the specified SKU by setting the values of the parameters passed. Any parameters not provided will remain unchanged.

post

/skus/{id}

Path parameters

idstringrequired

SKU identifier.

Body

eccnstring

Export control classification number.

Example: EAR99

hsCodestring

International & US HS Code & Harmonized Tariff Code.

Example: 6404.20

partNumberstring

Manufacturer part number.

Example: SWG1224J10L

taxCodestring

Sabrix tax code.

Example: 4323.310_A

namestring

The product’s name.

Example: Athena Womens Running Shoes

descriptionstring

A description of the product.

Example: Athena Womens Running Shoes

imagestring

An image of the product.

Example: https://imageurl.com

urlstring

A product url.

Example: https://producturl.com

countryOfOriginstring

2-letter country code.

Example: US

weightnumber · double

The weight of the sku in the unit system specified with weightUnit.

Example: 20.5

weightUnitstring · enum

The unit of measurement that applies to the sku weight. If you do not specify a value for weightUnit, then the default unit of measurement is applied.

Example: oz

Options: oz, lb, g, kg

metadataany of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/skus/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"eccn":"EAR99","hsCode":"6404.20","partNumber":"SWG1224J10L","taxCode":"4323.310_A","name":"Athena Womens Running Shoes","description":"Athena Womens Running Shoes","image":"https://imageurl.com","url":"https://producturl.com","countryOfOrigin":"US","weight":20.5,"weightUnit":"oz","metadata":{"coupon":"iOS"}}'

200

400

401

403

404

405

406

408

409

429

500

502

503

504

{
  "createdTime": "2025-02-22T19:45:05.150Z",
  "id": "sku_5823594809",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "partNumber": "SWG1224J10L",
  "taxCode": "4323.310_A",
  "name": "Athena Womens Running Shoes",
  "description": "Athena Womens Running Shoes",
  "image": "https://imageurl.com",
  "url": "https://producturl.com",
  "countryOfOrigin": "US",
  "weight": 20.5,
  "liveMode": false,
  "updatedTime": "2025-02-22T19:45:05.150Z",
  "weightUnit": "oz",
  "metadata": {
    "coupon": "iOS"
  }
}

200 OK

Deletes a SKU by ID

Permanently deletes a SKU. Supply the unique identifier of the SKU.

delete

/skus/{id}

Path parameters

idstringrequired

SKU identifier

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

400

401

403

404

405

406

408

409

429

500

502

503

504

No body

204 No Content