LogoLogo
System Status
2021-12-13
2021-12-13
  • 2021-12-13
  • Charges
    • Charge basics
  • Checkouts
  • Country specifications
  • Customers
  • Events
  • Fees
  • File Links
    • File link basics
  • Files
    • File basics
  • Fulfillments
  • Fulfillment cancellations
  • Fulfillment orders
  • Fulfillment returns
  • Inventory items
  • Inventory levels
  • Invoices
    • Invoice basics
  • Logistics returns
  • Orders
    • Order basics
  • Payouts
  • Plans
    • Plan basics
  • Refunds
  • Reservations
  • Returns
  • Sales summaries
  • Sales transactions
  • Shipments
  • Shipping labels
  • Shipping quotes
  • SKUs
  • SKU Groups
  • Sources
  • Subscriptions
    • Subscription basics
  • Tax identifiers
  • Webhooks
  • Drop-in checkout links
  • Drop-in checkout sessions
    • Checkout-sessions basics
  • Drop-in shipping quotes
  • Store credit callout
Powered by GitBook
On this page

SKUs

PreviousShipping quotesNextSKU Groups

Last updated 6 months ago

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.

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
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
404
404 Not Found
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
get
GET /skus/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "createdTime": "2018-04-25T20:36:00Z",
  "id": "sku_5823594809",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "skuGroupId": "5823594809",
  "partNumber": "SWG1224J10L",
  "manufacturerId": "654123",
  "managedFulfillment": "DRGlobalFulfillment",
  "physical": true,
  "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",
  "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
  "partnerAccountId": "00g6atnynbl2wFsFG357",
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "updatedTime": "2018-04-25T20:36:00Z"
}

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
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
404
401 Not Found
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
409
409 Conflict
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
delete
DELETE /skus/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

  • GETReturns a list of SKUs
  • POSTCreates a SKU
  • GETGets a SKU by ID
  • POSTUpdates a SKU
  • PUTUpserts a SKU
  • DELETEDeletes a SKU by ID

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.

skuGroupIdstringOptional

An unique identifier for the sku-group, can be client provided or DR system generated.

Responses
200
200 OK
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
get
GET /skus HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "hasMore": true,
  "data": [
    {
      "createdTime": "2018-04-25T20:36:00Z",
      "id": "sku_5823594809",
      "eccn": "EAR99",
      "hsCode": "6404.20",
      "skuGroupId": "5823594809",
      "partNumber": "SWG1224J10L",
      "manufacturerId": "654123",
      "managedFulfillment": "DRGlobalFulfillment",
      "physical": true,
      "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",
      "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
      "partnerAccountId": "00g6atnynbl2wFsFG357",
      "liveMode": false,
      "metadata": {
        "coupon": "iOS"
      },
      "updatedTime": "2018-04-25T20:36:00Z"
    }
  ]
}

Creates a SKU

post

Submit this request to create a SKU.

Authorizations
Body
idstringOptional

The unique identifier of a SKU.

Example: 5823594809
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
skuGroupIdstringOptional

The unique identifier of the Sku Group.

Example: 5823594809
partNumberstringOptional

The manufacturer's part number.

Example: SWG1224J10L
manufacturerIdstringOptional

The unique identifier

Example: 654123
managedFulfillmentstring · enumOptional

Signifies the product is physically fulfilled by Digital River.

Possible values:
taxCodestringOptional

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

The full path to the category where item is included. Categories should be separated by “ > “.

Example: Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers
countryOfOriginstringOptional

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

Example: US
partnerAccountIdstringOptional

The unique, Digital River identifier (account Id) of the partner associated with the sku.

Example: 00g6atnynbl2wFsFG357
Responses
201
201 Created
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
409
409 Conflict
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
post
POST /skus HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 565

{
  "id": "5823594809",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "skuGroupId": "5823594809",
  "partNumber": "SWG1224J10L",
  "manufacturerId": "654123",
  "managedFulfillment": "DRGlobalFulfillment",
  "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",
  "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
  "countryOfOrigin": "US",
  "partnerAccountId": "00g6atnynbl2wFsFG357",
  "metadata": {
    "coupon": "iOS"
  }
}
{
  "createdTime": "2018-04-25T20:36:00Z",
  "id": "sku_5823594809",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "skuGroupId": "5823594809",
  "partNumber": "SWG1224J10L",
  "manufacturerId": "654123",
  "managedFulfillment": "DRGlobalFulfillment",
  "physical": true,
  "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",
  "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
  "partnerAccountId": "00g6atnynbl2wFsFG357",
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "updatedTime": "2018-04-25T20:36:00Z"
}

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
skuGroupIdstringOptional

The unique identifier of the Sku Group.

Example: 5823594809
partNumberstringOptional

The manufacturer's part number.

Example: SWG1224J10L
manufacturerIdstringOptional

The unique identifier

Example: 654123
managedFulfillmentstring · enumOptional

Signifies the product is physically fulfilled by Digital River.

Possible values:
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:
itemBreadcrumbstringOptional

The full path to the category where item is included. Categories should be separated by “ > “.

Example: Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers
partnerAccountIdstringOptional

The unique, Digital River identifier (account Id) of the partner associated with the sku.

Example: 00g6atnynbl2wFsFG357
Responses
200
200 OK
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
404
401 Not Found
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
409
409 Conflict
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
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: 547

{
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "skuGroupId": "5823594809",
  "partNumber": "SWG1224J10L",
  "manufacturerId": "654123",
  "managedFulfillment": "DRGlobalFulfillment",
  "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",
  "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
  "partnerAccountId": "00g6atnynbl2wFsFG357",
  "metadata": {
    "coupon": "iOS"
  }
}
{
  "createdTime": "2018-04-25T20:36:00Z",
  "id": "sku_5823594809",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "skuGroupId": "5823594809",
  "partNumber": "SWG1224J10L",
  "manufacturerId": "654123",
  "managedFulfillment": "DRGlobalFulfillment",
  "physical": true,
  "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",
  "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
  "partnerAccountId": "00g6atnynbl2wFsFG357",
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "updatedTime": "2018-04-25T20:36:00Z"
}

Upserts a SKU

put

Either creates or updates a SKU.

Authorizations
Path parameters
idstringRequired

The identifier of the SKU to update or create. If a SKU with this id exists, then Digital River uses the data in the request body to update the resource. Otherwise, Digital River uses that same data to create a new SKU resource and assigns it id.

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
skuGroupIdstringOptional

The unique identifier of the Sku Group.

Example: 5823594809
partNumberstringOptional

The manufacturer's part number.

Example: SWG1224J10L
manufacturerIdstringOptional

The unique identifier

Example: 654123
managedFulfillmentstring · enumOptional

Signifies the product is physically fulfilled by Digital River.

Possible values:
taxCodestringOptional

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

The full path to the category where item is included. Categories should be separated by “ > “.

Example: Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers
partnerAccountIdstringOptional

The unique, Digital River identifier (account Id) of the partner associated with the sku.

Example: 00g6atnynbl2wFsFG357
Responses
200
200 OK. This indicates that a SKU with that `id` existed and is now updated.
application/json
201
201 Created. This indicates that a SKU with that `id` did not exist but is now created.
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
409
409 Conflict
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
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: 547

{
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "skuGroupId": "5823594809",
  "partNumber": "SWG1224J10L",
  "manufacturerId": "654123",
  "managedFulfillment": "DRGlobalFulfillment",
  "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",
  "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
  "partnerAccountId": "00g6atnynbl2wFsFG357",
  "metadata": {
    "coupon": "iOS"
  }
}
{
  "createdTime": "2018-04-25T20:36:00Z",
  "id": "sku_5823594809",
  "eccn": "EAR99",
  "hsCode": "6404.20",
  "skuGroupId": "5823594809",
  "partNumber": "SWG1224J10L",
  "manufacturerId": "654123",
  "managedFulfillment": "DRGlobalFulfillment",
  "physical": true,
  "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",
  "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
  "partnerAccountId": "00g6atnynbl2wFsFG357",
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "updatedTime": "2018-04-25T20:36:00Z"
}