{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Rule Promotions API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Rule Promotions", "type": "folder" }, "items": [ { "info": { "name": "Get Rule Promotions", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/rule-promotions", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used." }, { "name": "page[offset]", "value": "", "type": "query", "description": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used." }, { "name": "filter", "value": "", "type": "query", "description": "This parameter accepts a filtering expression that uses specific operators and attributes. \n\n\nThe following operators and attributes are available when filtering on this endpoint. See [Supported Filtering Characters](/guides/Getting-Started/filtering#supported-characters).\n\n| Attribute | Type | Operator | Example |\n|:--------------------------|:-------------------|:-----------------------------|:----------------------------------------------------------------------|\n| `code` | `string`, `number` | `eq` | `eq(code,summer2024)` |\n| `name` | `string` | `like`,`ilike` | `ilike(name,'Summer *')` |\n| `enabled` | `boolean` | `eq` | `eq(enabled, true)` |\n| `stackable` | `boolean` | `eq` | `eq(stackable, true)` |\n| `override_stacking` | `boolean` | `eq` | `eq(override_stacking, true)` |\n| `start` | `date` | `lt`, `le`, `eq`, `gt`, `ge` | `gt(start, 2025-01-01T00:00:00.000Z)` |\n| `end` | `date` | `lt`, `le`, `eq`, `gt`, `ge` | `lt(end, 2025-01-01T00:00:00.000Z)` |\n| `rule_set.rules.strategy` | `string` | `eq`, `in` | `eq(rule_set.rules.strategy,account_tags)` |\n| `rule_set.rules.args` | `string` | `contains` | `contains(rule_set.rules.args, 11111111-1111-4111-1111-111111111111)` |\n| `account_tags` | `string` | `contains` | `contains(account_tags, 11111111-1111-4111-1111-111111111111)` |\n\nSome notes about filters:\n1. The `code` filter is case-insensitive. You can search for codes using only `numbers` or codes containing both `string` and `numbers`.\n2. The `rule_set.rules.*` filters do not search child conditions at present \n3. The `account_tags` filter will essentially search for any rule or child rule that has an `account_tags` strategy and the associated accounts.\n" } ] }, "docs": "Retrieves a list of rule-based promotions, including information such as discount type, eligibility criteria, \nand configuration details. This endpoint supports filtering to refine results based on specific promotion attributes.\n\nUse query parameters to filter promotions by:\n- **Code** – Retrieve a specific promotion by its code.\n- **Promotion name** – Search for promotions by name.\n- **Activation status** – Filter by whether a promotion is active or not.\n- **Stackability** – Identify promotions" }, { "info": { "name": "Create a Rule Promotion", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/rule-promotions", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new rule-based promotion, allowing flexible discount strategies based on cart or item conditions. \nPromotions can apply fixed or percentage-based discounts, apply automatically or via codes, and have eligibility rules \nbased on product attributes, cart total, SKU conditions, custom attributes, and more.\n\nThis endpoint supports a variety of promotion types, such as:\n- **Cart-wide discounts**\n- **Item-specific discounts**\n- **Shipping discounts**\n- **Combinations thereof**\n\n:::note\n\nThe " }, { "info": { "name": "Get a Rule Promotion by ID", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/rule-promotions/:promotionID", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "promotionID", "value": "", "type": "path", "description": "The unique identifier of the rule promotion." } ] }, "docs": "Retrieves a single Rule Promotion by the promotion ID. Responses include promotion specifications such as discount type, eligibility criteria, and configuration details.\n" }, { "info": { "name": "Update a Rule Promotion", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/v2/rule-promotions/:promotionID", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "promotionID", "value": "", "type": "path", "description": "The unique identifier of the promotion to be updated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing Rule Promotion specified by its promotion ID. This includes both **semantic and syntactic validation** to ensure correctness. For example, the start date must be earlier than the end date.\n\nEditable fields include:\n- `name`\n- `description`\n- `enabled`\n- `start`\n- `end`\n- `automatic`\n- `stackable`\n- `override_stacking`\n- `rule_set`\n\n:::note\n\nWhen updating the `automatic` field from `false` to `true`, the store must not exceed the maximum limit of **50 active and future automat" }, { "info": { "name": "Delete a Rule Promotion", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/v2/rule-promotions/:promotionID", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "promotionID", "value": "", "type": "path", "description": "The unique identifier of the promotion." } ] }, "docs": "Deletes an existing Rule Promotion identified by its promotion ID.\n\n- This action **permanently removes** the promotion and cannot be undone.\n- If the promotion is active, please ensure that its removal does not impact ongoing campaigns.\n\nA successful request returns a `204 No Content` response, indicating that the promotion has been deleted.\n" } ] } ], "bundled": true }