Public API v2: Responses

Every response has the same envelope.

Field	Notes
`success`, `status`	`true` / `"success"`, or `false` / `"error"`.
`data`	The result: an object, or an array for lists.
`errors`	On errors: `code`, `message` and, when fields are wrong, `details`. See Errors & retries.
`meta.request_id`	Quote it to support. Also in the `X-Request-Id` header.
`meta.rate_limit`	Cost of the call and points left. See Rate limits.
`meta.pagination`	On lists. See Paging.

A list 200

{
  "success": true,
  "status": "success",
  "data": [
    {
      "id": "90718",
      "name": "VIP 10%",
      "priority": 1,
      "status": "disabled",
      "apply_to": "customer_tags",
      "customer_ids": [],
      "customer_tags": [
        "vip"
      ],
      "company_location_ids": [],
      "exclude_from": "none",
      "exc_customer_tags": [],
      "exc_customers": [],
      "exc_company_location_ids": [],
      "product_condition_type": "by_collections",
      "product_ids": [],
      "product_collections": [
        "482901234567"
      ],
      "product_tags": [],
      "variant_ids": [],
      "exc_product_type": "none",
      "exc_specific_products": [],
      "exc_product_collections": [],
      "exc_product_tags": [],
      "exc_product_variants": [],
      "market_condition_type": "all",
      "market_ids": [],
      "discount_type": "decrease_percentage",
      "discount_value": "10.00",
      "start_at": "2026-10-31T17:00:00.000Z",
      "end_at": null,
      "created_at": "2026-10-21T09:32:48.000Z",
      "updated_at": "2026-10-21T09:32:48.000Z"
    }
  ],
  "meta": {
    "timestamp": "2026-10-21T09:32:50.797Z",
    "version": "v2",
    "request_id": "fbdc5205-5f7e-45d4-a6e2-dd283106c2b8",
    "rate_limit": {
      "cost": 10,
      "limit": 600,
      "remaining": 590,
      "restore_rate": 10
    },
    "pagination": {
      "limit": 2,
      "next_cursor": null,
      "prev_cursor": null,
      "links": {
        "self": "/api/v2/custom-pricing/rules?limit=2&filter_name=VIP",
        "next": null,
        "prev": null
      }
    }
  }
}

An error 404

{
  "success": false,
  "status": "error",
  "errors": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Resource not found"
  },
  "meta": {
    "timestamp": "2026-10-21T09:34:51.894Z",
    "version": "v2",
    "request_id": "3a93c7ca-3983-4230-af09-611e95011ee7",
    "rate_limit": {
      "cost": 10,
      "limit": 600,
      "remaining": 590,
      "restore_rate": 10
    }
  }
}