Sign in
latestOpenAPI 3.0.02026-08-1056429755.6 KB

a6efafc1669c

Manage Product (Asynchronous API)

Update the live changes of an individual or base product

Update the live changes to an existing individual product or base product asynchronously. The changes will go live immediately. You do not need to deploy these changes. Live changes for individual or base product includes catalog, category, price.

post/v1/products/{productId}/live-changes

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).

Request body

externalReferenceIdstring

The external reference identifier. A unique identifier for the product from the Digital River client.

Example request

{
  "externalReferenceId": "sku-1234-5678-xyz",
  "catalogs": [
    {
      "catalogId": "123456000",
      "categories": [
        {
          "categoryId": "19000000"
        }
      ],
      "prices": [
        {
          "prices": [
            {
              "currency": "USD",
              "locale": "en_US",
              "configuredPrice": 15.99
            }
          ]
        }
      ]
    }
  ]
}

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