Quantity Deals

Get Quantity Deal

Changed on

Retrieves a specific quantity deal.

get/v1/shops/{shopId}/quantity-deals/{dealId}

Request

Response

idinteger
shop_idinteger
namestring
product_idinteger
variant_idinteger
buy_quantityinteger
discounted_quantityinteger
percentagestring
max_uses_per_cartstring nullable
priorityinteger
starts_atstring nullable
ends_atstring nullable
enabledboolean
created_atstring
updated_atstring

Example response

{
  "id": 1,
  "shop_id": 1,
  "name": "Bulk Discount",
  "product_id": 1,
  "variant_id": 1,
  "buy_quantity": 5,
  "discounted_quantity": 5,
  "percentage": "10.00",
  "max_uses_per_cart": null,
  "priority": 0,
  "starts_at": null,
  "ends_at": null,
  "enabled": true,
  "created_at": "2026-11-06T10:45:19.000000Z",
  "updated_at": "2026-11-06T10:45:19.000000Z",
  "product": {
    "id": 1,
    "name": "License Keys"
  },
  "variant": {
    "id": 1,
    "name": "Standard"
  }
}

Changes

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • warning

      removed the optional property / from the response with the status