Flavours API
ProductModifier

List Product Modifiers

GET
/api/v2/products/{productId}/modifiers

List the modifiers of a product.

AuthorizationBearer <token>

You can retrieve your token by logging in.

In: header

Path Parameters

productId*string

Header Parameters

X-API-Version*string

API contract version to target. See the Changelog for what changed in each version.

Default"2.0.0"
Value in"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"

Request Body

application/json

page?|

Must be at least 1.

per_page?|

Must be at least 1.

search?|
sort?|
key_by?|
includes*array<>
filter?

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.flavours.sa/dev/api/v2/products/sit/modifiers" \  -H "X-API-Version: 2.3.0" \  -H "Content-Type: application/json" \  -d '{    "includes": [      "non"    ]  }'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Modifiers retrieved successfully."
  },
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 717712180402818,
        "modifierable_id": "41a45926-7f75-481d-a78a-682ba4a647a1",
        "name_en": null,
        "name_ar": null,
        "type": "OPTION",
        "calorie": null,
        "price": 20,
        "tax": 0,
        "total": 20,
        "cost": null,
        "profit": null,
        "is_tax_included": true,
        "deleted_at": null,
        "barcode": null,
        "barcode_img": null,
        "weight_amount": null,
        "weight_unit": null,
        "market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
        "branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
        "modifierable_type": "PRODUCT_MODIFIER_PRODUCT",
        "stock": 50,
        "product_id": "41a45926-7f75-481d-a78a-682ba4a647a1",
        "sku": null
      },
      {
        "id": 717712180464144,
        "modifierable_id": "41a45926-7f75-481d-a78a-682ba4a647a1",
        "name_en": "Qui consequatur",
        "name_ar": "ut",
        "type": "OPTION",
        "calorie": null,
        "price": 26.3,
        "tax": 0,
        "total": 26.3,
        "cost": null,
        "profit": null,
        "is_tax_included": true,
        "deleted_at": null,
        "barcode": null,
        "barcode_img": null,
        "weight_amount": null,
        "weight_unit": null,
        "market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
        "branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
        "modifierable_type": "PRODUCT_MODIFIER_PRODUCT",
        "stock": null,
        "product_id": "41a45926-7f75-481d-a78a-682ba4a647a1",
        "sku": null
      }
    ],
    "first_page_url": "http://localhost:8000/api/v2/products/41a45926-7f75-481d-a78a-682ba4a647a1/modifiers?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://localhost:8000/api/v2/products/41a45926-7f75-481d-a78a-682ba4a647a1/modifiers?page=1",
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "page": null,
        "active": false
      },
      {
        "url": "http://localhost:8000/api/v2/products/41a45926-7f75-481d-a78a-682ba4a647a1/modifiers?page=1",
        "label": "1",
        "page": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "page": null,
        "active": false
      }
    ],
    "next_page_url": null,
    "path": "http://localhost:8000/api/v2/products/41a45926-7f75-481d-a78a-682ba4a647a1/modifiers",
    "per_page": 20,
    "prev_page_url": null,
    "to": 2,
    "total": 2
  }
}
{
  "meta": {
    "code": 401,
    "status": "error",
    "message": "Unauthenticated."
  },
  "data": null
}
{
  "meta": {
    "code": 403,
    "status": "error",
    "message": "Unauthorized."
  },
  "data": null
}
{
  "meta": {
    "code": 404,
    "status": "error",
    "message": "Resource not found."
  },
  "data": null
}
{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}