DIdigitalriver
Manage Product (Asynchronous API)

Retire a product

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.

post/v1/products/{productId}/retire

Request

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

Path parameters

productIdstring required

The product identifier of either an individual product or a base product.

Headers

x-erid-as-pidboolean

Set to true if you want to use the external reference identifier (ERID) in the path instead of the product identifier (productId).

Response

Successful response.

taskIdstring

The task identifier received in the response when you create or update a product (synchronous API).

receivedTimestring

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.

Example response

{
  "taskId": "d8a81162-aaaa-bbbb-cccc-ea513d1afa82",
  "receivedTime": "2022-05-01T23:00:21.123Z",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Changes

No recorded changes to this operation across all 1 revision of this API.