# Commerce API references ## Commerce API references - [Commerce API references](https://docs.digitalriver.com/commerce-api-references/commerce-api-references.md) - [Errors](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/errors.md) - [Error codes](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes.md): Learn how the Commerce API uses HTTP response status codes. - [HTTP response status codes](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/http-response-status-codes.md): Understand HTTP response status codes. - [Error format for Shopper APIs](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-format-for-shopper-apis.md): Understand the error code format for the Shopper APIs. - [Error codes for Shopper APIs](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-shopper-apis.md): Understand the internal error codes for the Shopper APIs. - [400 Bad Request](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-shopper-apis/400-bad-request.md): Understand the 400 Bad Request error codes for the Shopper APIs. - [401 Unauthorized](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-shopper-apis/401-unauthorized.md): Understand the 401 Unauthorized error codes for the Shopper APIs. - [403 Forbidden](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-shopper-apis/403-forbidden.md): Understand the 403 Forbidden error codes for the Shopper APIs. - [404 Not Found](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-shopper-apis/404-not-found.md): 404 Not Found Understand the 404 Not Found error codes for the Shopper APIs. - [405 Method Not Allowed](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-shopper-apis/405-method-not-allowed.md): Understand the 405 Method Not Allowed error codes for the Shopper APIs. - [409 Conflict](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-shopper-apis/409-conflict.md): Understand the 409 Conflict error codes for the Shopper APIs. - [412 Precondition Failed](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-shopper-apis/412-precondition-failed.md): Understand the 412 Precondition Failed error codes for the Shopper APIs. - [413 Payload Too Large](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-shopper-apis/413-payload-too-large.md): Understand the 413 Request Entity Too Large error codes for the Shopper APIs. - [500 Internal Server Error](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-shopper-apis/500-internal-server-error.md): Understand the 500 Internal Server Error error codes for the Shopper APIs. - [Error format for Admin APIs](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-format-for-admin-apis.md): Understand the error code formats for the Admin APIs. - [Async error objects](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-format-for-admin-apis/async-error-objects.md): Understand async error objects. - [Sync error objects](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-format-for-admin-apis/sync-error-objects.md): Understand sync error objects. - [Deployment objects](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-format-for-admin-apis/deployment-objects.md): Understand deployment error objects. - [Warning objects](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-format-for-admin-apis/warning-objects.md): Understand warning error objects. - [Error codes for Admin APIs](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-admin-apis.md): Lean about the error codes for the Admin APIs. - [Error patterns](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-admin-apis/error-patterns.md): Learn about the use of the product, variation, and locale patterns in Admin API error codes. - [Supported image types](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-admin-apis/supported-image-types.md): Understand the supported image types. - [Asynchronous response error codes](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-admin-apis/asynchronous-response-error-codes.md): Understand the asynchronous response error codes for the Admin API. - [Deployment error codes](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-admin-apis/deployment-error-codes.md): Understand the deployment error codes for the Admin API. - [Synchronous response error codes](https://docs.digitalriver.com/commerce-api-references/warnings-and-error-codes/error-codes/error-codes-for-admin-apis/synchronous-response-error-codes.md): Understand the synchronous response error codes for the Admin API. - [API structure](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure.md): Understand the Commerce API structure. - [API keys](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/api-keys.md): Understand how to use your API keys. - [Supported OAuth and Commerce API formats](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/supported-oauth-and-commerce-api-formats.md): Learn about supported OAuth and Commerce API formats. - [Mini cart widget](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/mini-cart-widget.md): Understand how to use a Mini Cart widget. - [Custom attributes](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/custom-attributes.md): Learn about custom attributes. - [Fields used as keys](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/fields-used-as-keys.md): Learn how to use fields as keys. - [Fields and expand query parameters](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/fields-and-expand-query-parameters.md): Learn how to use field and expand query parameters. - [Caching responses](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/caching-responses.md): Learn when to cache responses. - [CORS support](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/cors-support.md): Understand how CORS defines how a browser and server communicate. - [JSONP support](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/jsonp-support.md): Understand how JSONP works. - [Transport](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/transport.md): Understand how transport works. - [Service profiles](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/service-profiles.md): Understand service profiles. - [Supported protocols and formats](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/supported-protocols-and-formats.md): Understand data transport protocols and formats. - [Elements](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/elements.md): Learn how to handle unknown elements. - [Rate limiting](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/rate-limiting.md): Understand rate limiting. - [Locale and currency](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/locale-and-currency.md): Understand how to use locale and currency. - [Exchange rate](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/exchange-rate.md): Understand how Digital River manages the exchange rate. - [Product identifier](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/product-identifier.md): Understand the product identifier. - [Product external reference identifier (ERID)](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/product-external-reference-identifier-erid.md): Understand the product ERID. - [Customer external reference identifier ERID](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/customer-external-reference-identifier-erid.md): Understand the customer ERID. - [Cancel request process](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/cancel-request-process.md): Learn how to handle various Cancel Request scenarios. - [Failover and redundancy](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/failover-and-redundancy.md): Understand how Digital River provides failover and redundancy. - [Troubleshooting API calls](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/api-structure/troubleshooting-api-calls.md): Learn how to resolve problems with API calls. - [Shopper APIs reference](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/shopper-apis-reference.md) - [Carts](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/shopper-apis-reference/carts.md): Learn more about the carts resource. - [Offers](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/shopper-apis-reference/carts/offers.md): Understand how offers work. - [Offer types](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/shopper-apis-reference/carts/offers/offer-types.md): Understand the available offer types. - [POP offers](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/shopper-apis-reference/carts/offers/pop-offers.md) - [Applied offers](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/shopper-apis-reference/carts/offers/applied-offers.md) - [Eligible offers](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/shopper-apis-reference/carts/offers/eligible-offers.md) - [Orders](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/shopper-apis-reference/orders.md): Learn more about the orders resource. - [Returns](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/shopper-apis-reference/returns.md): Learn how returns are processed. - [Links](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/shopper-apis-reference/links.md): Understand how the Shoppers resource includes links. - [Admin APIs reference](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/admin-apis-reference.md) - [Subscriptions](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/admin-apis-reference/subscriptions.md): Learn how to manage subscriptions. - [Sites](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/admin-apis-reference/sites.md): Understand the basics of sites. - [Products](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/admin-apis-reference/products.md): Understand the basics of products. - [Live changes](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/admin-apis-reference/live-changes.md) - [Authorized shipping and billing countries](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/admin-apis-reference/authorized-shipping-and-billing-countries.md): Understand shipping and billing countries. - [Merchandising](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/admin-apis-reference/merchandising.md): Learn how to use offers, point-of-promotions (POPs), and private stores. - [Disclosures](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/admin-apis-reference/disclosures.md): Learn how to apply disclosures. - [Glossary](https://docs.digitalriver.com/commerce-api-references/commerce-api-reference-guide/glossary.md) ## Shopper APIs reference - [Shopper APIs reference](https://docs.digitalriver.com/commerce-api-references/shopper-apis/shopper-apis-reference.md) - [Tokens](https://docs.digitalriver.com/commerce-api-references/shopper-apis/oauth/tokens.md) - [Access tokens](https://docs.digitalriver.com/commerce-api-references/shopper-apis/oauth/access-tokens.md) - [Shoppers](https://docs.digitalriver.com/commerce-api-references/shopper-apis/shoppers/shoppers.md) - [Addresses](https://docs.digitalriver.com/commerce-api-references/shopper-apis/shoppers/addresses.md) - [Payment options](https://docs.digitalriver.com/commerce-api-references/shopper-apis/shoppers/payment-options.md) - [Categories](https://docs.digitalriver.com/commerce-api-references/shopper-apis/browse-product-discovery/categories.md) - [Products](https://docs.digitalriver.com/commerce-api-references/shopper-apis/browse-product-discovery/products.md) - [Product variations](https://docs.digitalriver.com/commerce-api-references/shopper-apis/browse-product-discovery/product-variations.md) - [Pricing](https://docs.digitalriver.com/commerce-api-references/shopper-apis/browse-product-discovery/pricing.md) - [Inventory status](https://docs.digitalriver.com/commerce-api-references/shopper-apis/browse-product-discovery/inventory-status.md) - [Financing](https://docs.digitalriver.com/commerce-api-references/shopper-apis/browse-product-discovery/financing.md) - [Offers](https://docs.digitalriver.com/commerce-api-references/shopper-apis/browse-product-discovery/offers.md) - [Purchase plan](https://docs.digitalriver.com/commerce-api-references/shopper-apis/browse-product-discovery/purchase-plan.md) - [Find a purchase plan](https://docs.digitalriver.com/commerce-api-references/shopper-apis/browse-product-discovery/find-a-purchase-plan.md) - [Authorize a purchase plan](https://docs.digitalriver.com/commerce-api-references/shopper-apis/browse-product-discovery/authorize-a-purchase-plan.md) - [Apply a shopper to a cart](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/apply-a-shopper-to-a-cart.md) - [Line items](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/line-items.md) - [Billing address](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/billing-address.md) - [Shipping address](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/shipping-address.md) - [Payment methods](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/payment-methods.md) - [Shipping options](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/shipping-options.md) - [Web checkout](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/web-checkout.md) - [Submit a cart](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/submit-a-cart.md) - [Apply or detach payment methods](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/apply-or-detach-payment-methods.md) - [Apply a shipping option](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/apply-a-shipping-option.md) - [Carts](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/carts.md) - [Cart offers](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/cart-offers.md) - [API trigger offer](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/api-trigger-offer.md) - [Resume cart](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/resume-cart.md) - [Third-party subscription engine](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/third-party-subscription-engine.md) - [Tax registration](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/tax-registration.md) - [Price override](https://docs.digitalriver.com/commerce-api-references/shopper-apis/cart/price-override.md) - [Orders](https://docs.digitalriver.com/commerce-api-references/shopper-apis/orders/orders.md) - [Order lookup](https://docs.digitalriver.com/commerce-api-references/shopper-apis/orders/order-lookup.md) - [Order address](https://docs.digitalriver.com/commerce-api-references/shopper-apis/orders/order-address.md) - [Returns](https://docs.digitalriver.com/commerce-api-references/shopper-apis/orders/returns.md) - [Manage a subscription](https://docs.digitalriver.com/commerce-api-references/shopper-apis/subscriptions/manage-a-subscription.md) - [Manage the subscription's renewal plan](https://docs.digitalriver.com/commerce-api-references/shopper-apis/subscriptions/manage-the-subscriptions-renewal-plan.md) - [Immediate midterm change](https://docs.digitalriver.com/commerce-api-references/shopper-apis/subscriptions/immediate-midterm-change.md) - [Payment](https://docs.digitalriver.com/commerce-api-references/shopper-apis/subscriptions/payment.md) - [Address](https://docs.digitalriver.com/commerce-api-references/shopper-apis/subscriptions/address.md) - [Orders](https://docs.digitalriver.com/commerce-api-references/shopper-apis/subscriptions/orders.md) - [Pending actions](https://docs.digitalriver.com/commerce-api-references/shopper-apis/subscriptions/pending-actions.md) - [Retrieve subscriptions](https://docs.digitalriver.com/commerce-api-references/shopper-apis/subscriptions/retrieve-subscriptions.md) - [Subscription billing and shipping addresses](https://docs.digitalriver.com/commerce-api-references/shopper-apis/subscriptions/subscription-billing-and-shipping-addresses.md) ## Admin APIs reference - [Admin APIs reference](https://docs.digitalriver.com/commerce-api-references/admin-apis/admin-apis-reference.md) - [Refunds](https://docs.digitalriver.com/commerce-api-references/admin-apis/order-management/refunds.md) - [Retrieve an order (synchronous API)](https://docs.digitalriver.com/commerce-api-references/admin-apis/order-management/retrieve-an-order-synchronous-api.md) - [Retrieve an invoice (synchronous API)](https://docs.digitalriver.com/commerce-api-references/admin-apis/order-management/retrieve-an-invoice-synchronous-api.md) - [Manage orders (synchronous API)](https://docs.digitalriver.com/commerce-api-references/admin-apis/order-management/manage-orders-synchronous-api.md) - [Retrieve a customer (synchronous API)](https://docs.digitalriver.com/commerce-api-references/admin-apis/customer-management/retrieve-a-customer-synchronous-api.md) - [Manage a customer (synchronous API)](https://docs.digitalriver.com/commerce-api-references/admin-apis/customer-management/manage-a-customer-synchronous-api.md) - [Manage a subscription](https://docs.digitalriver.com/commerce-api-references/admin-apis/subscription-mangement/manage-a-subscription.md) - [Renew a subscription](https://docs.digitalriver.com/commerce-api-references/admin-apis/subscription-mangement/renew-a-subscription.md) - [Apply an immediate midterm change](https://docs.digitalriver.com/commerce-api-references/admin-apis/subscription-mangement/apply-an-immediate-midterm-change.md) - [Manage subscription payments](https://docs.digitalriver.com/commerce-api-references/admin-apis/subscription-mangement/manage-subscription-payments.md) - [Modify the subscription's external reference ID](https://docs.digitalriver.com/commerce-api-references/admin-apis/subscription-mangement/modify-the-subscriptions-external-reference-id.md) - [Manage the subscription's address](https://docs.digitalriver.com/commerce-api-references/admin-apis/subscription-mangement/manage-the-subscriptions-address.md) - [Get all orders](https://docs.digitalriver.com/commerce-api-references/admin-apis/subscription-mangement/get-all-orders.md) - [Retrieve subscriptions with pending actions](https://docs.digitalriver.com/commerce-api-references/admin-apis/subscription-mangement/retrieve-subscriptions-with-pending-actions.md) - [Retrieve subscriptions](https://docs.digitalriver.com/commerce-api-references/admin-apis/subscription-mangement/retrieve-subscriptions.md) - [Manage a perpetual price](https://docs.digitalriver.com/commerce-api-references/admin-apis/subscription-mangement/manage-a-perpetual-price.md) - [Update a subscription's email address](https://docs.digitalriver.com/commerce-api-references/admin-apis/subscription-mangement/update-a-subscriptions-email-address.md) - [Get authorized countries](https://docs.digitalriver.com/commerce-api-references/admin-apis/site-management/get-authorized-countries.md) - [Manage products (asynchronous API)](https://docs.digitalriver.com/commerce-api-references/admin-apis/product-management/manage-products-asynchronous-api.md) - [Retrieve a product (synchronous API)](https://docs.digitalriver.com/commerce-api-references/admin-apis/product-management/retrieve-a-product-synchronous-api.md) - [Retrieve the product task status (synchronous API)](https://docs.digitalriver.com/commerce-api-references/admin-apis/product-management/retrieve-the-product-task-status-synchronous-api.md) - [Manage offers (synchronous API)](https://docs.digitalriver.com/commerce-api-references/admin-apis/offer-management/manage-offers-synchronous-api.md) - [Retrieve an offer (synchronous API)](https://docs.digitalriver.com/commerce-api-references/admin-apis/offer-management/retrieve-an-offer-synchronous-api.md) - [Manage webhook events](https://docs.digitalriver.com/commerce-api-references/admin-apis/webhook-management/manage-webhook-events.md) - [Source management](https://docs.digitalriver.com/commerce-api-references/admin-apis/payment-source/source-management.md) - [Retrieve a file](https://docs.digitalriver.com/commerce-api-references/admin-apis/file-management/retrieve-a-file.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.digitalriver.com/commerce-api-references/commerce-api-references.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.