v1

latestOpenAPI 3.0.32026-07-24614422630.2 KB
Product Catalog

Create or Update Product Catalog

This endpoint asynchronously uploads a complete product catalog to a DRAFT version. Each product and bundle is created or updated based on the details in the request JSON.

If a SKU already exists in the catalog, it will be completely replaced with the new data from the request, including its pricing, assignments, and other details. If the replacement process fails for any reason, the system will revert to the old product definition.

This operation returns a request_id for you to track the progress. Note that requests targeting an ACTIVE or DEACTIVATED catalog version will fail.

post/api/v1/version/{version_id}/products_catalog

Path parameters

version_idstring required

The identifier of the 'DRAFT' version to upload the catalog to.

Request body

Example request

{
  "products": [
    {
      "product_pricing": {
        "pricing_rules": [
          {
            "volume_discount": {
              "Quantity": "VolD1",
              "Duration": "VolD2"
            }
          }
        ]
      }
    }
  ],
  "bundles": [
    {
      "product_pricing": {
        "pricing_rules": [
          {
            "volume_discount": {
              "Quantity": "VolD1",
              "Duration": "VolD2"
            }
          }
        ]
      }
    }
  ]
}

Response

Success. The upload process has started.

request_idstring

The ID of the asynchronous request for tracking.