{
  "opencollection": "1.0.0",
  "info": {
    "name": "Addresses Introduction Account Addresses Rule Promotion Usages API",
    "version": "25.1126.6886238"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Rule Promotion Usages",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Anonymize Rule Promotion Usages",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/rule-promotions/usages/anonymize",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Anonymizes user-related data in Rule Promotion usage records. \nThis operation is typically used for GDPR compliance or privacy-related requests.\n\n- This process replaces identifiable user data with anonymized placeholders.\n- Affects all recorded promotion usages where customer data is stored.\n- Does not impact historical transaction records or applied discounts.\n\nA successful request returns a `200 OK` response with the anonymized usage records.\n"
        },
        {
          "info": {
            "name": "Get Rule Promotion Usages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/rule-promotions/:promotionID/usages",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "promotionID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the rule promotion."
              },
              {
                "name": "filter",
                "value": "eq(code,cart1off)",
                "type": "query",
                "description": "Filter attributes to refine the usage records. Supported attributes:\n- `id`: Filter by usage ID.\n- `code`: Filter by promotion code.\n- `used_on`: Filter by usage date with operators `gt`, `ge`, `le`, `lt`.\n"
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query"
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves a list of usage records for a specific Rule Promotion.\n\n- Provides details about when and how a promotion was used.\n- Can be filtered and paginated to refine results.\n- Useful for analyzing promotion effectiveness and customer engagement.\n"
        },
        {
          "info": {
            "name": "Get Rule Promotion Code Usages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/rule-promotions/:promotionID/codes/:code/usages",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "promotionID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the rule promotion."
              },
              {
                "name": "code",
                "value": "",
                "type": "path",
                "description": "The specific promotion code for which to retrieve usage records."
              },
              {
                "name": "filter",
                "value": "gt(used_on,2024-02-01T00:00:00Z)",
                "type": "query",
                "description": "Filter attributes to refine the results. Supported attributes:\n- `id`: Filter by usage ID.\n- `used_on`: Filter by date with operators `gt`, `ge`, `le`, `lt`.\n"
              },
              {
                "name": "page[limit]",
                "value": "10",
                "type": "query",
                "description": "The number of records per page."
              },
              {
                "name": "page[offset]",
                "value": "0",
                "type": "query",
                "description": "The number of records to offset the results by."
              }
            ]
          },
          "docs": "Retrieves a list of usage records for a specific Rule Promotion code.\n\n- Provides insights into how many times a specific code was used.\n- Can be filtered and paginated to refine results.\n- Useful for tracking the performance of individual promotion codes.\n"
        }
      ]
    }
  ],
  "bundled": true
}