Products

Get volume pricing 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 for the pricing information returned for a product. The currency query parameter takes precedence over locale.

localestringOptional

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

Responses
200
Successful response.
application/json
get
GET /v1/shoppers/me/products/{productId}/pricing/volume-pricing HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "volumePricing": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/73248500/pricing/volume-pricing",
    "tier": [
      {
        "from": 1,
        "to": 1,
        "pricing": {
          "listPrice": {
            "currency": "USD",
            "value": "19.99"
          },
          "listPriceWithQuantity": {
            "currency": "USD",
            "value": "19.99"
          },
          "salePriceWithQuantity": {
            "currency": "USD",
            "value": "19.99"
          },
          "formattedListPrice": "$8.00",
          "formattedListPriceWithQuantity": "$8.00",
          "formattedSalePriceWithQuantity": "$8.00",
          "totalDiscountWithQuantity": {
            "currency": "USD",
            "value": "19.99"
          },
          "formattedTotalDiscountWithQuantity": "$0.00",
          "discountDescription": "text",
          "feePricing": {
            "salePriceWithFeesAndQuantity": {
              "currency": "USD",
              "value": "19.99"
            },
            "formattedSalePriceWithFeesAndQuantity": "$8.00"
          },
          "listPriceIncludesTax": "false",
          "msrpPrice": {
            "currency": "USD",
            "value": "19.99"
          },
          "formattedMsrpPrice": "text"
        }
      }
    ],
    "formattedSalesPriceRange": "$5.00-$8.00"
  }
}

Retrieve all products from the catalog

get
Query parameters
apiKeystringOptional

Provide your client identifier.

tokenstringOptional

Provide the authorized or anonymous token for a shopper.

externalReferenceIdstringOptional

Provide the external reference identifier for your product. The externalReferenceId is your company's internal identifier or stock keeping unit (SKU) for a product.

productIdstringOptional

Provide a comma-separated list of one or more product identifiers to include in the response. This parameter is required if the inventory status is requested to be included in the response.

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 for the pricing information returned for a product. The currency query parameter takes precedence over locale.

localestringOptional

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

companyIdstringOptional

Provide the identifier for the company that owns the product. If you do not provide the companyId, the call will use the default company associated with the API key.

pageNumberstringOptional

Specify the page to display from the result pages.

pageSizestringOptional

Specify the maximum number of items to include in each page.

sortstringOptional

You can sort the list of products returned by specifying one or more sort fields and their respective sort direction (asc or desc). To do this, use a comma-delimited list of sort fields in the format of {fieldname}-{sort_direction}. For instance, displayName-asc,listPrice-desc.

Responses
200
Successful response.
application/json
Responseone of
or
get
GET /v1/shoppers/me/products HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "products": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/products",
    "nextPage": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products?pageNumber=11&pageSize=1"
    },
    "previousPage": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products?pageNumber=9&pageSize=1"
    },
    "product": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/products/73248400",
        "displayName": "Class VI",
        "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft3/images/product/thumbnail/classVIThumb.jpg",
        "pricing": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/73248400/pricing",
          "formattedListPrice": "$79.99",
          "formattedSalePriceWithQuantity": "$79.99"
        },
        "addProductToCart": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=73248400",
          "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=73248400"
        },
        "purchaseProduct": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/purchase"
        },
        "variations": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358200/variations"
        }
      }
    ],
    "totalResults": 11,
    "totalResultPages": 11
  }
}

Get a product by ID

get
Path parameters
productIdstringRequired

PProvide 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 for the pricing information returned for a product. The currency query parameter takes precedence over locale.

localestringOptional

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

Responses
200
Successful response.
application/json
Responseone of
or
get
GET /v1/shoppers/me/products/{productId} HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "product": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500",
    "parentProduct": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358200"
    },
    "categories": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/categories"
    },
    "familyAttributes": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/family-attributes"
    },
    "id": 64578500,
    "name": "Class I",
    "displayName": "Class I",
    "shortDescription": "Class I is the perfect GPS waypoint and route manager for the beginning or occasional GPS user.",
    "longDescription": "Class I is the fast and easy way to create, edit, and transfer waypoints and routes between your computer and your Garmin, Magellan, or Lowrance GPS. Using Class I, you can manage all of your waypoints and routes, and display them in lists sorted by name, elevation, or distance. Class I connects your GPS to the best mapping and information sites on the Internet, giving you one-click access to street and topo maps, aerial photos, weather forecasts, and nearby attractions.",
    "productType": "DOWNLOAD",
    "sku": "Class I",
    "externalReferenceId": "Test External Reference Number",
    "companyId": "demosft1",
    "displayableProduct": "true",
    "purchasable": "true",
    "manufacturerName": "Test Manufacturer Name",
    "manufacturerPartNumber": "Test Manufacturer Part Number",
    "minimumQuantity": "text",
    "maximumQuantity": "text",
    "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/classIThumb.jpg",
    "productImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/detail/classIBox.jpg",
    "keywords": "testKeyword",
    "baseProduct": "false",
    "variationAttributes": {
      "attribute": [
        {
          "name": "productType",
          "displayName": "text",
          "domainValues": [
            "PHYSICAL"
          ]
        }
      ]
    },
    "pricing": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/pricing",
      "listPrice": {
        "currency": "USD",
        "value": "19.99"
      },
      "salePriceWithQuantity": {
        "currency": "USD",
        "value": "19.99"
      },
      "formattedListPrice": "$19.99",
      "formattedSalePriceWithQuantity": "$17.99",
      "msrpPrice": {
        "currency": "USD",
        "value": "19.99"
      },
      "formattedMsrpPrice": "$2.00",
      "listPriceIncludesTax": "false",
      "formattedCommitmentPrice": "$240.00",
      "commitmentPrice": {
        "currency": "USD",
        "value": "240.00"
      }
    },
    "addProductToCart": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=64578500",
      "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=64578500"
    },
    "purchaseProduct": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/purchase"
    },
    "transferProduct": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/18977555",
      "displayName": "Transfer Product",
      "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/newImage.jpg",
      "addProductToCart": {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=18977555",
        "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=18977555"
      }
    },
    "variations": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358200/variations",
      "product": [
        {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500",
          "displayName": "Class I",
          "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/classIThumb.jpg",
          "pricing": {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/pricing",
            "listPriceWithQuantity": {
              "currency": "USD",
              "value": "19.99"
            },
            "salePriceWithQuantity": {
              "currency": "USD",
              "value": "19.99"
            },
            "formattedListPrice": "$19.99",
            "formattedSalePriceWithQuantity": "$17.99",
            "listPriceIncludesTax": "false",
            "msrpPrice": {
              "currency": "USD",
              "value": "19.99"
            },
            "formattedMsrpPrice": "$2.00"
          },
          "addProductToCart": {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=64578500",
            "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=64578500"
          },
          "purchaseProduct": {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/purchase"
          }
        }
      ]
    },
    "components": {
      "product": {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500",
        "parentProduct": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358200"
        },
        "categories": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/categories"
        },
        "familyAttributes": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/family-attributes"
        },
        "id": 64578500,
        "name": "Class I",
        "displayName": "Class I",
        "shortDescription": "Class I is the perfect GPS waypoint and route manager for the beginning or occasional GPS user.",
        "longDescription": "Class I is the fast and easy way to create, edit, and transfer waypoints and routes between your computer and your Garmin, Magellan, or Lowrance GPS. Using Class I, you can manage all of your waypoints and routes, and display them in lists sorted by name, elevation, or distance. Class I connects your GPS to the best mapping and information sites on the Internet, giving you one-click access to street and topo maps, aerial photos, weather forecasts, and nearby attractions.",
        "productType": "DOWNLOAD",
        "sku": "Class I",
        "externalReferenceId": "Test External Reference Number",
        "companyId": "demosft1",
        "displayableProduct": "true",
        "purchasable": "true",
        "manufacturerName": "Test Manufacturer Name",
        "manufacturerPartNumber": "Test Manufacturer Part Number",
        "minimumQuantity": "text",
        "maximumQuantity": "text",
        "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/classIThumb.jpg",
        "productImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/detail/classIBox.jpg",
        "keywords": "testKeyword",
        "baseProduct": "false",
        "variationAttributes": {
          "attribute": [
            {
              "name": "productType",
              "displayName": "text",
              "domainValues": [
                "PHYSICAL"
              ]
            }
          ]
        },
        "pricing": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/pricing",
          "listPrice": {
            "currency": "USD",
            "value": "19.99"
          },
          "salePriceWithQuantity": {
            "currency": "USD",
            "value": "19.99"
          },
          "formattedListPrice": "$19.99",
          "formattedSalePriceWithQuantity": "$17.99",
          "msrpPrice": {
            "currency": "USD",
            "value": "19.99"
          },
          "formattedMsrpPrice": "$2.00",
          "listPriceIncludesTax": "false",
          "formattedCommitmentPrice": "$240.00",
          "commitmentPrice": {
            "currency": "USD",
            "value": "240.00"
          }
        },
        "addProductToCart": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=64578500",
          "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=64578500"
        },
        "purchaseProduct": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/purchase"
        },
        "transferProduct": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/18977555",
          "displayName": "Transfer Product",
          "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/newImage.jpg",
          "addProductToCart": {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=18977555",
            "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=18977555"
          }
        },
        "variations": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358200/variations",
          "product": [
            {
              "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500",
              "displayName": "Class I",
              "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/classIThumb.jpg",
              "pricing": {
                "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/pricing",
                "listPriceWithQuantity": {
                  "currency": "USD",
                  "value": "19.99"
                },
                "salePriceWithQuantity": {
                  "currency": "USD",
                  "value": "19.99"
                },
                "formattedListPrice": "$19.99",
                "formattedSalePriceWithQuantity": "$17.99",
                "listPriceIncludesTax": "false",
                "msrpPrice": {
                  "currency": "USD",
                  "value": "19.99"
                },
                "formattedMsrpPrice": "$2.00"
              },
              "addProductToCart": {
                "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=64578500",
                "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=64578500"
              },
              "purchaseProduct": {
                "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/purchase"
              }
            }
          ]
        },
        "recurringSubscriptionInfo": {
          "autorenewal": "false",
          "termUnit": "Week",
          "termLength": "1"
        }
      }
    }
  }
}

Retrieve all products for a specified category

get

To retrieve all products for a specified category, specify the category's ID in the {id} URI path parameter. The default setting is to display only the base products in the order of their rank.

Path parameters
categoryIdstringRequired

Category 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 for the pricing information returned for a product. The currency query parameter takes precedence over locale.

localestringOptional

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

companyIdstringOptional

Provide the identifier for the company that owns the product. If you do not provide the companyId, the call will use the default company associated with the API key.

pageNumberstringOptional

Specify the page to display from the result pages.

pageSizestringOptional

Specify the maximum number of items to include in each page.

productsPageSizestringOptional

Specify the maximum number of products to include for each category returned in a paginated response. Must be a positive integer greater than zero and less than 100000. Default is 10.

sortstringOptional

You can sort the list of products returned by specifying one or more sort fields and their respective sort direction (asc or desc). To do this, use a comma-delimited list of sort fields in the format of {fieldname}-{sort_direction}. For instance, displayName-asc,listPrice-desc.

Responses
200
Successful response.
application/json
Responseone of
or
get
GET /v1/shoppers/me/categories/{categoryId}/products HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "products": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/products",
    "nextPage": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products?pageNumber=11&pageSize=1"
    },
    "previousPage": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products?pageNumber=9&pageSize=1"
    },
    "product": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358200",
        "displayName": "Class I",
        "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/classIThumb_v2.jpg",
        "pricing": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358200/pricing",
          "formattedListPrice": "$19.99",
          "formattedSalePriceWithQuantity": "$18.99"
        },
        "addProductToCart": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=73248400",
          "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=73248400"
        },
        "purchaseProduct": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64578500/purchase"
        },
        "variations": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358200/variations"
        }
      }
    ],
    "totalResults": 1,
    "totalResultPages": 1
  }
}

Last updated