Skip to navigation
DocsAdminCatalog and InventoryPromotionsExamples

Category Promotion Code Samples

Apply a $ or % discount to each item in one or more categories

Example request
{
  "name": "20 dollars off all garden material",
  "redemption_type": "AUTOMATIC",
  "rules": [
    {
      "action": {
        "cart_items": {
          "discount": {
            "fixed_amount": "20"
          },
          "strategy": "LEAST_EXPENSIVE",
          "as_total": false,
          "include_items_considered_by_condition": false,
          "items": {
            "categories": [
              24
            ]
          }
        }
      },
      "apply_once": true,
      "stop": false
    }
  ],
  "notifications": [
    {
      "type": "UPSELL",
      "content": "",
      "locations": [
        "CART_PAGE"
      ]
    },
    {
      "type": "ELIGIBLE",
      "content": "",
      "locations": [
        "CART_PAGE"
      ]
    },
    {
      "type": "APPLIED",
      "content": "",
      "locations": [
        "CART_PAGE"
      ]
    }
  ],
  "stop": false,
  "start_date": "2019-01-29T00:00:00+00:00",
  "status": "ENABLED"
}

Apply a $ or % discount to each item in one or more categories, exclude items on sale

Example request
{
  "name": "20 dollars off all garden material, exclude items on sale",
  "redemption_type": "AUTOMATIC",
  "rules": [
    {
      "action": {
        "cart_items": {
          "discount": {
            "fixed_amount": "20"
          },
          "strategy": "LEAST_EXPENSIVE",
          "as_total": false,
          "include_items_considered_by_condition": false,
          "exclude_items_on_sale": true,
          "items": {
            "categories": [
              19
            ]
          }
        }
      },
      "apply_once": true,
      "stop": false
    }
  ]
}

Buy X units in (category A) and get Y additional units in the same category free (must be of equal or lesser value)

Example request
{
  "name": "Buy X units in (Category A) and get Y additional units in the same category free (must be of equal or lesser value)",
  "redemption_type": "AUTOMATIC",
  "rules": [
    {
      "action": {
        "cart_items": {
          "discount": {
            "percentage_amount": "100"
          },
          "strategy": "LEAST_EXPENSIVE",
          "as_total": false,
          "include_items_considered_by_condition": false,
          "items": {
            "categories": [
              23
            ]
          },
          "quantity": 1
        }
      },
      "apply_once": true,
      "stop": false,
      "condition": {
        "cart": {
          "items": {
            "categories": [
              23
            ]
          },
          "minimum_quantity": 1
        }
      }
    }
  ],
  "notifications": [
    {
      "type": "UPSELL",
      "content": "<div>&nbsp;</div>\r\n<div>&nbsp;</div>",
      "locations": [
        "CART_PAGE"
      ]
    },
    {
      "type": "ELIGIBLE",
      "content": "<div>&nbsp;</div>\r\n<div>&nbsp;</div>",
      "locations": [
        "CART_PAGE"
      ]
    },
    {
      "type": "APPLIED",
      "content": "<div>&nbsp;</div>\r\n<div>&nbsp;</div>",
      "locations": [
        "CART_PAGE"
      ]
    }
  ],
  "stop": false,
  "start_date": "2019-02-01T05:00:00+00:00",
  "status": "ENABLED"
}

Buy three items in a category for the price of two (lowest priced item discounted)

Example request
{
  "name": "Buy three items in a category for the price of two (lowest priced item discounted)",
  "redemption_type": "AUTOMATIC",
  "rules": [
    {
      "apply_once": false,
      "condition": {
        "cart": {
          "items": {
            "categories": [
              21
            ]
          },
          "minimum_quantity": 2
        }
      },
      "action": {
        "cart_items": {
          "discount": {
            "percentage_amount": "100"
          },
          "strategy": "LEAST_EXPENSIVE",
          "items": {
            "categories": [
              21
            ]
          },
          "quantity": 1
        }
      }
    }
  ]
}

Buy product X or items from category Y and get $10 off items from category Z

Example request
{
  "name": "Buy product X or items from category Y and get $10 off items from category Z",
  "redemption_type": "AUTOMATIC",
  "rules": [
    {
      "apply_once": true,
      "condition": {
        "cart": {
          "items": {
            "or": [
              {
                "categories": [
                  1
                ]
              },
              {
                "products": [
                  1
                ]
              }
            ]
          },
          "minimum_quantity": 1
        }
      },
      "action": {
        "cart_items": {
          "discount": {
            "fixed_amount": 10
          },
          "items": {
            "categories": [
              31
            ]
          }
        }
      }
    }
  ]
}

Buy three from category X, and get one from category Y free

Example request
{
  "name": "Buy three from category X and get one from category Y free",
  "redemption_type": "AUTOMATIC",
  "rules": [
    {
      "apply_once": false,
      "condition": {
        "cart": {
          "items": {
            "categories": [
              24
            ]
          },
          "minimum_quantity": 3
        }
      },
      "action": {
        "cart_items": {
          "discount": {
            "percentage_amount": 100
          },
          "items": {
            "categories": [
              24
            ]
          },
          "quantity": 1
        }
      }
    }
  ]
}

Spend $X from category X and get product Y free

Example request
{
  "name": "Buy $X from category X and get product Y free",
  "redemption_type": "AUTOMATIC",
  "rules": [
    {
      "apply_once": false,
      "condition": {
        "cart": {
          "items": {
            "categories": [
              19
            ]
          },
          "minimum_spend": 300
        }
      },
      "action": {
        "cart_items": {
          "discount": {
            "percentage_amount": 100
          },
          "items": {
            "products": [
              81
            ]
          },
          "quantity": 1
        }
      }
    }
  ]
}