younifyd
Menu

Update Rule

Updates a catalog rule

PUT/catalogs/rules/{catalog_rule_id}

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Update Rule action (under Catalog).
  3. Fill in the fields below, then reference the result from later steps as {{updateRule.response.data}}.

Request

Path parameters

catalog_rule_idstringrequired

The catalog rule ID.

Request body

Enter the body as JSON in the step's Body field.

dataobjectrequired
idstringrequired

The catalog rule ID. Use this to get, modify, or delete the catalog rule.

attributesobject11 fields
typestringrequired

This represents the type of object being returned. Always `catalog_rule`.

One ofcatalog_rule

json
{
  "data": {
    "id": "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
    "type": "catalog_rule",
    "attributes": {
      "name": "rule-123",
      "description": "Catalog Rule for most favored customers",
      "account_ids": [
        "string"
      ],
      "account_tag_ids": [
        "string"
      ],
      "customer_ids": [
        "string"
      ],
      "channels": [
        "string"
      ],
      "schedules": [
        {
          "valid_from": "2020-09-22T09:00:00",
          "valid_to": "2020-09-22T09:00:00"
        }
      ],
      "tags": [
        "string"
      ],
      "catalog_id": "d09b4e16-08a5-4f42-817c-6e0d98acbb63",
      "pricebook_ids": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "priority": 0
        }
      ],
      "search_profile_slug": "vip-search"
    }
  }
}

Response

Returns 200 with an object. Read it in later steps with {{updateRule.response.data.<field>}}.

dataobject

A catalog rule specifies which catalog to use for a given shopper context.

idstringrequired

The catalog rule ID. Use this to get, modify, or delete the catalog rule.

attributesobjectrequired13 fields
typestringrequired

This represents the type of object being returned. Always `catalog_rule`.

One ofcatalog_rule

metaobject4 fields

A rule's metadata.

linksobject

Links allow you to move between requests.

selfstring (uri)

Single entities use a `self` parameter with a link the specific resource.

firststring (uri)

Always the first page.

laststring (uri)

This is `null` if there is only one page.

prevstring (uri)

This is `null` if there is only one page.

nextstring (uri)

This is `null` if there is only one page.

json
{
  "data": {
    "id": "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
    "attributes": {
      "name": "rule-123",
      "catalog_id": "d09b4e16-08a5-4f42-817c-6e0d98acbb63",
      "created_at": "2020-09-22T09:00:00",
      "updated_at": "2020-09-22T09:00:00",
      "description": "Catalog Rule for most favored customers",
      "account_ids": [
        "string"
      ],
      "account_tag_ids": [
        "string"
      ],
      "customer_ids": [
        "string"
      ],
      "channels": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "schedules": [
        {
          "valid_from": "2020-09-22T09:00:00",
          "valid_to": "2020-09-22T09:00:00"
        }
      ],
      "pricebook_ids": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "priority": 0
        }
      ]
    },
    "type": "catalog_rule",
    "meta": {
      "similarity_score": 100,
      "active": false,
      "resolved_for_shopper": true,
      "release_id": "string"
    }
  },
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.