Retiring a product
Learn how to retire a product programmatically.
You can retire a base or individual product when you no longer need it. However, you cannot delete the product. You can only delete product variations associated with a base product.
You can find a retired product by sending a GET /v1/products/{productId or ERID}?version=RETIRED
request or searching for the retired product in Global Commerce. The shoppers visiting your store cannot see or purchase the retired product.
The following POST /v1/products/{productId or ERID}/retire
request retires the specified product. To retire a specific product, you must provide either a productId
or ERID
.
The following example retires a specific product with a productId
.
curl --location --request POST 'https://api.digitalriver.com/v1/products/{productID}/retire' \
--header 'Authorization: Basic <API_key>' \
...
An ERID request requires the x-erid-as-pid=true
header.
curl --location --request POST 'https://api.digitalriver.com/v1/products/{ERID}/retire' \
--header 'Authorization: Basic <API_key>' \
--header 'header x-erid-as-pid=true' \
...
Verifying the retirement of a product in Global Commerce
When you retire an individual or base product, that product will be marked as retired in Global Commerce.
Sign in to Global Commerce.
Select Catalog, select Products, and then click Manage Products. The Products page appears.
Click the Search tab, select Product from the Search In drop-down list, and choose ID from the Search By list. Enter the product identifier or ERID in the Search For field, then click Search.
Click the link for the product under the Internal Product Name column. The Edit Product page appears, and (Retired) will appear after the product name at the top of the page.
Last updated
Was this helpful?