> For the complete documentation index, see [llms.txt](https://docs.digitalriver.com/commerce-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digitalriver.com/commerce-api/admin-apis/admin-basics/available-admin-api-calls.md).

# Available Admin API calls

The following tables list the available Admin API calls. 

## Customer management

| Path                                           | Details                                                                                                                                                                              |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `/v1/customers/{customerId}`                   | <p><strong>Actions</strong>: <a href="/spaces/drE2RCYBuoRpd2TC2sx2/pages/6gb8QWVeLAhZD0iIZd3V">GET</a><br><strong>Mode</strong>: Sync</p>                                            |
| `/v1/customers/{customerId}/requestPIIRemoval` | <p><strong>Actions</strong>: <a href="/spaces/drE2RCYBuoRpd2TC2sx2/pages/k9FF1ElYA8N8OANOSI0g#v1-customers-customerid-requestpiiremoval">POST</a><br><strong>Mode</strong>: Sync</p> |

## File management

| Path                      | Details                                                                                                          |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `/files/{fileId}/content` | <p><strong>Action</strong>: <a href="/pages/9fDiZuIb7KN8moEFRbSR">GET</a> </p><p><strong>Mode</strong>: Sync</p> |

## Order management

| Path                                        | Details                                                                                                                                                                         |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/v1/orders/{orderId}`                      | <p><strong>Action</strong>: <a href="/pages/qslAKB67wbusKyYt5qoV#step-1-getting-the-order-details">GET</a> </p><p><strong>Mode</strong>: Sync</p>                               |
| `/v1/orders/{orderId}/invoices`             | <p><strong>Action</strong>: <a href="/pages/qslAKB67wbusKyYt5qoV#step-2-getting-the-download-information-for-the-orders-invoice">GET</a> </p><p><strong>Mode</strong>: Sync</p> |
| `/v1/orders/{orderId}/invoices/{receiptId}` | <p><strong>Action</strong>: <a href="/pages/qslAKB67wbusKyYt5qoV#step-3-getting-the-receipt-for-the-invoice">GET</a> </p><p><strong>Mode</strong>: Sync</p>                     |

## Refund management

| Path                                  | Details                                                                                                                                                                                       |
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/orders/{orderId}/refunds`           | <p><strong>Action</strong>: <a href="/pages/KFWj7aU5PyKl4C7Jsh27">GET</a></p><p><strong>Action</strong>: <a href="/pages/-MJXn8l_F0CUPxrmarwS">POST</a></p><p><strong>Mode</strong>: Sync</p> |
| `/orders/{orderid}/refunds/schema`    | <p><strong>Action</strong>: <a href="/pages/-MJXnUrcsokdVGpn3wSr">GET</a></p><p><strong>Mode</strong>: Sync</p>                                                                               |
| `/orders/{orderId}/refunds-available` | <p><strong>Action</strong>: <a href="/pages/-MJXo34JUuokMsBCpVop">GET</a></p><p><strong>Action</strong>: <a href="/pages/-MJXo34JUuokMsBCpVop">GET</a></p><p><strong>Mode</strong>: Sync</p>  |

## Subscription management

| Path                                                  | Details                                                                                                                                                                       |
| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/v1/subscriptions/`                                  | <p><strong>Action</strong>: <a href="/pages/-MYLKi7x8PNHeouzFlsK">GET</a> </p><p><strong>Mode</strong>: Sync</p>                                                              |
| `/v1/subscriptions/{subscriptionId}/`                 | <p><strong>Action</strong>: <a href="/pages/-MYLKi7x8PNHeouzFlsK">GET</a> </p><p><strong>Mode</strong>: Sync</p>                                                              |
| `/v1/subscriptions/{subscriptionId}/activate`         | <p><strong>Action</strong>: <a href="/pages/K6dbQTR6m6mlx6nbodhe">POST</a></p><p><strong>Mode</strong>:  Async</p>                                                            |
| `/v1/subscriptions/{subscriptionId}/email`            | <p><strong>Action</strong>: <a href="/pages/iraQfDbZw89Ty4FJxt7f">POST</a> </p><p></p><p><strong>Mode</strong>: Async</p>                                                     |
| `/v1/subscriptions/{subscriptionId}/expiration-date`  | <p><strong>Action</strong>: <a href="/pages/iraQfDbZw89Ty4FJxt7f">POST</a></p><p><strong>Mode</strong>: Async</p>                                                             |
| `/v1/subscriptions/{subscriptionId}/cancel`           | <p><strong>Action</strong>: <a href="/pages/iraQfDbZw89Ty4FJxt7f">POST</a> </p><p><strong>Mode</strong>: Async</p>                                                            |
| `/v1/subscriptions/{subscriptionId}/orders`           | <p><strong>Action</strong>: <a href="/pages/-MYLKi7x8PNHeouzFlsK">GET</a> </p><p><strong>Mode</strong>: Sync</p>                                                              |
| `/v1/subscriptions/{subscriptionId}/payment-option`   | <p><strong>Action</strong>: <a href="/pages/iraQfDbZw89Ty4FJxt7f">POST</a> </p><p><strong>Mode</strong>: Async</p>                                                            |
| `/v1/subscriptions/{subscriptionId}/payment-source`   | <p><strong>Action</strong>: <a href="/pages/iraQfDbZw89Ty4FJxt7f">POST</a> </p><p><strong>Mode</strong>: Async</p>                                                            |
| `/v1/subscriptions/{subscriptionId}/pending-actions`  | <p><strong>Action</strong>: <a href="/pages/-MYLKi7x8PNHeouzFlsK">GET</a></p><p><strong>Mode</strong>: Async</p>                                                              |
| `/v1/subscriptions/{subscriptionId}/perpetual-price`  | <p><strong>Action</strong>: <a href="/pages/OgNH544wiSpxl39Qr5v4">POST</a></p><p><strong>Mode</strong>: Async</p>                                                             |
| `/v1/subscriptions/{subscriptionId}/preview`          | <p><strong>Action</strong>: <a href="/pages/4XxyNOx4EOGd6SVrMLGA#apply-a-unit-prorated-price-using-the-preview-resource">POST</a></p><p><strong>Mode</strong>: Async</p>      |
| `/v1/subscriptions/{subscriptionId}/preview-cart`     | <p><strong>Action</strong>: <a href="/pages/4XxyNOx4EOGd6SVrMLGA#apply-a-unit-prorated-price-using-the-preview-cart-resource">POST</a></p><p><strong>Mode</strong>: Async</p> |
| `/v1/subscriptions/{subscriptionId}/reduce`           | <p><strong>Action</strong>: <a href="/pages/iraQfDbZw89Ty4FJxt7f">POST</a> </p><p><strong>Mode</strong>: Async</p>                                                            |
| `/v1/subscriptions/{subscriptionId}/reference-id`     | <p><strong>Action</strong>: <a href="/pages/SE3z9zZfJkvnCV4PboZp">POST</a></p><p><strong>Mode</strong>: Async</p>                                                             |
| `/v1/subscriptions/{subscriptionId}/renewal-price`    | <p><strong>Action</strong>: <a href="/pages/iraQfDbZw89Ty4FJxt7f">POST</a> </p><p><strong>Mode</strong>: Async</p>                                                            |
| `/v1/subscriptions/{subscriptionId}/renewal-product`  | <p><strong>Action</strong>: <a href="/pages/iraQfDbZw89Ty4FJxt7f">POST</a> </p><p><strong>Mode</strong>: Async</p>                                                            |
| `/v1/subscriptions/{subscriptionId}/renewal-quantity` | <p><strong>Action</strong>: <a href="/pages/iraQfDbZw89Ty4FJxt7f">POST</a> </p><p><strong>Mode</strong>: Async</p>                                                            |
| `/v1/subscriptions/{subscriptionId}/renewal-type`     | <p><strong>Action</strong>: <a href="/pages/iraQfDbZw89Ty4FJxt7f">POST</a> </p><p><strong>Mode</strong>: Async</p>                                                            |
| `/v1/subscriptions/{subscriptionId}/ship-to-address`  | <p><strong>Action</strong>: <a href="/pages/iraQfDbZw89Ty4FJxt7f">POST</a></p><p><strong>Mode</strong>: Async</p>                                                             |

## Site management

| Path                                               | Details                                                                                                                                                          |
| -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/v1/sites/{siteId}/authorized-billing-countries`  | <p><strong>Action</strong>: <a href="/pages/-MYLKi7x8PNHeouzFlsK">GET</a></p><p><strong>Mode</strong>: Sync</p><p><strong>Deployment validation</strong>: No</p> |
| `/v1/sites/{siteId}/authorized-shipping-countries` | <p><strong>Action</strong>: <a href="/pages/-MYLKi7x8PNHeouzFlsK">GET</a></p><p><strong>Mode</strong>: Sync</p><p><strong>Deployment validation</strong>: No</p> |

## Product management

Note that the `products` in the URL path represents the current product administrator session and the calls that you make to manage products on your online store.

| Path                                                                                                                                                                                                                                                       | Details                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/v1/products`                                                                                                                                                                                                                                             | <p><strong>Action</strong>: <a href="/pages/llDdI94vsLbnM3PVQyNr#creating-an-individual-or-base-product">POST</a></p><p><strong>ERID support</strong>: Yes</p><p><strong>Mode</strong>: Async</p><p><strong>Deployment validation</strong>: Yes</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `/v1/products/{baseProductId or baseERID}`                                                                                                                                                                                                                 | <p><strong>Action</strong>: <a href="/pages/Hu9zmrkFXLqjsP28XSjy#getting-a-product-by-identifier">GET</a></p><ul><li><strong>ERID support</strong>: Yes</li><li><strong>Mode</strong>: Sync</li><li><strong>Deployment validation</strong>: No</li></ul><p><strong>Action</strong>: <a href="/pages/llDdI94vsLbnM3PVQyNr#updating-an-individual-or-base-product">POST</a></p><ul><li><strong>ERID support</strong>: Yes</li><li><strong>Mode</strong>: Async</li><li><strong>Deployment validation</strong>: Yes</li></ul>                                                                                                                                                                                                                                                                                                          |
| `/v1/products/{baseProductId or baseERID}/locales/{locale}`                                                                                                                                                                                                | <p><strong>Action</strong>: <a href="/pages/tFhZOlBv3zZhpEiBbYuZ">GET</a></p><ul><li><strong>ERID support</strong>: Yes</li><li><strong>Mode</strong>: Sync</li><li><strong>Deployment validation</strong>: No</li></ul><p><strong>Action</strong>: <a href="/pages/llDdI94vsLbnM3PVQyNr#updating-an-individual-or-base-product">POST</a></p><ul><li><strong>ERID support</strong>: Yes</li><li><strong>Mode</strong>: Async</li><li><strong>Deployment validation</strong>: Yes</li></ul><p><strong>Action</strong>: <a href="/pages/WRV3roNi1ckXZH0NJ8wr">DEL</a></p><ul><li><strong>ERID support</strong>: Yes</li><li><strong>Mode</strong>: Async</li><li><strong>Deployment validation</strong>: No</li></ul>                                                                                                                 |
| <p><code>/v1/products/{baseProductId or ERID}/variation/{variationProductId</code> or <code>variationERID}/locales/{locale}</code><br><br>OR<br><br><code>/v1/products/product/variation/{variationProductId or variationERID}/locales/{locale}</code></p> | <p><strong>Action</strong>: <a href="/pages/RhIeZs4QI1RY7JO2phFq#getting-a-product-variation-for-a-specific-base-product-and-locale">GET</a></p><p><strong>ERID support</strong>: Yes</p><p><strong>Mode</strong>: Sync</p><p><strong>Deployment validation</strong>: No</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `/v1/products/{baseProductId or baseERID}/deploy`                                                                                                                                                                                                          | <p><strong>Action</strong>: <a href="/pages/e14SGIgvr8I1L7Ysi1xp">POST</a></p><p><strong>ERID support</strong>: Yes</p><p><strong>Mode</strong>: Async</p><p><strong>Deployment validation</strong>: Yes</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `/v1/products/{baseProductId or baseERID}/live-changes`                                                                                                                                                                                                    | <p><strong>Action</strong>: <a href="/pages/GRkhVB6ywLn3ioEaZoWz#applying-a-live-change-to-a-base-or-individual-product">POST</a></p><p><strong>ERID support</strong>: Yes</p><p><strong>Mode</strong>: Async</p><p><strong>Deployment validation</strong>: Yes</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| <p><code>/v1/products/{baseProductId or baseERID}/variations/{variationProductId or variationERID}/live-changes</code><br><br><code>OR</code><br><br><code>/v1/products/product/variations/{variationProductId or variationERID}/live-changes</code></p>   | <p><strong>Action</strong>: <a href="/pages/GRkhVB6ywLn3ioEaZoWz#applying-a-live-change-to-a-product-variation">POST</a></p><p><strong>ERID support</strong>: Yes</p><p><strong>Mode</strong>: Async</p><p><strong>Deployment validation</strong>: Yes</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| <p><code>/v1/products/{baseProductId or baseERID/variations/{variationProductId or variationERID}</code><br><br>OR<br><br><code>/v1/products/product/variations/{variationProductId or variationERID}</code></p>                                           | <p><strong>Action</strong>: <a href="/pages/oBSEMOunn3MUk0WIeTQy#getting-a-product-variation-for-a-specific-base-product">GET</a></p><ul><li><strong>ERID support</strong>: Yes</li><li><strong>Mode</strong>: Sync</li><li><strong>Deployment validation</strong>: No</li></ul><p><strong>Action</strong>: <a href="/pages/4rDGkBx4yUpDHLOn61BS#updating-a-specific-product-variation">POST</a></p><ul><li><strong>ERID support</strong>: Yes</li><li><strong>Mode</strong>: Async</li><li><strong>Deployment validation</strong>: YES</li></ul><p><strong>Action</strong>: <a href="/pages/4xPAhMA5MshCOBkE4YbC#deleting-a-product-variation-for-a-specific-base-product">DEL</a></p><ul><li><strong>ERID support</strong>: Yes</li><li><strong>Mode</strong>: Async</li><li><strong>Deployment validation</strong>: No</li></ul> |
| `/v1/products/{baseProductId or bbasePaseERID}/retire`                                                                                                                                                                                                     | <p><strong>Action</strong>: <a href="/pages/jb8yaTlrygNy26nBxx4G">POST</a></p><p><strong>ERID support</strong>: Yes</p><p><strong>Mode</strong>: Async</p><p><strong>Deployment validation</strong>: No</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `/v1/products/tasks`                                                                                                                                                                                                                                       | <p><strong>Action</strong>: <a href="/pages/HW4lKk7Pr4Fafoz099OF#getting-a-list-of-all-tasks">GET</a></p><p><strong>ERID support</strong>: Yes</p><p><strong>Mode</strong>: Sync</p><p><strong>Deployment validation</strong>: Not applicable</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `/v1/products/tasks/{taskId}`                                                                                                                                                                                                                              | <p><strong>Action</strong>: <a href="/pages/HW4lKk7Pr4Fafoz099OF#verifying-the-successful-completion-of-a-specific-task">GET</a></p><p><strong>ERID support</strong>: Yes</p><p><strong>Mode</strong>: Sync</p><p><strong>Deployment validation</strong>: Not applicable</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `/v1/product/tasks?productId={productId)`                                                                                                                                                                                                                  | <p><strong>Action</strong>: <a href="/pages/HW4lKk7Pr4Fafoz099OF#verifying-the-successful-completion-of-a-specific-product">GET</a></p><p><strong>ERID support</strong>: Yes</p><p><strong>Mode</strong>: Sync</p><p><strong>Deployment validation</strong>: Not applicable</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

{% hint style="info" %}
Each paired request below performs the same task:

* `GET /v1/products/product/variations/{productId or ERID}` and  \
  `GET /v1/products/{productId or ERID}/variations/{productVariationId or variationERID}`
* `POST /v1/products/product/variations/{productVariationId or variationERID}` and  \
  `POST /v1/products/{productId or ERID}/variations/{productVariationId or variationERID}`
* `DEL /v1/products/product/variations/{productVariatinId or variatinERID}` and  \
  `DEL /v1/products/{productId or ERID}/variations/{productVariationId or variationERID}`
* `GET /v1/products/{productId or ERID}/locales/{locale}`\
  `GET /v1/products/{productId or ERID}/variation/{productVariationId or variationERID}/locales/{locale}`
  {% endhint %}