Skip to content

Rename rule promo to promo builder #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Aug 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/promotions-builder/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 151,
"label": "Promotions Builder"
}

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 2,
"label": "Promotions Builder API"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Action Limitations Overview
nav_label: Action Limitations Overview
title: Overview
nav_label: Overview
sidebar_position: 1
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Create Action Limitations and Exclusions Rule Promotion
nav_label: Create Action Limitations and Exclusions Rule promotion
title: Create Action Limitations and Exclusions Promotion
nav_label: Create Action Limitations and Exclusions Promotion
sidebar_position: 3
---

## `POST` Create Action Limitations and Exclusions Rule promotion
## `POST` Create Action Limitations and Exclusions Promotion

```http
https://useast.api.elasticpath.com/v2/rule-promotions
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 1.5,
"label": "Cart-level Promotions"
}
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Create a Cart Fixed Discount Rule Promotion
nav_label: Create a Cart Fixed Discount Rule Promotion
title: Create a Cart Fixed Discount
nav_label: Create a Cart Fixed Discount
sidebar_position: 3
---

## `POST` Create a Cart Fixed Discount Rule Promotion
## `POST` Create a Cart Fixed Discount

```http
https://useast.api.elasticpath.com/v2/rule-promotions
Expand All @@ -20,7 +20,7 @@ https://useast.api.elasticpath.com/v2/rule-promotions

### Body

For descriptions about the fields, refer to [Rules Promotion API overview](/docs/rule-promotions/rule-promotions-api/rule-promotions-api-overview).
For descriptions about the fields, refer to [Promotions Builder API overview](/docs/promotions-builder/promotions-builder-api/promotions-builder-api-overview).

## Request Example

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Create a Cart Percent Discount Rule Promotion
nav_label: Create a Cart Percent Discount Rule Promotion
title: Create a Cart Percent Discount
nav_label: Create a Cart Percent Discount
sidebar_position: 2
---

## `POST` Create a Cart Percent Discount Rule Promotion
## `POST` Create a Cart Percent Discount

```http
https://useast.api.elasticpath.com/v2/rule-promotions
Expand All @@ -20,7 +20,7 @@ https://useast.api.elasticpath.com/v2/rule-promotions

### Body

For descriptions about the fields, refer to [Rules Promotion API overview](/docs/rule-promotions/rule-promotions-api/rule-promotions-api-overview).
For descriptions about the fields, refer to [Promotions Builder API overview](/docs/promotions-builder/promotions-builder-api/promotions-builder-api-overview).

## Request Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ https://useast.api.elasticpath.com/v2/rule-promotions

### Body

For descriptions about the fields, refer to [Rules Promotion API overview](/docs/commerce-cloud/rule-promotions/rule-promotions-api/rule-promotions-api-overview).
For descriptions about the fields, refer to [Promotions Builder API overview](/docs/promotions-builder/promotions-builder-api/promotions-builder-api-overview).

## Request Example

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Create a Cart Percent Discount with Custom Attribute Rule Promotion
nav_label: Create a Cart Percent with Custom Attribute Rule Promotion
title: Create a Cart Percent Discount with Custom Attribute
nav_label: Create a Cart Percent with Custom Attribute
sidebar_position: 4
---

## `POST` Create a Cart Percent with Custom Attribute Rule Promotion
## `POST` Create a Cart Percent with Custom Attribute

```http
https://useast.api.elasticpath.com/v2/rule-promotions
Expand All @@ -20,7 +20,7 @@ https://useast.api.elasticpath.com/v2/rule-promotions

### Body

For descriptions about the other fields, refer to [Rules Promotion API overview](/docs/commerce-cloud/rule-promotions/rule-promotions-api/rule-promotions-api-overview).
For descriptions about the other fields, refer to [Promotions Builder API overview](/docs/promotions-builder/promotions-builder-api/promotions-builder-api-overview).

| Name | Required | Type | Description |
|:----------------|:---------|:---------|:-------------------------------------|
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 2,
"label": "Item-level Promotions"
}
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Create a Mixed of Cart and Item Percent Discount Rule Promotion
nav_label: Create a Mixed of Cart and Item Percent Discount Rule Promotion
title: Create a Mixed of Cart and Item Percent Discount
nav_label: Create a Mixed of Cart and Item Percent Discount
sidebar_position: 5
---

## `POST` Create a Mixed of Cart and Item Percent Discount Rule Promotion
## `POST` Create a Mixed of Cart and Item Percent Discount

You can create a rule promotion using a combination of cart and item percent discount.

Expand All @@ -24,7 +24,7 @@ https://useast.api.elasticpath.com/v2/rule-promotions

### Body

For descriptions of the fields, refer to [Rules Promotion API overview](/docs/rule-promotions/rule-promotions-api/rule-promotions-api-overview).
For descriptions of the fields, refer to [Promotions Builder API overview](/docs/promotions-builder/promotions-builder-api/promotions-builder-api-overview).

## Request Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To learn how to create product attributes, see [Product Attributes](/docs/api/fl

### Body

For descriptions about the fields, refer to [Rules Promotion API overview](/docs/rule-promotions/rule-promotions-api/rule-promotions-api-overview).
For descriptions about the fields, refer to [Promotions Builder API overview](/docs/promotions-builder/promotions-builder-api/promotions-builder-api-overview).

## Request Example

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Create an Item Fixed Discount Rule Promotion
nav_label: Create an Item Fixed Discount Rule Promotion
title: Create an Item Fixed Discount
nav_label: Create an Item Fixed Discount
sidebar_position: 1.5
---

## `POST` Create an Item Fixed Discount Rule Promotion
## `POST` Create an Item Fixed Discount

:::note
You can create an item discount where the mimimum discount amount is either $0 or 0%.
Expand All @@ -24,7 +24,7 @@ https://useast.api.elasticpath.com/v2/rule-promotions

### Body

For descriptions about the fields, refer to [Rules Promotion API overview](/docs/rule-promotions/rule-promotions-api/rule-promotions-api-overview).
For descriptions about the fields, refer to [Promotions Builder API overview](/docs/promotions-builder/promotions-builder-api/promotions-builder-api-overview).

## Request Example

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Create an Item Fixed Price Discount Rule Promotion
nav_label: Create an Item Fixed Price Discount Rule Promotion
title: Create an Item Fixed Price Discount
nav_label: Create an Item Fixed Price Discount
sidebar_position: 1
---

## `POST` Create an Item Fixed Price Discount Rule Promotion
## `POST` Create an Item Fixed Price Discount

```http
https://useast.api.elasticpath.com/v2/rule-promotions
Expand All @@ -20,7 +20,7 @@ https://useast.api.elasticpath.com/v2/rule-promotions

### Body

For descriptions about the fields, refer to [Rules Promotion API overview](/docs/rule-promotions/rule-promotions-api/rule-promotions-api-overview).
For descriptions about the fields, refer to [Promotions Builder API overview](/docs/promotions-builder/promotions-builder-api/promotions-builder-api-overview).

## Request Example

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create an Item Rule Promotion with Sub Conditions
nav_label: Create an Item Rule Promotion with Sub Conditions
title: Create an Item Promotion with Sub Conditions
nav_label: Create an Item Promotion with Sub Conditions
nav_position: 8
---

Expand Down Expand Up @@ -31,7 +31,7 @@ https://useast.api.elasticpath.com/v2/rule-promotions

### Body

For descriptions about the fields, refer to [Rules Promotion API overview](/docs/commerce-cloud/rule-promotions/rule-promotions-api/rule-promotions-api-overview).
For descriptions about the fields, refer to [Promotions Builder API overview](/docs/promotions-builder/promotions-builder-api/promotions-builder-api-overview).

The following request example outlines how a 50% discount applies to items that meet all the specified conditions. The main rule is based on the cart's total value, while the sub conditions focus on item categories and attributes.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Create an Item Discount with Condition Rule Promotion
nav_label: Create a Condition Rule Promotion
title: Create an Item Discount with Condition
nav_label: Create an Item Discount with Condition
sidebar_position: 2
---

## `POST` Create an Item Discount with Condition Rule Promotion
## `POST` Create an Item Discount with Condition

```http
https://useast.api.elasticpath.com/v2/rule-promotions
Expand All @@ -20,7 +20,7 @@ https://useast.api.elasticpath.com/v2/rule-promotions

### Body

For descriptions about the fields, refer to [Rules Promotion API overview](/docs/rule-promotions/rule-promotions-api/rule-promotions-api-overview).
For descriptions about the fields, refer to [Promotions Builder API overview](/docs/promotions-builder/promotions-builder-api/promotions-builder-api-overview).

## Request Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ https://useast.api.elasticpath.com/v2/rule-promotions
```
You can create rule promotions with nested conditions, where the use of `or` with `item_sku` and `item_product_id` conditions allows for flexible and effective rule management.

For more information on how to handle item SKU and product ID together, see [Handling both Item SKU and Product ID together in Rule Promotion](/docs/rule-promotions/overview#handling-both-item-sku-and-product-id-together-in-rule-promotion).
For more information on how to handle item SKU and product ID together, see [Handling both Item SKU and Product ID together](/docs/promotions-builder/overview#handling-both-item-sku-and-product-id-together).

## Parameters

Expand All @@ -24,7 +24,7 @@ For more information on how to handle item SKU and product ID together, see [Han

### Body

For descriptions of the fields, refer to [Rules Promotion API overview](/docs/rule-promotions/rule-promotions-api/rule-promotions-api-overview).
For descriptions of the fields, refer to [Promotions Builder API overview](/docs/promotions-builder/promotions-builder-api/promotions-builder-api-overview).


## Request Example
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Create an Item Percent Discount with Limitation and Condition Rule Promotion
nav_label: Create an Item Percent Discount with Limitation and Condition Rule Promotion
title: Create an Item Percent Discount with Limitations and Conditions
nav_label: Create an Item Percent Discount with Limitations and Conditions
sidebar_position: 3
---

## `POST` Create an Item Percent Discount with Limitation and Condition Rule Promotion
## `POST` Create an Item Percent Discount with Limitations and Conditions

```http
https://useast.api.elasticpath.com/v2/rule-promotions
Expand All @@ -20,7 +20,7 @@ https://useast.api.elasticpath.com/v2/rule-promotions

### Body

For descriptions about the fields, refer to [Rules Promotion API overview](/docs/rule-promotions/rule-promotions-api/rule-promotions-api-overview).
For descriptions about the fields, refer to [Promotions Builder API overview](/docs/promotions-builder/promotions-builder-api/promotions-builder-api-overview).

## Request Example

Expand Down
Loading