Retrieve categories

Get all categories and subcategories

Retrieve all categories and subcategories.

GEThttps://api.digitalriver.com/v1/shoppers/me/categories

Query parameters

Response

200400401

Successful response.

Body

application/json

one of

DefaultCategories (object)ExpandedCategories (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/categories', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

{
  "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

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

GEThttps://api.digitalriver.com/v1/shoppers/me/categories/{categoryId}

Path parameters

categoryId*string

Catogory ID.

Query parameters

Response

200400401

Successful response.

Body

application/json

one of

DefaultCategory (object)ExpandedCategory (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/categories/{categoryId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

{
  "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"
  },
  "categories": {
    "category": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/categories/6912300",
        "relation": "https://developers.digitalriver.com/v1/shoppers/CategoriesResource",
        "displayName": "Fitness",
        "products": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/categories/6912300/products"
        }
      }
    ]
  }
}

Get all categories for a specific product

Get all categories for a specific product by specifying the {productId} URI path parameter. This method returns all categories associated with the product identifier.

GEThttps://api.digitalriver.com/v1/shoppers/me/products/{productId}/categories

Path parameters

productId*string

Provide the product identifier.

Query parameters

Response

200400401

Successful response.

Body

application/json

one of

DefaultCategories (object)ExpandedProductCategories (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/products/{productId}/categories', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

{
  "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"
      }
    }
  ]
}