SKU | Digital River API references

System Status

Returns a list of SKUs

Gets the SKUs specified in the request.

get

/skus

Authorizations

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.

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' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

405

406

408

429

500

502

503

504

{
  "hasMore": true,
  "data": [
    {
      "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,
      "metadata": {
        "coupon": "iOS"
      },
      "weightUnit": "oz",
      "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 a SKU

Submit this request to create a SKU.

post

/skus

Authorizations

Body

idstring

The unique identifier of a SKU.

Example: 5823594809

eccnstringrequired

The export control classification number.

Example: EAR99

hsCodestring

The international and US Harmonized System code (sometimes referred to as the Harmonized Tariff Schedule).

Example: 6404.20

partNumberstring

The manufacturer's part number.

Example: SWG1224J10L

taxCodestringrequired

The designated 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 product measured in the unit specified by weightUnit.

Example: 20.5

countryOfOriginstringrequired

A two-letter Alpha-2 country code as described in the ISO 3166 international standard.

Example: US

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

Example: {"coupon":"iOS"}

weightUnitstring · enum

The unit of measurement applied to the weight.

Example: oz

Options: oz, lb, g, kg

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/skus' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --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","metadata":{"coupon":"iOS"},"weightUnit":"oz"}'

201

400

401

403

405

406

408

409

429

500

502

503

504

{
  "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,
  "metadata": {
    "coupon": "iOS"
  },
  "weightUnit": "oz",
  "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 a SKU by ID

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

get

/skus/{id}

Authorizations

Path parameters

idstringrequired

SKU identifier.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

405

406

408

429

500

502

503

504

{
  "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,
  "metadata": {
    "coupon": "iOS"
  },
  "weightUnit": "oz",
  "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.

Upserts a SKU

Submit this request to upsert the specified SKU.

put

/skus/{id}

Authorizations

Path parameters

idstringrequired

The SKU identifier.

Body

eccnstringrequired

The export control classification number.

Example: EAR99

hsCodestring

The international and US Harmonized System code (sometimes referred to as the Harmonized Tariff Schedule).

Example: 6404.20

partNumberstring

The manufacturer's part number.

Example: SWG1224J10L

taxCodestringrequired

The designated 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

A two-letter Alpha-2 country code as described in the ISO 3166 international standard.

Example: US

weightnumber · double

The weight of the product measured in the unit specified by weightUnit.

Example: 20.5

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

Example: {"coupon":"iOS"}

weightUnitstring · enum

The unit of measurement applied to the weight.

Example: oz

Options: oz, lb, g, kg

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.digitalriver.com/skus/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --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,"metadata":{"coupon":"iOS"},"weightUnit":"oz"}'

200

201

400

401

403

405

406

408

409

429

500

502

503

504

{
  "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,
  "metadata": {
    "coupon": "iOS"
  },
  "weightUnit": "oz",
  "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

Updates a SKU

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

post

/skus/{id}

Authorizations

Path parameters

idstringrequired

The SKU identifier.

Body

eccnstring

The export control classification number.

Example: EAR99

hsCodestring

The international and US Harmonized System code (sometimes referred to as the Harmonized Tariff Schedule).

Example: 6404.20

partNumberstring

The manufacturer's part number.

Example: SWG1224J10L

taxCodestring

The designated 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

A two-letter Alpha-2 country code as described in the ISO 3166 international standard.

Example: US

weightnumber · double

The weight of the product measured in the unit specified by weightUnit.

Example: 20.5

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

Example: {"coupon":"iOS"}

weightUnitstring · enum

The unit of measurement applied to the weight.

Example: oz

Options: oz, lb, g, kg

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/skus/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --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,"metadata":{"coupon":"iOS"},"weightUnit":"oz"}'

200

400

401

403

404

405

406

408

409

429

500

502

503

504

{
  "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,
  "metadata": {
    "coupon": "iOS"
  },
  "weightUnit": "oz",
  "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

Deletes a SKU by ID

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

delete

/skus/{id}

Authorizations

Path parameters

idstringrequired

SKU identifier

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

400

401

403

404

405

406

408

409

429

500

502

503

504

No body

204 No Content