System Status

SKU

A stock keeping unit (SKU) represents a specific product variation.

Returns a list of SKUs

get

Gets the SKUs 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.

eccnstringOptional

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

partNumberstringOptional

The partNumber associated with the SKUs you want to retrieve.

hsCodestringOptional

The hsCode associated with the SKUs you want to retrieve.

taxCodestringOptional

The taxCode associated with the SKUs you want to retrieve.

Responses
200

200 OK

application/json
get
GET /skus HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

post

Submit this request to create a SKU.

Authorizations
Body
idstringOptional

The unique identifier of a SKU.

Example: 5823594809
eccnstringRequired

The export control classification number.

Example: EAR99
hsCodestringOptional

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

Example: 6404.20
partNumberstringOptional

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
descriptionstringOptional

A description of the product.

Example: Athena Womens Running Shoes
imagestringOptional

An image of the product.

Example: https://imageurl.com
urlstringOptional

A product url.

Example: https://producturl.com
weightnumber · doubleOptional

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

Example: 20.5
weightUnitstring · enumOptional

The unit of measurement applied to the weight.

Example: ozPossible values:
countryOfOriginstringRequired

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

Example: US
Responses
201

201 Created

application/json
post
POST /skus HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 329

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

get

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

Authorizations
Path parameters
idstringRequired

SKU identifier.

Responses
200

OK.

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

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

Upserts a SKU

put

Submit this request to upsert the specified SKU.

Authorizations
Path parameters
idstringRequired

The SKU identifier.

Body
eccnstringRequired

The export control classification number.

Example: EAR99
hsCodestringOptional

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

Example: 6404.20
partNumberstringOptional

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
descriptionstringOptional

A description of the product.

Example: Athena Womens Running Shoes
imagestringOptional

An image of the product.

Example: https://imageurl.com
urlstringOptional

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 · doubleOptional

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

Example: 20.5
weightUnitstring · enumOptional

The unit of measurement applied to the weight.

Example: ozPossible values:
Responses
200

200 OK

application/json
put
PUT /skus/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 311

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

Updates a SKU

post

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

Authorizations
Path parameters
idstringRequired

The SKU identifier.

Body
eccnstringOptional

The export control classification number.

Example: EAR99
hsCodestringOptional

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

Example: 6404.20
partNumberstringOptional

The manufacturer's part number.

Example: SWG1224J10L
taxCodestringOptional

The designated tax code.

Example: 4323.310_A
namestringOptional

The product?s name.

Example: Athena Womens Running Shoes
descriptionstringOptional

A description of the product.

Example: Athena Womens Running Shoes
imagestringOptional

An image of the product.

Example: https://imageurl.com
urlstringOptional

A product url.

Example: https://producturl.com
countryOfOriginstringOptional

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

Example: US
weightnumber · doubleOptional

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

Example: 20.5
weightUnitstring · enumOptional

The unit of measurement applied to the weight.

Example: ozPossible values:
Responses
200

200 OK

application/json
post
POST /skus/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 311

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

delete

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

Authorizations
Path parameters
idstringRequired

SKU identifier

Responses
204

204 No Content

delete
DELETE /skus/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousShipping quotesNextSources

Last updated