Sign in
latestOpenAPI 3.0.02026-08-1056429755.6 KB

a6efafc1669c

Manage Product (Asynchronous API)

Delete a product variation

Delete an existing product variation asynchronously. The changes go live immediately. You do not need to deploy these changes. If the request cannot find the product variation the response returns 200 OK.

delete/v1/products/{baseProductId}/variations/{variationId}

Path parameters

baseProductIdstring required

The base product identifier must be for the base product for the product variation, or simply use 'product' instead.

variationIdstring required

The product variation identifier.

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"
}