Manage Product (Asynchronous API)

Update a product variation

Update an existing product variation asynchronously.

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

Request

  • Base URL
    https://api.digitalriver.com
  • URL
    https://api.digitalriver.com/v1/products/{baseProductId}/variations/{variationId}
  • Auth
    HTTP basic

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

Request body

Example request

{
  "deploymentRequiredChanges": {
    "otherFulfillmentIntegration": {
      "fulfillerIds": [
        "digitalRiver"
      ]
    },
    "transferProduct": "2234567800",
    "upgradeProducts": [
      "3234567800"
    ],
    "downgradeProducts": [
      "4234567800"
    ]
  },
  "localizations": [
    {
      "locale": "en_US"
    }
  ]
}

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.