---
title: "Retire a product"
method: POST
path: "/v1/products/{productId}/retire"
tags: ["Manage Product (Asynchronous API)"]
---

# Retire a product

`POST /v1/products/{productId}/retire`

## Request

- Base URL: `https://api.digitalriver.com`
- URL: `https://api.digitalriver.com/v1/products/{productId}/retire`
- Auth: HTTP basic

Retire an existing product asynchronously.  The product variations will be retired along with the base product. Therefore, the provided product identifier must be for an individual or base product.

## Path parameters

- `productId` string, required

## Headers

- `x-erid-as-pid` boolean

## Response `202`

Successful response.

- ProductAdminApiAsyncResponse
  - `taskId` string: The task identifier received in the response when you create or update a product (synchronous API).
  - `receivedTime` string: The date and time when Global Commerce received the task.
  - `taskStatus` 'PUBLISHED' | 'PROCESSING' | 'COMPLETED' | 'FAILED': The status of the task.
  - `requestType` 'CREATE_PRODUCT' | 'CREATE_VARIATION' | 'UPDATE_PRODUCT' | 'UPDATE_VARIATION' | 'DELETE_VARIATION' | 'DELETE_LOCALE' | 'DEPLOY_PRODUCT' | 'RETIRE_PRODUCT' | 'UPDATE_PRODUCT_LIVE_CHANGE' | 'UPDATE_VARIATION_LIVE_CHANGE': The request type for this task.

## Other responses

- `401`: * The API key is invalid if you are using HTTP Basic Authentication.
- `403`: * The token is invalid if you are using Bearer Token Authentication.
- `404`: * Product was not found.
- `409`: * Unable to handle request because it conflicts with other requests.

---

[API](https://skmtc.dev/digitalriver/apis/commerce-api-suite-admin-apis.md) - [All operations](https://skmtc.dev/digitalriver/apis/commerce-api-suite-admin-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/digitalriver/apis/commerce-api-suite-admin-apis/revisions/a6efafc1669c?raw)