Create a Catalog Rule

If you have multiple catalogs, create catalog rule resources. With catalog rules, you can display different catalogs to different shoppers. For example, you can display a preferred pricing catalog to a few special customers. Or you can display one catalog to shoppers using your website and a different catalog to shoppers using your mobile app. Finally, you can define custom criteria by creating tags.

note

If you have one catalog for all customers and channels, you can omit creating this resource.

For ideas about the kinds of business scenarios you can achieve with catalog rules, see Catalog Rules. To understand how catalogs are matched to shoppers by using rules, see Resolving Catalog Rules.

tip

If you want to use the Catalog View API to display v2 products, you must create a catalog rule with catalog_id=legacy. For more information, see The Legacy Catalog Object and The Rule Object.

POST Create a Catalog Rule

https://api.moltin.com/pcm/catalogs/rules

Creates a rule for a catalog.

Request

Response -PCM

Headers:

Name	Required	Type	Description
Authorization	Required	string	The Bearer token to grant access to the API. Note that this must be a client credentials token.

Body:

Required. A Rule object with the following attributes.

A rule object with only the required attributes defined applies to all customers and all channels. If no other catalog rules apply, the store displays this base catalog.

Attribute	Required	Type	Description
type	Required	string	Always: catalog_rule
attributes.name	Required	string	The name of the rule without spaces.
attributes.description	Optional	string	The purpose for this rule.
attributes.catalog_id	Required	string	The unique identifier of the catalog for this rule. V2 If you want to display a catalog that contains v2 Products, Brands, Categories, and Collections, specify legacy.
attributes.customer_ids	Optional	[array]	The list of customers who are eligible to see this catalog. If empty, the rule matches all customers.
attributes.channels	Optional	[array]	The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently you must set the EP-Channel header in your requests.
attributes.tags	Optional	[array]	A list of user-defined tags that can be used to to further restrict the eligibility criteria for this rule. Requests populate the rule tag using the EP-Context-Tag header.

201 Created

{
    "data": {
        "attributes": {
            "catalog_id": "aea233e7-1300-48ce-9b45-7d0c0b60dde3",
            "created_at": "2021-04-12T16:39:27.635Z",
            "customer_ids": [
                "fcb065be-0af3-4bb1-94c2-a1ffc53277a9"
            ],
            "description": "Preferred customers",
            "name": "Preferred customers",
            "updated_at": "2021-04-12T16:39:27.635Z"
        },
        "id": "a01fc6f9-70f9-4d08-af8f-4357e35febd4",
        "type": "catalog_rule"
    },
    "links": {
        "self": "/pcm/catalogs/rules/a01fc6f9-70f9-4d08-af8f-4357e35febd4"
    }
}

cURL

curl -X POST https://api.moltin.com/pcm/catalogs/rules \
     -H "Authorization: Bearer XXXX" \
     -H "Content-Type: application/json" \
     -d $'{
        "data": {
            "type": "catalog_rule",
            "attributes": {
                "name": "Preferred customers",
                "description": "Preferred customers",
                "catalog_id": "aea233e7-1300-48ce-9b45-7d0c0b60dde3",
                "customer_ids": ["fcb065be-0af3-4bb1-94c2-a1ffc53277a9"]
            }
        }
    }'