Once the seller's channel stores are linked into Mirakl Connect, the connector must also import the channel catalog configuration. There are two reasons to import these configurations:
- Allow the seller to configure and map Mirakl Connect offer fields with the channel ones.
- Allow the seller to configure offer flows between Mirakl Connect and the channel.
These configurations are used when synchronizing offer data to the channel through the connector.
There are two catalog configurations to import:
- Offer attributes: Additional channel offer attributes that do not exist in Mirakl Connect.
- Offer use cases: Offer flows configuration and the offer fields to add in each flow.
These configurations are described in the next sections.
To import the channel offer fields, the connector must fetch the fields from the channel and create them in Mirakl Connect using the configureChannelCatalog API. Add the fields to the custom_attributes array within the offer_configuration node.
Note that this API works in a replace mode. For more information, refer to the REST APIs reference.
Important: The connector must synchronize only the fields that do not already exist in the offer data model standard fields in Mirakl Connect. These standard fields are listed below:
- id
- gtins
- brand
- category
- titles
- descriptions
- images
- standard_prices
- discount_prices
- quantities
The offer use cases represent the configuration of the offer flows between Mirakl Connect and the channel.
There are two use cases to configure:
- Offer creation: the offer creation flow and the related offer fields
- Offer update: the offer update flow and the related offer fields
Each use case may or may not be supported and contains a list of attributes related to it.
To sync the offer use cases configuration, the connector must fetch the configuration from the channel and create it in Mirakl Connect using the configureChannelCatalog API. Add the configuration to the use_case_configurations node.
Note that this API operates in replace mode. For more information, refer to the REST APIs reference.
Important: The standard_attributes node in the payload must contain the Mirakl Connect standard field IDs.