Categories

Get all categories and subcategories

get

Query parameters

apiKeystringOptional

Provide your client identifier.

tokenstringOptional

Provide the authorized or anonymous token for a shopper.

expandstringOptional

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstringOptional

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

currencystringOptional

Set the preferred currency you want to use for the product's pricing information. The currency query parameter takes precedence over the locale.

localestringOptional

Set the preferred locale you want to use for the product's pricing information. The currency query parameter takes precedence over the locale.

productsPageSizestringOptional

Specifies the maximum number of products to include for each category returned in a paginated response. It must be a positive integer greater than zero and less than 100000. The default is 10.

Responses

200

Successful response.

application/json

Responseone of

or

400

* Bad Request

application/json

401

* Invalid Token

application/json

get

HTTPcURLJavaScriptPython

GET /v1/shoppers/me/categories HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "categories": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/categories",
    "category": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/categories/6912100",
        "displayName": "Shop by Category",
        "products": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/categories/6912100/products"
        }
      }
    ]
  }
}

Get a category by ID

get

Get a category by ID. To get a category by ID, specify the category's ID in the {id} URI path parameter. This method returns the category requested and any of its subcategories.

Path parameters

categoryIdstringRequired

Catogory ID.

Query parameters

apiKeystringOptional

Provide your client identifier.

tokenstringOptional

Provide the authorized or anonymous token for a shopper.

expandstringOptional

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstringOptional

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

currencystringOptional

Set the preferred currency you want to use for the product's pricing information. The currency query parameter takes precedence over the locale.

localestringOptional

Set the preferred locale for the pricing information returned for products. The currency query parameter takes precedence over locale.

productsPageSizestringOptional

Specifies the maximum number of products to include for each category returned in a paginated response. It must be a positive integer greater than zero and less than 100000. The default is 10.

Responses

200

Successful response.

application/json

Responseone of

or

400

* Bad Request

application/json

401

* Invalid Token

application/json

404

* resource-not-found

application/json

get

HTTPcURLJavaScriptPython

GET /v1/shoppers/me/categories/{categoryId} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "category": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/categories/6912100",
    "id": 6912100,
    "locale": "en_US",
    "name": "Shop by Category",
    "displayName": "Shop by Category",
    "shortDescription": "text",
    "longDescription": "text",
    "thumbnailImage": "https://drh1.img.digitalriver.com/DRHM/Storefront/Company/demosft1/images/category/thumbnail/shop_by_category.gif",
    "products": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/categories/6912100/products"
    }
  }
}

Get all categories for a specific product

get

Path parameters

productIdstringRequired

Provide the product identifier.

Query parameters

apiKeystringOptional

Provide your client identifier.

tokenstringOptional

Provide the authorized or anonymous token for a shopper.

expandstringOptional

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstringOptional

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

currencystringOptional

Set the preferred currency you want to use for the product's pricing information. The currency query parameter takes precedence over the locale.

localestringOptional

Set the preferred currency you want to use for the product's pricing information. The currency query parameter takes precedence over the locale.

productsPageSizestringOptional

Specifies the maximum number of products to include for each category returned in a paginated response. It must be a positive integer greater than zero and less than 100000. The default is 10.

Responses

200

Successful response.

application/json

Responseone of

or

400

* Bad Request

application/json

401

* Invalid Token

application/json

get

HTTPcURLJavaScriptPython

GET /v1/shoppers/me/products/{productId}/categories HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "categories": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/categories",
    "category": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/categories/6912100",
        "displayName": "Shop by Category",
        "products": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/categories/6912100/products"
        }
      }
    ]
  }
}