{
  "opencollection": "1.0.0",
  "info": {
    "name": "Addresses Introduction Account Addresses Rule Promotion Codes API",
    "version": "25.1126.6886238"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Rule Promotion Codes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Rule Promotion Codes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/rule-promotions/:promotionID/codes",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "promotionID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the rule promotion."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "This parameter accepts a filtering expression that uses specific operators and attributes. Promotion codes are case-insensitive.\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`, `gt`       |  `eq(code,summer2024)`, `gt(code,2024)` |\n"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Specifies the order of the codes that will be returned.\n"
              }
            ]
          },
          "docs": "Retrieves the list of promotion codes associated with a specific Rule Promotion.\n\n- Returns all codes generated for the given promotion ID, including details on usage limits and redemption status.\n- Supports both automatically generated and manually created promotion codes.\n- Can be used to verify whether a promotion code is still valid or has reached its usage limit.\n"
        },
        {
          "info": {
            "name": "Create Rule Promotion Codes",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/rule-promotions/:promotionID/codes",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "promotionID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the rule promotion."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates new promotion codes for a specific rule promotion, allowing customers to redeem discounts based on predefined conditions.\n\n- Supports  bulk creation of multiple promotion codes in a single request.\n- Each code can have individual usage limits.\n- Can optionally assign codes to specific users to enforce targeted promotions.\n- The promotion codes are case-insensitive.\n\n:::note\n\nRegarding first time shopper limitations:\n- Orders without payment transactions do not count as completed purchase"
        },
        {
          "info": {
            "name": "Delete Rule Promotion Codes",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/v2/rule-promotions/:promotionID/codes",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "promotionID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the rule promotion."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Deletes one or more promotion codes from a specific rule promotion.\n\n- Supports **bulk deletion**, allowing multiple codes to be removed in a single request.\n- Removes promotion codes permanently, making them unavailable for future use.\n- If a code has already been redeemed, it will be removed from the system but may still reflect in historical transactions.\n\nA successful request returns a `204 No Content` response, indicating the specified promotion codes have been deleted.\n"
        },
        {
          "info": {
            "name": "Delete A Single Rule Promotion Code",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/v2/rule-promotions/:promotionID/codes/:codeID",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "promotionID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the rule promotion."
              },
              {
                "name": "codeID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the rule promotion code."
              }
            ]
          },
          "docs": "Deletes a single promotion code from a specific rule promotion.\n\n- Permanently removes the specified promotion code, making it unavailable for future use.\n- Can be used to **revoke a specific code** without affecting other codes under the same promotion.\n- If the code has already been redeemed, it will still be removed from the system but may still reflect in historical transactions.\n\nA successful request returns a `204 No Content` response, indicating the specified promotion code has been delet"
        }
      ]
    }
  ],
  "bundled": true
}