Skip to content

Catalog Configuration

configureChannelCatalog - Configure Catalog capabilities for a channel

Request

Call Frequency
Maximum usage: 1 per minute
Security
Bearer(Required scopes:
connect-channel-platform:channel...
)
Path
channel_idstring, non-emptyrequired

Connect Channel identifier

Bodyapplication/json; charset=UTF-8required
behaviorsobject
discount_pricesobject
offer_configurationobject
standard_pricesobject
stock_quantitiesobject

Stock configuration. Unlike prices, stock does not support a per-store default value as a fallback when configured per sub-channel.

use_case_configurationsobject

Configuration for offer related features by use case. This API provides the configuration of required offer fields by use cases

curl -i -X POST \
  'https://miraklconnect.com/api/channel-platform/v1/catalog-configuration/channels/{channel_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=UTF-8' \
  -d '{
    "offer_configuration": {
      "custom_attributes": [
        {
          "id": "OFFER_STATE",
          "type": "List",
          "labels": [
            {
              "locale": "en_US",
              "value": "Offer condition"
            }
          ],
          "configuration_modes": [
            "CONSTANT",
            "VARIABLE"
          ],
          "descriptions": [
            {
              "locale": "en_US",
              "value": "The condition of the offer."
            }
          ],
          "max_size": 1,
          "requirement_level": "REQUIRED",
          "values": [
            {
              "id": "NEW",
              "labels": [
                {
                  "locale": "en_US",
                  "value": "New"
                }
              ]
            },
            {
              "id": "REFURBISHED",
              "labels": [
                {
                  "locale": "en_US",
                  "value": "Refurbished - as good as new"
                }
              ]
            }
          ]
        },
        {
          "id": "ASIN",
          "type": "Text",
          "configuration_modes": [
            "VARIABLE"
          ],
          "descriptions": [
            {
              "locale": "en_US",
              "value": "ASIN of the product. You are strongly encouraged to provide this value."
            }
          ],
          "requirement_level": "RECOMMENDED",
          "max_size": 255,
          "labels": [
            {
              "locale": "en_US",
              "value": "Amazon Standard Identification Number"
            }
          ]
        },
        {
          "id": "productTaxCode",
          "type": "Text",
          "configuration_modes": [
            "VARIABLE"
          ],
          "descriptions": [
            {
              "locale": "en_US",
              "value": "The tax code for the product."
            }
          ],
          "requirement_level": "OPTIONAL",
          "max_size": 255,
          "labels": [
            {
              "locale": "en_US",
              "value": "Product Tax Code"
            }
          ]
        },
        {
          "id": "length",
          "type": "Text",
          "configuration_modes": [
            "VARIABLE"
          ],
          "descriptions": [
            {
              "locale": "en_US",
              "value": "The length of the product."
            }
          ],
          "requirement_level": "OPTIONAL",
          "max_size": 255,
          "labels": [
            {
              "locale": "en_US",
              "value": "Length"
            }
          ]
        }
      ]
    },
    "use_case_configurations": {
      "offer_creation": {
        "support": "SUPPORTED",
        "required": {
          "standard_attributes": [
            "GTIN",
            "ID",
            "STOCK"
          ],
          "custom_attributes": [
            "OFFER_STATE"
          ]
        },
        "optional": {
          "standard_attributes": [
            "STANDARD_PRICE",
            "DISCOUNT_PRICE"
          ],
          "custom_attributes": [
            "length"
          ]
        }
      },
      "offer_update": {
        "support": "SUPPORTED",
        "required": {
          "standard_attributes": [
            "ID"
          ],
          "custom_attributes": []
        },
        "optional": {
          "standard_attributes": [],
          "custom_attributes": [
            "productTaxCode"
          ]
        }
      }
    }
  }'

Responses

Accepted