POST /public/v2/product-catalog/items

Create a new catalog item.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
sku String No
description String No
bundle_items[] Array No
bundle_items[].quantity Integer No
bundle_items[].item_or_uuid No
images[] Array No
images[].order Number No
images[].src String No
images[].is_main Boolean No
title String Yes
category_id String No
type String No

Valid values:

  • "regular"
  • "bundle"

Default value: "regular"

custom_fields[] Array No
custom_fields[].name String No
custom_fields[].value String No
price_configuration Object Yes
price_configuration.price Number No
price_configuration.billing_type String No
price_configuration.tiers[] Array No

only for volume based pricing

price_configuration.tiers[].min_qty Number Yes
price_configuration.tiers[].value Number Yes
price_configuration.pricing_method Integer Yes

Valid values:

  • 0
  • 1
  • 2
price_configuration.cost Number No
price_configuration.currency String Yes
price_configuration.billing_cycle String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.