LogoLogo
System Status
  • Commerce API
    • Test and use cases
    • Roles and permissions
    • Sending API calls
  • Shopper APIs
    • Shopper basics
      • Common use cases
        • Creating a customer
        • Applying store credit
        • Private store workflow
        • Guest checkout
    • OAuth
      • Authentication
      • OAuth 2.0 APIs
      • Token
      • Access tokens
      • Session-aware access tokens
      • Authorizing a shopper
    • Shoppers
      • Managing shoppers
        • User management
        • Single sign-on (SSO)
        • Data validation
        • Bulk user management
        • Bulk user account export
      • Managing a shopper's account
      • Managing a shopper's address
      • Managing payment options
    • Product discovery
      • Categories
      • Products
      • Product variations
      • Pricing
      • Inventory status
      • Financing
      • Offers
        • Understanding offers
        • How to use point of promotions (POPs)
          • Retrieving all point of promotion offers for a specific product
          • Retrieving all offers for a specific point of promotion
        • How to use offers
      • Private stores
        • Managing private stores
        • Submitting an order for a private store
        • Useful APIs
      • Fulfillment
        • Electronic Fulfillment Service (OFI)
        • Digital rights
        • Digital rights revocation
        • Physical fulfillment
          • EDI X12 832 definition data elements
          • EDI X12 846 definition data elements
          • EDI X12 850 definition data elements
          • EDI X12 855 definition data elements
          • EDI X12 856 definition data elements
          • EDI X12 180-1 definition data elements
          • EDI X12 180-2 definition of data elements
          • EDI X12 180-3 definition of data elements
    • Cart
      • Applying a shopper to a cart
      • Getting the current cart
      • Creating or updating a cart
        • Adding a product to a cart
          • Gifting
        • Capturing the customer's IP address
        • Providing address information
        • Managing the shipping or billing address
        • Providing subscription information
        • Managing payment methods
        • Capturing the Terms of Sale (TOS) acceptance
      • Managing offers in a cart
        • Applying an offer
        • Applying a coupon or promo code
        • Getting all applied offers
        • Removing an applied offer
        • Removing eligible offers
        • Reconciling conflicting offers
        • Dynamic offers/personalization
          • Skipping Global Commerce merchandising offer arbitration
          • Triggering a promotional URL offer
          • Overriding a promotional URL offer discount
      • Pricing
        • Landed cost
          • Mixed cart support
          • Tax-included pretty price
      • Redirecting to a Digital River-hosted cart
      • Configuring taxes
        • Managing tax identifiers
      • Managing shipping options
        • Getting shipping options
        • Providing a shipping discount
      • Managing line items
      • Applying a price override
      • Managing payment sessions
      • Managing web checkout
      • Submitting a cart
        • Initiating a charge
        • Authorization declines
      • Resuming cart submission
      • HGOP2
    • Orders
      • Getting orders
      • Selling entities
      • Retrieving addresses from an order
      • Retrieving line items from an order
      • Order lookup
      • Returns
        • Initiate an authenticated session
        • Setting up returns in Global Commerce
        • Managing returns
    • Subscriptions
      • Retrieve the subscription
        • Getting all orders for a subscription
        • Getting a subscription's pending actions
        • Getting all subscriptions for a shopper
        • Getting a subscription by identifier
      • Update subscription at the next renewal
        • Changing the subscription renewal type
        • Changing the subscription renewal quantity
        • Adding or updating a perpetual unit price
        • Changing the subscription's payment option
        • Changing the subscription's payment source
      • Immediately change the subscription
        • Updating the subscription's shipping address
        • Updating a subscription's billing and shipping email address
        • Cancelling a subscription
      • Immediately apply a midterm subscription change
        • Reducing the subscription renewal quantity
  • Admin APIs
    • Admin basics
      • Available Admin API calls
    • Order management
      • Getting the order's details
      • Downloading the invoice
    • Offer management
    • Refund management
      • Authorization
      • Refund reason codes
      • Creating a satisfaction refund
      • Getting the available refunds for a specific order
      • Getting refunds for a specific order
      • Getting refunds available for a shopper's order
      • Getting the JSON schema for an order refund
      • Managing a refund for a delayed payment method
      • Refund error scenarios
    • Subscription management
      • Retrieve the subscription
        • Getting all orders for a subscription
        • Getting a subscription's pending actions
        • Getting all subscriptions for a shopper
        • Getting a subscription by identifier
      • Update the subscription at the next renewal
        • Changing the subscription renewal type
        • Changing the subscription renewal product
        • Changing the subscription renewal price
        • Changing the subscription renewal quantity
        • Adding or updating a perpetual unit price
        • Changing the subscription's payment option
        • Changing the subscription's payment source
      • Immediately change the subscription
        • Activating a subscription
        • Changing the subscription's external reference identifier
        • Updating a subscription's billing and shipping email address
        • Cancelling a subscription
        • Updating the subscription's expiration date
      • Immediately apply a midterm subscription change
        • Applying a midterm change with price override
        • Reducing the subscription renewal quantity
      • Subscription notifications
        • Updating the subscriber's email address
        • Card Account Updater
        • Sending a payment information change notification
        • Sending an expired credit card notification
        • Sending an invalid payment account notification
        • Sending a payment failure notification
        • Sending a subscription renewal reminder notification
        • Setting up subscription renewal reminders
        • Setting up trial subscription renewal reminders
        • Setting up marketing reminders
      • Using the Expired Card Optimizer
    • Customer management
      • Retrieving customer details
      • Requesting PII removal for a customer
    • Site management
      • Configuring authorized shipping and billing countries
      • Getting a site's authorized billing countries
      • Getting a site's authorized shipping countries
    • Product management
      • Getting started
      • Manage products (asynchronous API)
        • Creating or updating a product
        • Adding or updating a product variation
        • Deploying a product
        • Applying live changes
        • Retiring a product
        • Deleting a product variation
        • Deleting a base or individual product's locale
      • Retrieve products (synchronous API)
        • Getting a product by locale
        • Getting a product variation
        • Getting a product variation by locale
      • Get the task status for a product (synchronous API)
        • Getting the latest information on a product task
        • Retrieving the tasks for a specific product
        • Retrieving the tasks for products
      • Bulk operation
        • Asynchronous bulk operations
          • Creating products in bulk
          • Updating products in bulk
          • Deploying products in bulk
          • Deleting product variations in bulk
        • Bulk product upload (BPU)
        • Bulk Product Export (BPE)
          • Line-item level satisfaction refund
          • Order-level satisfaction refund
          • Auto-created line-item level return product
          • Line-item level return product
    • File management
      • Downloading a file
  • Payments
    • Payments solutions
      • Drop-in payments
        • How Drop-in payments work
        • Drop-in payments integration guide
      • DigitalRiver.js with Elements
        • Elements integration guide
        • Configuring payment methods
          • Configuring Afterpay
          • Configuring Alipay+ (cross-border)
          • Configuring Alipay (domestic)
          • Configuring Amazon Pay
          • Configuring Apple Pay
          • Configuring Bancontact
          • Configuring BLIK
          • Configuring Boleto
          • Configuring CCAvenue
          • Configuring Clearpay
          • Configuring Credit Cards
          • Configuring FPX Online Banking
          • Configuring Google Pay
          • Configuring iDEAL
          • Configuring Klarna
          • Configuring Konbini
          • Configuring Online Banking (IBP)
          • Configuring Online Banking (Korea Bank Transfer)
          • Configuring PayCo
          • Configuring PayPal
          • Configuring SEPA Direct Debit
          • Configuring Trustly
          • Configuring Wire Transfer
          • Common payment sources
          • Common payment objects
    • Supported payment methods
      • Afterpay
      • Alipay (domestic)
      • Alipay+ (cross-border)
      • Amazon Pay
      • Apple Pay
      • Bancontact
      • BLIK
      • Boleto
      • CCAvenue
      • Clearpay
      • Credit Cards
      • FPX Online Banking
      • Google Pay
      • iDEAL
      • Klarna
      • Konbini
      • Korea Bank Transfer (Online Banking)
      • Online Banking (IBP)
      • PayCo
      • PayPal
      • PayPal Billing Agreement
      • PayPal Credit
      • PayPal Pay in 3
      • PayPal Pay in 4
      • PayPal RatenZahlung (Installment Payment)
      • SEPA Direct Debit
      • Trustly
      • Wire Transfer
    • Source basics
      • Managing sources
      • Handling credit card sources
      • Retrieving sources
    • Building payment workflows
      • Flows by payment type
      • Handling redirect payment methods
    • PSD2 and SCA
    • Payment testing scenarios
      • Testing standard payment methods
      • Testing redirect payment methods
      • Testing receiver payment methods
      • Testing the CCAvenue payment method
  • Events
    • Events overview
    • Responding to events
    • Event types
      • Delayed payment event types
        • Delayed payment expired event
          • Boleto
          • Konbini
          • Wire Transfer
        • Delayed payment reminder event
          • Boleto
          • Konbini
          • Wire Transfer
      • Subscription event types
        • Subscription created event
        • Subscription updated event
        • Subscription action processed event
        • Subscription cancelled event
        • Subscription credit card expired event
        • Subscription payment information changed event
        • Subscription renewal reminder event
        • Subscription renewed event
        • Subscription trial converted event
        • Subscription trial renewal reminder event
        • Subscription payment failed event
      • Post-order event types
        • Invoice created event
        • Refund credit memo event
      • Inventory event types
        • Inventory out of stock event
        • Inventory source and management
        • Inventory self-managed updated event
        • Inventory fulfiller-managed updated event
      • Post-order Notification Integration Guide
    • Webhooks
      • Commerce API safelist
      • Searching for a webhook
      • Creating a webhook
      • Using webhooks
      • Editing a webhook
      • Turning webhooks on or off
      • Revealing a webhook's secret
      • Rotating a webhook's secret
      • Viewing the webhook details
      • Deleting a webhook
  • Developer Resources
    • Postman collection
    • Commerce API references
    • Shopper APIs reference
    • Admin APIs reference
    • DigitalRiver.js reference
      • Including DigitalRiver.js
      • Initializing DigitalRiver.js
      • DigitalRiver object
      • Elements
        • Amazon Pay element
        • Apple Pay elements
        • Google Pay elements
        • IBAN element
        • iDEAL element
        • Konbini elements
        • Compliance element
        • Offline refund element
        • Online Banking elements
        • Tax Identifier element
        • Delayed payment instructions element
        • PayPal elements
      • Guidelines for capturing payment details
      • Security
      • Digital River payment objects
      • Error types, codes, and objects
  • General resources
    • Global Commerce
    • Global Commerce
      • Company hierarchy
      • Categories
        • Getting a list of categories
      • Products
        • Product scenarios
        • Individual products
          • Creating an individual product
        • Base product with variants
          • Creating a base product with variants
        • Bundle offers
          • Creating a prorated bundle offer with a subscription
        • Product combination
          • Creating a product combination
        • Gifting
        • Inventory status
      • Customer service
        • Log a shopper's request to remove PII
      • Customers
        • Creating a customer
        • Digital River-maintained customer login
        • Client-maintained customer login
      • Transparent Commerce purchase flow
    • eCompass
    • eCompass documentation
    • Release notes
      • 2024
      • 2024 latest
      • 2023
      • 2022
      • 2021
      • 2020
Powered by GitBook
On this page
  • Getting a product by identifier
  • Getting volume pricing for a specific product
  • Getting all products from the product catalog
  • Getting all products for a specified category
  • Getting a base product, individual product, or product combination
  • Getting the deployed or retired versions of a product
  • Version

Was this helpful?

  1. Shopper APIs
  2. Product discovery

Products

Learn how to retrieve product information.

PreviousCategoriesNextProduct variations

Last updated 2 months ago

Was this helpful?

In the world of eCommerce, products are the foundation of your inventory. Each product represents an item available for purchase and includes a comprehensive set of attributes that define its characteristics, pricing, and availability. This section will cover various aspects of product management within the Commerce API, including how to effectively retrieve, list, and handle products to streamline your eCommerce operations.

Getting a product by identifier

When integrating with the Commerce API, retrieving product information efficiently is essential. One of the fundamental tasks is obtaining a product by its unique identifier. This section will guide you through fetching detailed product data. By following these instructions, you can ensure access to all necessary product attributes, enabling seamless eCommerce operations.

To get a product by its identifier, send a request. This request retrieves detailed information about the specified product. Replace {Your_Access_Token} and {productId} with your actual values.

curl --location --request GET 'https://api.digitalriver.com/v1/shoppers/me/products/{productId}' \
--header 'authorization: bearer {Your_Access_token}\
...
{
    "product": {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/products/8027217700",
        "relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource",
        "categories": {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/8027217700/categories",
            "relation": "https://api.digitalriver.com/v1/shoppers/CategoriesResource"
        },
        "familyAttributes": {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/8027217700/family-attributes",
            "relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
        },
        "id": 8027217700,
        "name": "Combination Product",
        "displayName": "Combination Product",
        "shortDescription": null,
        "longDescription": null,
        "productType": "OTHER",
        "sku": "Combination Product",
        "externalReferenceId": null,
        "companyId": "paytest",
        "displayableProduct": "true",
        "purchasable": "true",
        "manufacturerName": null,
        "manufacturerPartNumber": "1234567890",
        "minimumQuantity": null,
        "maximumQuantity": null,
        "thumbnailImage": null,
        "productImage": null,
        "keywords": null,
        "baseProduct": "false",
        "pricing": {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/8027217700/pricing",
            "listPrice": {
                "currency": "USD",
                "value": 45
            },
            "salePriceWithQuantity": {
                "currency": "USD",
                "value": 36
            },
            "formattedListPrice": "$45.00",
            "formattedSalePriceWithQuantity": "$36.00",
            "listPriceIncludesTax": "false",
            "msrpPrice": null,
            "formattedMsrpPrice": null
        },
        "addProductToCart": {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=8027217700",
            "relation": "https://api.digitalriver.com/v1/shoppers/LineItemsResource",
            "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=8027217700"
        },
        "components": [
            {
                "product": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/257734900",
                    "relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
                },
                "categories": {
                    "uri": "https://api.digitalriver.com/api/v1/shoppers/me/products/257734900/categories",
                    "relation": "https://api.digitalriver.com/v1/shoppers/CategoriesResource"
                },
                "familyAttributes": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/257734900/family-attributes",
                    "relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
                },
                "id": 257734900,
                "name": "Free trial product",
                "displayName": "Free trial product",
                "shortDescription": null,
                "longDescription": null,
                "productType": "DOWNLOAD",
                "sku": "asdf",
                "externalReferenceId": null,
                "companyId": "paytest",
                "displayableProduct": "true",
                "purchasable": "true",
                "manufacturerName": null,
                "manufacturerPartNumber": "asdf",
                "minimumQuantity": null,
                "maximumQuantity": null,
                "thumbnailImage": null,
                "productImage": null,
                "keywords": null,
                "baseProduct": "false",
                "pricing": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/257734900/pricing",
                    "listPrice": {
                        "currency": "USD",
                        "value": 9
                    },
                    "salePriceWithQuantity": {
                        "currency": "USD",
                        "value": 0
                    },
                    "formattedListPrice": "$9.00",
                    "formattedSalePriceWithQuantity": "$0.00",
                    "listPriceIncludesTax": "false",
                    "msrpPrice": null,
                    "formattedMsrpPrice": null
                },
                "addProductToCart": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=257734900",
                    "relation": "https://api.digitalriver.com/v1/shoppers/LineItemsResource",
                    "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=257734900"
                },
                "recurringSubscriptionInfo": {
                    "autoRenewal": "true",
                    "termUnit": "WEEK",
                    "termLength": "1"
                }
            },
            {
                "product": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/5505627700",
                    "relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
                },
                "categories": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/5505627700/categories",
                    "relation": "https://api.digitalriver.com/v1/shoppers/CategoriesResource"
                },
                "familyAttributes": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/5505627700/family-attributes",
                    "relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
                },
                "id": 5505627700,
                "name": "AK123_Physical",
                "displayName": "AK123_Physical",
                "shortDescription": null,
                "longDescription": null,
                "productType": "PHYSICAL",
                "sku": "AK123_Physical",
                "externalReferenceId": null,
                "companyId": "paytest",
                "displayableProduct": "true",
                "purchasable": "true",
                "manufacturerName": null,
                "manufacturerPartNumber": "MSTS321",
                "minimumQuantity": null,
                "maximumQuantity": null,
                "thumbnailImage": null,
                "productImage": null,
                "keywords": null,
                "baseProduct": "false",
                "pricing": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/5505627700/pricing",
                    "listPrice": {
                        "currency": "USD",
                        "value": 17
                    },
                    "salePriceWithQuantity": {
                        "currency": "USD",
                        "value": 17
                    },
                    "formattedListPrice": "$17.00",
                    "formattedSalePriceWithQuantity": "$17.00",
                    "listPriceIncludesTax": "false",
                    "msrpPrice": null,
                    "formattedMsrpPrice": null
                },
                "addProductToCart": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=5505627700",
                    "relation": "https://api.digitalriver.com/v1/shoppers/LineItemsResource",
                    "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=5505627700"
                }
            },
            {
                "product": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/6686217700",
                    "relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
                },
                "categories": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/6686217700/categories",
                    "relation": "https://api.digitalriver.comm/v1/shoppers/CategoriesResource"
                },
                "familyAttributes": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/6686217700/family-attributes",
                    "relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
                },
                "id": 6686217700,
                "name": "Auto_Monthly_Sub",
                "displayName": "Auto_Monthly_Sub",
                "shortDescription": null,
                "longDescription": null,
                "productType": "DOWNLOAD",
                "sku": "Auto_Monthly_Sub",
                "externalReferenceId": null,
                "companyId": "paytest",
                "displayableProduct": "true",
                "purchasable": "true",
                "manufacturerName": null,
                "manufacturerPartNumber": "12345678",
                "minimumQuantity": null,
                "maximumQuantity": null,
                "thumbnailImage": null,
                "productImage": null,
                "keywords": null,
                "baseProduct": "false",
                "pricing": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/6686217700/pricing",
                    "listPrice": {
                        "currency": "USD",
                        "value": 19
                    },
                    "salePriceWithQuantity": {
                        "currency": "USD",
                        "value": 19
                    },
                    "formattedListPrice": "$19.00",
                    "formattedSalePriceWithQuantity": "$19.00",
                    "listPriceIncludesTax": "false",
                    "msrpPrice": null,
                    "formattedMsrpPrice": null
                },
                "addProductToCart": {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=6686217700",
                    "relation": "https://api.digitalriver.com/v1/shoppers/LineItemsResource",
                    "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=6686217700"
                },
                "recurringSubscriptionInfo": {
                    "autoRenewal": "true",
                    "termUnit": "MONTH",
                    "termLength": "1"
                }
            }
        ]
    }
}

A 200 OK response indicates that the request was successful, and the server returned the requested data. Your GET request to fetch the product information was processed correctly, and you received the relevant product details in the response body.

Getting volume pricing for a specific product

Understanding volume pricing is crucial for optimizing sales and offering customers attractive discounts when managing eCommerce pricing. The Commerce API allows you to retrieve tailored volume pricing for specific products. This section will guide you through fetching volume pricing details. By following these instructions, you can efficiently access and display volume-based pricing information, enhancing your product offerings and promotional strategies.

To get volume pricing for a specific product, send a request. Replace {Your_Access_Token} and {productId} with your actual values.

curl --location --request GET 'https://api.digitalriver.com/v1/shoppers/me/products/{productId}/pricing/volume-pricing' \
--header 'authorization: bearer {Your_Access_token}'
{
  "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": "string",
          "feePricing": {
            "salePriceWithFeesAndQuantity": {
              "currency": "USD",
              "value": "19.99"
            },
            "formattedSalePriceWithFeesAndQuantity": "$8.00"
          },
          "listPriceIncludesTax": "false",
          "msrpPrice": {
            "currency": "USD",
            "value": "19.99"
          },
          "formattedMsrpPrice": "string"
        }
      }
    ],
    "formattedSalesPriceRange": "$5.00-$8.00"
  }
}

A 200 OK response means the request was successful, and the server returned the requested data. Your GET request to retrieve the volume pricing information for a specific product was processed correctly, and you received the relevant volume pricing details in the response body.

Getting all products from the product catalog

Retrieving the complete product catalog lets you offer your customers a comprehensive view of all available products. This can enhance the shopping experience by ensuring shoppers can access your store's products. The following instructions will guide you through fetching all products from your product catalog using the Commerce API.

curl --location --request GET 'https://api.digitalriver.com/v1/shoppers/me/products' \
--header 'authorization: bearer {Your_Access_token}'
{
  "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"
        }
      }
    ],
    "totalResults": 11,
    "totalResultPages": 11
  }
}

A 200 OK response indicates that the request was successful and returns the product catalog information in the response body.

Getting all products for a specified category

You may often need to retrieve all products within a specific category to enhance user experience and streamline product searches. The following instructions will guide you through fetching all products for a specified category using the Commerce API. This ensures that customers can easily discover and explore products that meet their needs.

curl --location --request GET 'https://api.digitalriver.com/v1/shoppers/me/categories/{categoryId}/products' \
--header 'authorization: bearer {Your_Access_token}\
...
{
  "products": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/products",
    "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"
        },
        "variations": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358200/variations"
        }
      }
    ],
    "totalResults": 1,
    "totalResultPages": 1
  }
}

A 200 OK response indicates that the request was successful and returns the product category information in the response body.

Getting a base product, individual product, or product combination

The following example gets a specific base or individual product with a productId.

curl --location --request GET 'https://api.digitalriver.com/v1/products/{productId}' \
--header 'Authorization: Basic {your_API_key}' \
...

An ERID request requires the x-erid-as-pid=true header.

curl --location --request GET 'https://api.digitalriver.com/v1/products/{ERID}' \
--header 'Authorization: Basic {your_API_key}' \
--header 'header x-erid-as-pid=true' \
...
[
  {
    "productType": "BASE",
    "companyId": "digitalriver",
    "siteIds": [
      "domoSite1",
      "domoSite2"
    ],
    "id": 1234567800,
    "state": "Deployed",
    "locked": false,
    "version": 1,
    "deploymentRequiredChanges": {
      "fulfillmentTypes": [
        "Download"
      ],
      "otherFulfillmentIntegration": {
        "fulfillerIds": [
          "digitalRiver"
        ]
      },
      "transferProduct": 2234567800,
      "upgradeProducts": [
        3234567800
      ],
      "downgradeProducts": [
        4234567800
      ]
    },
    "liveChanges": {
      "externalReferenceId": "sku-1234-5678-xyz",
      "catalogs": [
        {
          "catalogId": 123456000,
          "catalogName": "a catalog",
          "categories": [
            {
              "categoryId": 19000000,
              "categoryName": "a category"
            }
          ],
          "prices": [
            {
              "type": "listPrice",
              "priceListName": "Unit Price",
              "taxInclusive": true,
              "prices": [
                {
                  "currency": "USD",
                  "locale": "en_US",
                  "configuredPrice": 15.99,
                  "calculatedPrice": 0
                }
              ]
            }
          ]
        }
      ]
    },
    "localizations": [
      {
        "locale": "en_US",
        "isDefault": true,
        "groups": [
          {
            "groupId": 11000,
            "groupName": "Storefront Settings",
            "attributes": {
              "property1": "string",
              "property2": "string"
            }
          }
        ]
      }
    ]
  }
]
[
    {
        "productType": "INDIVIDUAL",
        "companyId": "acme",
        "siteIds": [
            "acme"
        ],
        "id": "51954990080",
        "state": "DESIGN",
        "locked": false,
        "version": 1,
        "deploymentRequiredChanges": {
            "fulfillmentTypes": [],
            "otherFulfillmentIntegration": {
                "fulfillerIds": []
            },
            "upgradeProducts": [],
            "downgradeProducts": []
        },
        "liveChanges": {
            "externalReferenceId": "external-reference-id-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
            "catalogs": [
                {
                    "catalogId": "4783669800",
                    "catalogName": "acme",
                    "categories": [],
                    "pricing": [
                        {
                            "type": "listPrice",
                            "priceListName": "acme",
                            "taxInclusive": false,
                            "prices": [
                                {
                                    "currency": "CAD",
                                    "locale": "en_CA"
                                },
                                {
                                    "currency": "CAD",
                                    "locale": "en_US"
                                },
                                {
                                    "currency": "USD",
                                    "locale": "en_US",
                                    "configuredPrice": 10.00
                                },
                                {
                                    "currency": "CAD",
                                    "locale": "fr_CA"
                                },
                                {
                                    "currency": "ARS"
                                },
                                {
                                    "currency": "AUD"
                                },
                                {
                                    "currency": "BRL"
                                },
                                {
                                    "currency": "CAD"
                                },
                                {
                                    "currency": "CHF"
                                },
                                {
                                    "currency": "CLP"
                                },
                                {
                                    "currency": "CNY"
                                },
                                {
                                    "currency": "COP"
                                },
                                {
                                    "currency": "CZK"
                                },
                                {
                                    "currency": "DKK"
                                },
                                {
                                    "currency": "EGP"
                                },
                                {
                                    "currency": "EUR"
                                },
                                {
                                    "currency": "GBP"
                                },
                                {
                                    "currency": "HKD"
                                },
                                {
                                    "currency": "HUF"
                                },
                                {
                                    "currency": "IDR"
                                },
                                {
                                    "currency": "ILS"
                                },
                                {
                                    "currency": "INR"
                                },
                                {
                                    "currency": "JPY"
                                },
                                {
                                    "currency": "KRW"
                                },
                                {
                                    "currency": "MXN"
                                },
                                {
                                    "currency": "MYR"
                                },
                                {
                                    "currency": "NOK"
                                },
                                {
                                    "currency": "NZD"
                                },
                                {
                                    "currency": "OMR"
                                },
                                {
                                    "currency": "PEN"
                                },
                                {
                                    "currency": "PLN"
                                },
                                {
                                    "currency": "RUB"
                                },
                                {
                                    "currency": "SEK"
                                },
                                {
                                    "currency": "SGD"
                                },
                                {
                                    "currency": "THB"
                                },
                                {
                                    "currency": "TRY"
                                },
                                {
                                    "currency": "TWD"
                                },
                                {
                                    "currency": "USD"
                                },
                                {
                                    "currency": "VEF"
                                },
                                {
                                    "currency": "ZAR"
                                }
                            ]
                        },
                        {
                            "type": "subscriptionRenewalPrice",
                            "priceListName": "Subscription Renewal Price list",
                            "taxInclusive": false,
                            "prices": [
                                {
                                    "currency": "ARS"
                                },
                                {
                                    "currency": "EUR"
                                },
                                {
                                    "currency": "GBP"
                                },
                                {
                                    "currency": "USD"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "localizations": [
            {
                "locale": "en_US",
                "isDefault": true,
                "groups": [
                    {
                        "groupId": "2",
                        "groupName": "Storefront Settings",
                        "attributes": {
                            "longDescription": "longDescription-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "nonSolr": true,
                            "keywords": "keywords-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "displayName": "demo-display-name-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "taxableUnspscCode": "43230000",
                            "confirmAddlInfo": "confirmAddlInfo-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "shortDescription": "shortDescription-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "isViewable": true,
                            "taxableProductCode": "4323.320_D",
                            "isOrderable": true,
                            "returnMethod": "LOD",
                            "emailAddlInfoText": "emailAddlInfoText-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "name": "demo-name-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "emailAddlInfo": "emailAddlInfo-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "minOrderQuantity": 0,
                            "privateStoreOnly": false,
                            "productReturnMethod": "ByAgentAndSelfService",
                            "sku": "demo-sku-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "maxOrderQuantity": 0
                        }
                    },
                    {
                        "groupId": "10",
                        "groupName": "Subscription",
                        "attributes": {
                            "freeExtension": "2_WEEK",
                            "timeIntervalForTrialReminderNotifications": [
                                "30",
                                "15",
                                "7",
                                "2"
                            ],
                            "gracePeriod": "1_WEEK",
                            "timeIntervalForUpgradeReminderNotificationsPostCreation": [
                                "7",
                                "15",
                                "30",
                                "90"
                            ],
                            "timeIntervalForReminderNotifications": [
                                "90",
                                "30",
                                "15",
                                "7"
                            ],
                            "suppressOFIInQuantityIncrease": false,
                            "suppressDRMInUpgradeDowngrade": false,
                            "suppressOFIInUpgradeDowngrade": false,
                            "suppressDRMInQuantityIncrease": false,
                            "timeIntervalForReminderNotificationsPostExpiration": [
                                "7",
                                "15",
                                "30",
                                "90"
                            ],
                            "autoRenewalDateBasis": "PurchaseDate",
                            "timeIntervalForUpgradeReminderNotificationsPreExpiration": [
                                "97",
                                "37",
                                "22",
                                "14"
                            ],
                            "isFreeTrial": true,
                            "combinedRenewalPeriod": 1,
                            "timeIntervalForCCExpirationReminderNotifications": [
                                "30",
                                "15",
                                "7"
                            ],
                            "duration": "TWO_MONTH",
                            "timeIntervalForManualReminderNotifications": [
                                "90",
                                "30",
                                "15",
                                "7"
                            ],
                            "isDistinctScheduleTurnedOn": false,
                            "isCombinedRenewal": true,
                            "suppressDRMInRenewal": false,
                            "paymentSchedule": "matchRecurrence",
                            "isAutomatic": true,
                            "numOfDaysPriorExpirationForRenewalPreFirst": 30,
                            "isChangeProductAsRenewal": false,
                            "freeTrialPeriod": 45,
                            "includeRenewalProductInUpgradeList": true,
                            "numOfDaysPriorExpirationForRenewal": 4,
                            "suppressOFIInTrialConversion": true,
                            "numOfDaysPriorExpirationForRenewalFirst": 15,
                            "timeIntervalForUpgradeReminderNotificationsPostExpiration": [
                                "97",
                                "37",
                                "22",
                                "14"
                            ],
                            "postExpirationBillingAttemptIntervalInDays": 7,
                            "suppressOFIInRenewal": true,
                            "suppressDRMInTrialConversion": false,
                            "trialPostExpirationBillingAttemptIntervalInDays": 7,
                            "trialGracePeriod": "1_MONTH",
                            "timeIntervalForTrialManualReminderNotifications": [
                                "30",
                                "15",
                                "7",
                                "2"
                            ]
                        }
                    },
                    {
                        "groupId": "16",
                        "groupName": "Export Controls",
                        "attributes": {
                            "manufactureCountry": "US",
                            "eccn": "3A992"
                        }
                    }
                ]
            }
        ]
    }
]

Getting the deployed or retired versions of a product

The Commerce API provides convenient query parameters to retrieve specific product versions, such as the deployed or retired versions. By specifying version=RETIRED or version=DEPLOYED you can access detailed information about these product states in your request URL. This functionality helps you effectively manage and review different product lifecycle stages. For ERID requests, ensure you include the x-erid-as-pid=true header for accurate retrieval.

The following example gets retired versions of a specific product with a productId.

curl --location --request GET 'https://api.digitalriver.com/v1/products/{productId}?version=RETIRED' \
--header 'Authorization: Basic {your_API_key}' \
...

An ERID request requires the x-erid-as-pid=true header.

curl --location --request GET 'https://api.digitalriver.com/v1/products/{ERID}?version=RETIRED' \
--header 'Authorization: Basic <{your_API_key}' \
--header 'header x-erid-as-pid=true' \
...
[
    {
        "productType": "INDIVIDUAL",
        "companyId": "acme",
        "siteIds": [
            "acme"
        ],
        "id": "51954990080",
        "state": "RETIRED",
        "locked": false,
        "version": 1,
        "deploymentRequiredChanges": {
            "fulfillmentTypes": [],
            "otherFulfillmentIntegration": {
                "fulfillerIds": []
            },
            "upgradeProducts": [],
            "downgradeProducts": []
        },
        "liveChanges": {
            "externalReferenceId": "external-reference-id-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
            "catalogs": [
                {
                    "catalogId": "4783669800",
                    "catalogName": "acme",
                    "categories": [],
                    "pricing": [
                        {
                            "type": "listPrice",
                            "priceListName": "acme",
                            "taxInclusive": false,
                            "prices": [
                                {
                                    "currency": "CAD",
                                    "locale": "en_CA"
                                },
                                {
                                    "currency": "CAD",
                                    "locale": "en_US"
                                },
                                {
                                    "currency": "USD",
                                    "locale": "en_US",
                                    "configuredPrice": 10.00
                                },
                                {
                                    "currency": "CAD",
                                    "locale": "fr_CA"
                                },
                                {
                                    "currency": "ARS"
                                },
                                {
                                    "currency": "AUD"
                                },
                                {
                                    "currency": "BRL"
                                },
                                {
                                    "currency": "CAD"
                                },
                                {
                                    "currency": "CHF"
                                },
                                {
                                    "currency": "CLP"
                                },
                                {
                                    "currency": "CNY"
                                },
                                {
                                    "currency": "COP"
                                },
                                {
                                    "currency": "CZK"
                                },
                                {
                                    "currency": "DKK"
                                },
                                {
                                    "currency": "EGP"
                                },
                                {
                                    "currency": "EUR"
                                },
                                {
                                    "currency": "GBP"
                                },
                                {
                                    "currency": "HKD"
                                },
                                {
                                    "currency": "HUF"
                                },
                                {
                                    "currency": "IDR"
                                },
                                {
                                    "currency": "ILS"
                                },
                                {
                                    "currency": "INR"
                                },
                                {
                                    "currency": "JPY"
                                },
                                {
                                    "currency": "KRW"
                                },
                                {
                                    "currency": "MXN"
                                },
                                {
                                    "currency": "MYR"
                                },
                                {
                                    "currency": "NOK"
                                },
                                {
                                    "currency": "NZD"
                                },
                                {
                                    "currency": "OMR"
                                },
                                {
                                    "currency": "PEN"
                                },
                                {
                                    "currency": "PLN"
                                },
                                {
                                    "currency": "RUB"
                                },
                                {
                                    "currency": "SEK"
                                },
                                {
                                    "currency": "SGD"
                                },
                                {
                                    "currency": "THB"
                                },
                                {
                                    "currency": "TRY"
                                },
                                {
                                    "currency": "TWD"
                                },
                                {
                                    "currency": "USD"
                                },
                                {
                                    "currency": "VEF"
                                },
                                {
                                    "currency": "ZAR"
                                }
                            ]
                        },
                        {
                            "type": "subscriptionRenewalPrice",
                            "priceListName": "Subscription Renewal Price list",
                            "taxInclusive": false,
                            "prices": [
                                {
                                    "currency": "ARS"
                                },
                                {
                                    "currency": "EUR"
                                },
                                {
                                    "currency": "GBP"
                                },
                                {
                                    "currency": "USD"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "localizations": [
            {
                "locale": "en_US",
                "isDefault": true,
                "groups": [
                    {
                        "groupId": "2",
                        "groupName": "Storefront Settings",
                        "attributes": {
                            "longDescription": "longDescription-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "nonSolr": true,
                            "keywords": "keywords-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "displayName": "demo-display-name-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "taxableUnspscCode": "43230000",
                            "confirmAddlInfo": "confirmAddlInfo-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "shortDescription": "shortDescription-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "isViewable": true,
                            "taxableProductCode": "4323.320_D",
                            "isOrderable": true,
                            "returnMethod": "LOD",
                            "emailAddlInfoText": "emailAddlInfoText-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "name": "demo-name-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "emailAddlInfo": "emailAddlInfo-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "minOrderQuantity": 0,
                            "privateStoreOnly": false,
                            "productReturnMethod": "ByAgentAndSelfService",
                            "sku": "demo-sku-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "maxOrderQuantity": 0
                        }
                    },
                    {
                        "groupId": "10",
                        "groupName": "Subscription",
                        "attributes": {
                            "freeExtension": "2_WEEK",
                            "timeIntervalForTrialReminderNotifications": [
                                "30",
                                "15",
                                "7",
                                "2"
                            ],
                            "gracePeriod": "1_WEEK",
                            "timeIntervalForUpgradeReminderNotificationsPostCreation": [
                                "7",
                                "15",
                                "30",
                                "90"
                            ],
                            "timeIntervalForReminderNotifications": [
                                "90",
                                "30",
                                "15",
                                "7"
                            ],
                            "suppressOFIInQuantityIncrease": false,
                            "suppressDRMInUpgradeDowngrade": false,
                            "suppressOFIInUpgradeDowngrade": false,
                            "suppressDRMInQuantityIncrease": false,
                            "timeIntervalForReminderNotificationsPostExpiration": [
                                "7",
                                "15",
                                "30",
                                "90"
                            ],
                            "autoRenewalDateBasis": "PurchaseDate",
                            "timeIntervalForUpgradeReminderNotificationsPreExpiration": [
                                "97",
                                "37",
                                "22",
                                "14"
                            ],
                            "isFreeTrial": true,
                            "combinedRenewalPeriod": 1,
                            "timeIntervalForCCExpirationReminderNotifications": [
                                "30",
                                "15",
                                "7"
                            ],
                            "duration": "TWO_MONTH",
                            "timeIntervalForManualReminderNotifications": [
                                "90",
                                "30",
                                "15",
                                "7"
                            ],
                            "isDistinctScheduleTurnedOn": false,
                            "isCombinedRenewal": true,
                            "suppressDRMInRenewal": false,
                            "paymentSchedule": "matchRecurrence",
                            "isAutomatic": true,
                            "numOfDaysPriorExpirationForRenewalPreFirst": 30,
                            "isChangeProductAsRenewal": false,
                            "freeTrialPeriod": 45,
                            "includeRenewalProductInUpgradeList": true,
                            "numOfDaysPriorExpirationForRenewal": 4,
                            "suppressOFIInTrialConversion": true,
                            "numOfDaysPriorExpirationForRenewalFirst": 15,
                            "timeIntervalForUpgradeReminderNotificationsPostExpiration": [
                                "97",
                                "37",
                                "22",
                                "14"
                            ],
                            "postExpirationBillingAttemptIntervalInDays": 7,
                            "suppressOFIInRenewal": true,
                            "suppressDRMInTrialConversion": false,
                            "trialPostExpirationBillingAttemptIntervalInDays": 7,
                            "trialGracePeriod": "1_MONTH",
                            "timeIntervalForTrialManualReminderNotifications": [
                                "30",
                                "15",
                                "7",
                                "2"
                            ]
                        }
                    },
                    {
                        "groupId": "16",
                        "groupName": "Export Controls",
                        "attributes": {
                            "manufactureCountry": "US",
                            "eccn": "3A992"
                        }
                    }
                ]
            }
        ]
    }
]

The following example gets deployed versions of a specified product with a productId.

curl --location --request GET 'https://api.digitalriver.com/v1/products/[productId}?version=DEPLOYED' \
--header 'Authorization: Basic {your_API_key}' \
...

An ERID request requires the x-erid-as-pid=true header.

curl --location --request POST 'https://api.digitalriver.com/v1/products/{ERID}?version=DEPLOYED' \
--header 'Authorization: Basic {your_API_key}' \
--header 'header x-erid-as-pid=true' \
...

The response displays the deployed version of the product.

[
    {
        "productType": "INDIVIDUAL",
        "companyId": "acme",
        "siteIds": [
            "acme"
        ],
        "id": "51954990080",
        "state": "DEPLOYED",
        "locked": false,
        "version": 1,
        "deploymentRequiredChanges": {
            "fulfillmentTypes": [],
            "otherFulfillmentIntegration": {
                "fulfillerIds": []
            },
            "upgradeProducts": [],
            "downgradeProducts": []
        },
        "liveChanges": {
            "externalReferenceId": "external-reference-id-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
            "catalogs": [
                {
                    "catalogId": "4783669800",
                    "catalogName": "acme",
                    "categories": [],
                    "pricing": [
                        {
                            "type": "listPrice",
                            "priceListName": "acme",
                            "taxInclusive": false,
                            "prices": [
                                {
                                    "currency": "CAD",
                                    "locale": "en_CA"
                                },
                                {
                                    "currency": "CAD",
                                    "locale": "en_US"
                                },
                                {
                                    "currency": "USD",
                                    "locale": "en_US",
                                    "configuredPrice": 10.00
                                },
                                {
                                    "currency": "CAD",
                                    "locale": "fr_CA"
                                },
                                {
                                    "currency": "ARS"
                                },
                                {
                                    "currency": "AUD"
                                },
                                {
                                    "currency": "BRL"
                                },
                                {
                                    "currency": "CAD"
                                },
                                {
                                    "currency": "CHF"
                                },
                                {
                                    "currency": "CLP"
                                },
                                {
                                    "currency": "CNY"
                                },
                                {
                                    "currency": "COP"
                                },
                                {
                                    "currency": "CZK"
                                },
                                {
                                    "currency": "DKK"
                                },
                                {
                                    "currency": "EGP"
                                },
                                {
                                    "currency": "EUR"
                                },
                                {
                                    "currency": "GBP"
                                },
                                {
                                    "currency": "HKD"
                                },
                                {
                                    "currency": "HUF"
                                },
                                {
                                    "currency": "IDR"
                                },
                                {
                                    "currency": "ILS"
                                },
                                {
                                    "currency": "INR"
                                },
                                {
                                    "currency": "JPY"
                                },
                                {
                                    "currency": "KRW"
                                },
                                {
                                    "currency": "MXN"
                                },
                                {
                                    "currency": "MYR"
                                },
                                {
                                    "currency": "NOK"
                                },
                                {
                                    "currency": "NZD"
                                },
                                {
                                    "currency": "OMR"
                                },
                                {
                                    "currency": "PEN"
                                },
                                {
                                    "currency": "PLN"
                                },
                                {
                                    "currency": "RUB"
                                },
                                {
                                    "currency": "SEK"
                                },
                                {
                                    "currency": "SGD"
                                },
                                {
                                    "currency": "THB"
                                },
                                {
                                    "currency": "TRY"
                                },
                                {
                                    "currency": "TWD"
                                },
                                {
                                    "currency": "USD"
                                },
                                {
                                    "currency": "VEF"
                                },
                                {
                                    "currency": "ZAR"
                                }
                            ]
                        },
                        {
                            "type": "subscriptionRenewalPrice",
                            "priceListName": "Subscription Renewal Price list",
                            "taxInclusive": false,
                            "prices": [
                                {
                                    "currency": "ARS"
                                },
                                {
                                    "currency": "EUR"
                                },
                                {
                                    "currency": "GBP"
                                },
                                {
                                    "currency": "USD"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "localizations": [
            {
                "locale": "en_US",
                "isDefault": true,
                "groups": [
                    {
                        "groupId": "2",
                        "groupName": "Storefront Settings",
                        "attributes": {
                            "longDescription": "longDescription-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "nonSolr": true,
                            "keywords": "keywords-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "displayName": "demo-display-name-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "taxableUnspscCode": "43230000",
                            "confirmAddlInfo": "confirmAddlInfo-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "shortDescription": "shortDescription-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "isViewable": true,
                            "taxableProductCode": "4323.320_D",
                            "isOrderable": true,
                            "returnMethod": "LOD",
                            "emailAddlInfoText": "emailAddlInfoText-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "name": "demo-name-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "emailAddlInfo": "emailAddlInfo-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "minOrderQuantity": 0,
                            "privateStoreOnly": false,
                            "productReturnMethod": "ByAgentAndSelfService",
                            "sku": "demo-sku-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
                            "maxOrderQuantity": 0
                        }
                    },
                    {
                        "groupId": "10",
                        "groupName": "Subscription",
                        "attributes": {
                            "freeExtension": "2_WEEK",
                            "timeIntervalForTrialReminderNotifications": [
                                "30",
                                "15",
                                "7",
                                "2"
                            ],
                            "gracePeriod": "1_WEEK",
                            "timeIntervalForUpgradeReminderNotificationsPostCreation": [
                                "7",
                                "15",
                                "30",
                                "90"
                            ],
                            "timeIntervalForReminderNotifications": [
                                "90",
                                "30",
                                "15",
                                "7"
                            ],
                            "suppressOFIInQuantityIncrease": false,
                            "suppressDRMInUpgradeDowngrade": false,
                            "suppressOFIInUpgradeDowngrade": false,
                            "suppressDRMInQuantityIncrease": false,
                            "timeIntervalForReminderNotificationsPostExpiration": [
                                "7",
                                "15",
                                "30",
                                "90"
                            ],
                            "autoRenewalDateBasis": "PurchaseDate",
                            "timeIntervalForUpgradeReminderNotificationsPreExpiration": [
                                "97",
                                "37",
                                "22",
                                "14"
                            ],
                            "isFreeTrial": true,
                            "combinedRenewalPeriod": 1,
                            "timeIntervalForCCExpirationReminderNotifications": [
                                "30",
                                "15",
                                "7"
                            ],
                            "duration": "TWO_MONTH",
                            "timeIntervalForManualReminderNotifications": [
                                "90",
                                "30",
                                "15",
                                "7"
                            ],
                            "isDistinctScheduleTurnedOn": false,
                            "isCombinedRenewal": true,
                            "suppressDRMInRenewal": false,
                            "paymentSchedule": "matchRecurrence",
                            "isAutomatic": true,
                            "numOfDaysPriorExpirationForRenewalPreFirst": 30,
                            "isChangeProductAsRenewal": false,
                            "freeTrialPeriod": 45,
                            "includeRenewalProductInUpgradeList": true,
                            "numOfDaysPriorExpirationForRenewal": 4,
                            "suppressOFIInTrialConversion": true,
                            "numOfDaysPriorExpirationForRenewalFirst": 15,
                            "timeIntervalForUpgradeReminderNotificationsPostExpiration": [
                                "97",
                                "37",
                                "22",
                                "14"
                            ],
                            "postExpirationBillingAttemptIntervalInDays": 7,
                            "suppressOFIInRenewal": true,
                            "suppressDRMInTrialConversion": false,
                            "trialPostExpirationBillingAttemptIntervalInDays": 7,
                            "trialGracePeriod": "1_MONTH",
                            "timeIntervalForTrialManualReminderNotifications": [
                                "30",
                                "15",
                                "7",
                                "2"
                            ]
                        }
                    },
                    {
                        "groupId": "16",
                        "groupName": "Export Controls",
                        "attributes": {
                            "manufactureCountry": "US",
                            "eccn": "3A992"
                        }
                    }
                ]
            }
        ]
    }
]

Version

The version string gets the specific version of the product by state. The enums are DEPLOYED and RETIRED. If you do not specify the version query parameter, the response will contain the latest version. For example, if the product history is as follows:

  • Version 1 is retired: This product version is retired. Shoppers can no longer see or purchase this product in the store.

  • Version 2 is deployed: This product version is available in the store. Shoppers can see and purchase this product from your store.

  • Version 3 is in design: This new product version is not yet available in the store, but you plan to deploy this new version eventually. Shoppers cannot see or purchase this product from your store.

Use the following calls can get the different versions:

  • If you want to get the retired version (version 1), use the following call: GET /v1/products/{productId}?version=retired

  • If you want to get the deployed version (version 2), use the following call: GET /v1/products/{productId}?version=deployed

  • If you want to get the latest unreleased version, use the following call: GET /v1/products/{productId}

To retrieve all products from the product catalog, send a request. Replace {Your_Access_token} with your actual access token.

Send a request, replacing {categoryId} with the actual category ID to get all products for a specified category. Replace {Your_Access_token} with your actual access token.

Use the request to get data for a base product, individual product, or product combinations. Replace the {productId or ERID} placeholder with the appropriate product identifier to retrieve detailed product information. Replace {your_API_key} with your actual access token. If multiple products are associated with the ERID, the response will include all of them.

Duplicate ERIDs are not allowed. To prevent duplicate ERIDs, when configuring company settings in Global Commerce. This ensures that you won't accidentally provide an ERID that would result in duplicate products in the response if you searched for a product by ERID.

The request returns the product information for the specified productId in the response.

The request returns the product information for the specified externalReferenceId in the response.

To get a retired product version, specify the version=RETIRED query parameter in the request URL. Replace the {productId or ERID} placeholder with the appropriate product identifier to retrieve detailed product information. Replace {your_API_key} with your actual access token. For ERID requests, include the x-erid-as-pid=true header.

The request returns the product information for the specified productId in the response.

Include the version=DEPLOYED query parameter in the request URL to get a deployed product version. Replace {productId or ERID} with the appropriate product identifier and {your_API_key} with your actual access token. For ERID requests, include the x-erid-as-pid=true header.

See the query parameter for more information.

version
synchronous
synchronous
synchronous
GET /v1/shoppers/me/products/{productId}
GET /v1/shoppers/me/products/{productId}/pricing/volume-pricing
GET /v1/shoppers/me/products
GET /v1/shoppers/me/categories/{categoryId}/products
GET /v1/products/{productId or ERID}
GET /v1/products/{productId}
GET /v1/products/{productId}
enable the Enforce Unique Value