# Price Tags
# The Price Tag Object
The price tag allows the business to have one product with multiple prices to avoid duplicating products for different order sources and order types.
Users can create multiple price tags and apply them to products, combos, or modifier options.
# Sample
{
"data": [
{
"order_tag": {
"id": "965ddf6f-be02-4c39-b1aa-8e4e10d92d99",
"type": 4,
"name": "tag",
"name_localized": "tag",
"created_at": "2022-05-23 09:47:27",
"updated_at": "2022-05-23 09:47:27",
"deleted_at": null
},
"timed_events": [],
"branches": [
{
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "Branch 1",
"name_localized": "branch1",
"reference": "B01",
"type": 1,
"latitude": "30.033333",
"longitude": "31.233334",
"phone": null,
"opening_from": "01:00",
"opening_to": "22:00",
"inventory_end_of_day_time": "06:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank you",
"settings": {
"branch_tax_number": "12345",
"branch_tax_registration_name": "tax-reg-name"
},
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-05-18 22:00:11",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
},
{
"id": "9598b48e-1646-446b-92b6-08dd59bc245e",
"name": "Branch 2",
"name_localized": null,
"reference": "B02",
"type": 1,
"latitude": null,
"longitude": null,
"phone": null,
"opening_from": "00:00",
"opening_to": "00:00",
"inventory_end_of_day_time": "00:00",
"receipt_header": null,
"receipt_footer": null,
"settings": null,
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-03-01 08:24:06",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
}
],
"id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"name": "Online ordering pricing",
"name_localized": null,
"created_at": "2022-05-22 09:34:42",
"updated_at": "2022-06-29 11:03:29",
"deleted_at": null,
"products": [
{
"id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"category_id": "95ad35ad-2577-443b-a29a-04394d67909e",
"sku": "sk-0006",
"barcode": null,
"name": "BBQ Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 50,
"cost": null,
"calories": null,
"created_at": "2022-02-24 14:07:26",
"updated_at": "2022-03-20 21:52:28",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"product_id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e",
"price": 40
}
},
{
"id": "95afc8fe-875f-402b-a051-9bbdae39bd73",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"category_id": "95ad35ad-2577-443b-a29a-04394d67909e",
"sku": "sk-0010",
"barcode": null,
"name": "Chicken Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 38,
"cost": null,
"calories": null,
"created_at": "2022-02-25 20:50:39",
"updated_at": "2022-06-07 14:40:56",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"product_id": "95afc8fe-875f-402b-a051-9bbdae39bd73",
"price": 30
}
},
{
"id": "95afcd8d-6ba8-4e0f-b878-d58e44bc8b2b",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"category_id": "9598e026-dde3-4aef-9f88-9e5e53836da2",
"sku": "sk-0013",
"barcode": null,
"name": "Cola",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 5,
"cost": null,
"calories": null,
"created_at": "2022-02-25 21:03:24",
"updated_at": "2022-02-25 21:03:24",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"product_id": "95afcd8d-6ba8-4e0f-b878-d58e44bc8b2b",
"price": 4
}
}
],
"modifier_options": [
{
"id": "95a52ec7-82b8-4300-b794-3059b79db30a",
"modifier_id": "959bcf39-13cc-4c36-85d6-e9277cdc18d6",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"name": "BBQ Sauce",
"name_localized": null,
"sku": "sk-0003",
"is_active": true,
"costing_method": 2,
"price": 2,
"cost": null,
"calories": null,
"created_at": "2022-02-20 14:21:09",
"updated_at": "2022-05-12 07:58:33",
"deleted_at": null,
"index": 0,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"modifier_option_id": "95a52ec7-82b8-4300-b794-3059b79db30a",
"price": 0
}
},
{
"id": "95afc868-e245-48ee-87e6-5791a26489df",
"modifier_id": "959bcf39-13cc-4c36-85d6-e9277cdc18d6",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"name": "Ranch Sauce",
"name_localized": null,
"sku": "sk-0009",
"is_active": true,
"costing_method": 2,
"price": 3,
"cost": null,
"calories": null,
"created_at": "2022-02-25 20:49:01",
"updated_at": "2022-03-13 22:22:04",
"deleted_at": null,
"index": 0,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"modifier_option_id": "95afc868-e245-48ee-87e6-5791a26489df",
"price": 0
}
}
],
"combo_options": [
{
"id": "95afd4f4-be7c-4262-82f3-822eff400492",
"combo_item_id": "95afd492-fbc3-436f-b0a2-08b55bcdd518",
"name": "BBQ Burger",
"name_localized": null,
"created_at": "2022-02-25 21:24:06",
"updated_at": "2022-02-25 21:24:06",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"combo_option_id": "95afd4f4-be7c-4262-82f3-822eff400492",
"price": 20,
"combo_size_id": "95afd47d-2c97-4b79-9f32-2af25b2b9908",
"product_id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e"
}
},
{
"id": "95afd56e-d65c-4c78-a880-ce6924217f16",
"combo_item_id": "95afd530-5fd2-4b63-9218-c888e7c6c502",
"name": "Cola",
"name_localized": null,
"created_at": "2022-02-25 21:25:26",
"updated_at": "2022-02-25 21:25:26",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"combo_option_id": "95afd56e-d65c-4c78-a880-ce6924217f16",
"price": 3,
"combo_size_id": "95afd487-a867-43bf-b538-3b232f4090b7",
"product_id": "95afcd8d-6ba8-4e0f-b878-d58e44bc8b2b"
}
}
]
}
]
}
# Attributes
| Field | Type | Rule | Description |
|---|---|---|---|
id | string | Unique identifier for the Price Tag. | |
name* | string | updatable | Name of the Price Tag. |
name_localized | string | nullable updatable | Localized name of the Price Tag. |
timed_events | array | updatable includable | List of Timed Event objects attached to the Price Tag. |
products | array | updatable includable | List of Products objects attached to the Price Tag. |
combo_options | array | updatable includable | List of Combo options objects attached to the Price Tag. |
order_tag | array | updatable includable | The Order Tag objects attached to the Price Tag. |
modifier_options | array | updatable includable | List of Modifier Options ids attached to the Price Tag |
branches | array | updatable includable | List of Branch objects attached to the Price Tag. |
created_at | string | sortable | Time YYYY-MM-DD HH-MM-SS in UTC at which the Price tag was created. |
updated_at | string | sortable | Time YYYY-MM-DD HH-MM-SS in UTC at which the Price tag was updated. |
deleted_at | string | nullable | Time YYYY-MM-DD HH-MM-SS in UTC at which the Price tag was deleted. |
# List Price Tags
GET /price_tags
# Scopes
general.read
# Filters
idnamename_localizedtimed_events.idorder_tag.idbranches.idupdated_afteris_deletedcreated_onupdated_ondeleted_on
# Response
{
"data": [
{
"order_tag": {
"id": "965ddf6f-be02-4c39-b1aa-8e4e10d92d99",
"type": 4,
"name": "tag",
"name_localized": "tag",
"created_at": "2022-05-23 09:47:27",
"updated_at": "2022-05-23 09:47:27",
"deleted_at": null
},
"timed_events": [],
"branches": [
{
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "Branch 1",
"name_localized": "branch1",
"reference": "B01",
"type": 1,
"latitude": "30.033333",
"longitude": "31.233334",
"phone": null,
"opening_from": "01:00",
"opening_to": "22:00",
"inventory_end_of_day_time": "06:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank you",
"settings": {
"branch_tax_number": "12345",
"branch_tax_registration_name": "tax-reg-name"
},
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-05-18 22:00:11",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
},
{
"id": "9598b48e-1646-446b-92b6-08dd59bc245e",
"name": "Branch 2",
"name_localized": null,
"reference": "B02",
"type": 1,
"latitude": null,
"longitude": null,
"phone": null,
"opening_from": "00:00",
"opening_to": "00:00",
"inventory_end_of_day_time": "00:00",
"receipt_header": null,
"receipt_footer": null,
"settings": null,
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-03-01 08:24:06",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
}
],
"id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"name": "Online ordering pricing",
"name_localized": null,
"created_at": "2022-05-22 09:34:42",
"updated_at": "2022-06-30 07:06:15",
"deleted_at": null,
"products": [
{
"id": "95afc8fe-875f-402b-a051-9bbdae39bd73",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"category_id": "95ad35ad-2577-443b-a29a-04394d67909e",
"sku": "sk-0010",
"barcode": null,
"name": "Chicken Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 38,
"cost": null,
"calories": null,
"created_at": "2022-02-25 20:50:39",
"updated_at": "2022-06-07 14:40:56",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"product_id": "95afc8fe-875f-402b-a051-9bbdae39bd73",
"price": 30
}
}
],
"modifier_options": [
{
"id": "95a52ec7-82b8-4300-b794-3059b79db30a",
"modifier_id": "959bcf39-13cc-4c36-85d6-e9277cdc18d6",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"name": "BBQ Sauce",
"name_localized": null,
"sku": "sk-0003",
"is_active": true,
"costing_method": 2,
"price": 2,
"cost": null,
"calories": null,
"created_at": "2022-02-20 14:21:09",
"updated_at": "2022-05-12 07:58:33",
"deleted_at": null,
"index": 0,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"modifier_option_id": "95a52ec7-82b8-4300-b794-3059b79db30a",
"price": 0
}
}
],
"combo_options": [
{
"id": "95afd4f4-be7c-4262-82f3-822eff400492",
"combo_item_id": "95afd492-fbc3-436f-b0a2-08b55bcdd518",
"name": "BBQ Burger",
"name_localized": null,
"created_at": "2022-02-25 21:24:06",
"updated_at": "2022-02-25 21:24:06",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"combo_option_id": "95afd4f4-be7c-4262-82f3-822eff400492",
"price": 20,
"combo_size_id": "95afd47d-2c97-4b79-9f32-2af25b2b9908",
"product_id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e"
}
},
{
"id": "95afd56e-d65c-4c78-a880-ce6924217f16",
"combo_item_id": "95afd530-5fd2-4b63-9218-c888e7c6c502",
"name": "Cola",
"name_localized": null,
"created_at": "2022-02-25 21:25:26",
"updated_at": "2022-02-25 21:25:26",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"combo_option_id": "95afd56e-d65c-4c78-a880-ce6924217f16",
"price": 3,
"combo_size_id": "95afd487-a867-43bf-b538-3b232f4090b7",
"product_id": "95afcd8d-6ba8-4e0f-b878-d58e44bc8b2b"
}
}
]
}
]
}
# Get Price Tag
GET /price_tags/{pricetags_Id}
# Scope
general.read
# Response
{
"data": {
"order_tag": {
"id": "965ddf6f-be02-4c39-b1aa-8e4e10d92d99",
"type": 4,
"name": "tag",
"name_localized": "tag",
"created_at": "2022-05-23 09:47:27",
"updated_at": "2022-05-23 09:47:27",
"deleted_at": null
},
"timed_events": [],
"branches": [
{
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "Branch 1",
"name_localized": "branch1",
"reference": "B01",
"type": 1,
"latitude": "30.033333",
"longitude": "31.233334",
"phone": null,
"opening_from": "01:00",
"opening_to": "22:00",
"inventory_end_of_day_time": "06:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank you",
"settings": {
"branch_tax_number": "12345",
"branch_tax_registration_name": "tax-reg-name"
},
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-05-18 22:00:11",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
},
{
"id": "9598b48e-1646-446b-92b6-08dd59bc245e",
"name": "Branch 2",
"name_localized": null,
"reference": "B02",
"type": 1,
"latitude": null,
"longitude": null,
"phone": null,
"opening_from": "00:00",
"opening_to": "00:00",
"inventory_end_of_day_time": "00:00",
"receipt_header": null,
"receipt_footer": null,
"settings": null,
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-03-01 08:24:06",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
}
],
"id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"name": "Online ordering pricing",
"name_localized": null,
"created_at": "2022-05-22 09:34:42",
"updated_at": "2022-06-30 07:06:15",
"deleted_at": null,
"modifier_options": [
{
"id": "95a52ec7-82b8-4300-b794-3059b79db30a",
"modifier_id": "959bcf39-13cc-4c36-85d6-e9277cdc18d6",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"name": "BBQ Sauce",
"name_localized": null,
"sku": "sk-0003",
"is_active": true,
"costing_method": 2,
"price": 2,
"cost": null,
"calories": null,
"created_at": "2022-02-20 14:21:09",
"updated_at": "2022-05-12 07:58:33",
"deleted_at": null,
"index": 0,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"modifier_option_id": "95a52ec7-82b8-4300-b794-3059b79db30a",
"price": 0
}
}
],
"products": [
{
"id": "95afc8fe-875f-402b-a051-9bbdae39bd73",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"category_id": "95ad35ad-2577-443b-a29a-04394d67909e",
"sku": "sk-0010",
"barcode": null,
"name": "Chicken Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 38,
"cost": null,
"calories": null,
"created_at": "2022-02-25 20:50:39",
"updated_at": "2022-06-07 14:40:56",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"product_id": "95afc8fe-875f-402b-a051-9bbdae39bd73",
"price": 30
}
}
],
"combo_options": [
{
"id": "95afd4f4-be7c-4262-82f3-822eff400492",
"combo_item_id": "95afd492-fbc3-436f-b0a2-08b55bcdd518",
"name": "BBQ Burger",
"name_localized": null,
"created_at": "2022-02-25 21:24:06",
"updated_at": "2022-02-25 21:24:06",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"combo_option_id": "95afd4f4-be7c-4262-82f3-822eff400492",
"price": 20,
"combo_size_id": "95afd47d-2c97-4b79-9f32-2af25b2b9908",
"product_id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e"
}
},
{
"id": "95afd56e-d65c-4c78-a880-ce6924217f16",
"combo_item_id": "95afd530-5fd2-4b63-9218-c888e7c6c502",
"name": "Cola",
"name_localized": null,
"created_at": "2022-02-25 21:25:26",
"updated_at": "2022-02-25 21:25:26",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"combo_option_id": "95afd56e-d65c-4c78-a880-ce6924217f16",
"price": 3,
"combo_size_id": "95afd487-a867-43bf-b538-3b232f4090b7",
"product_id": "95afcd8d-6ba8-4e0f-b878-d58e44bc8b2b"
}
}
]
}
}
# Create Price Tag
POST /price_tags
# Scope
admin.write
# Request
{
"name": "Price Tag",
"name_localized": "price_tag",
"order_tag_id": "965ddf6f-be02-4c39-b1aa-8e4e10d92d99",
"branches": [
{
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a"
}
]
}
# Response
{
"data": {
"order_tag": {
"id": "965ddf6f-be02-4c39-b1aa-8e4e10d92d99",
"type": 4,
"name": "tag",
"name_localized": "tag",
"created_at": "2022-05-23 09:47:27",
"updated_at": "2022-05-23 09:47:27",
"deleted_at": null
},
"timed_events": [],
"branches": [
{
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "Branch 1",
"name_localized": "branch1",
"reference": "B01",
"type": 1,
"latitude": "30.033333",
"longitude": "31.233334",
"phone": null,
"opening_from": "01:00",
"opening_to": "22:00",
"inventory_end_of_day_time": "06:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank you",
"settings": {
"branch_tax_number": "12345",
"branch_tax_registration_name": "tax-reg-name"
},
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-05-18 22:00:11",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
}
],
"id": "96aa197b-bf1d-422d-ac6d-94bd102a33e0",
"name": "Price Tag",
"name_localized": "price_tag",
"created_at": "2022-06-30 07:12:41",
"updated_at": "2022-06-30 07:12:41",
"deleted_at": null,
"modifier_options": [],
"combo_options": [],
"products": []
}
}
# Update Price Tag
PUT /price_tags/{priceTags_Id}
# Scope
admin.write
# Request
{
"name": "Price tag updated name",
"name_localized": "price_tag",
"order_tag_id": "965ddf6f-be02-4c39-b1aa-8e4e10d92d99",
"branches": [
{
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a"
}
]
}
# Response
{
"data": {
"order_tag": {
"id": "965ddf6f-be02-4c39-b1aa-8e4e10d92d99",
"type": 4,
"name": "tag",
"name_localized": "tag",
"created_at": "2022-05-23 09:47:27",
"updated_at": "2022-05-23 09:47:27",
"deleted_at": null
},
"timed_events": [],
"branches": [
{
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "Branch 1",
"name_localized": "branch1",
"reference": "B01",
"type": 1,
"latitude": "30.033333",
"longitude": "31.233334",
"phone": null,
"opening_from": "01:00",
"opening_to": "22:00",
"inventory_end_of_day_time": "06:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank you",
"settings": {
"branch_tax_number": "12345",
"branch_tax_registration_name": "tax-reg-name"
},
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-05-18 22:00:11",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
}
],
"id": "96aa197b-bf1d-422d-ac6d-94bd102a33e0",
"name": "Price tag updated name",
"name_localized": "price_tag",
"created_at": "2022-06-30 07:12:41",
"updated_at": "2022-06-30 07:14:36",
"deleted_at": null,
"modifier_options": [],
"combo_options": [],
"products": []
}
}
# Delete Price Tag
DELETE /price_tags/{priceTags_Id}
# Scope
admin.write
# Restore Price Tag
PUT /price_tags/{priceTags_Id}/restore
# Scope
admin.restore
# Get Price Tag Products
GET price_tags/{pricetag_id}/products
# Scope
general.read
# Response
{
"data": [
{
"pivot": {
"price": 30
},
"id": "95afc8fe-875f-402b-a051-9bbdae39bd73",
"sku": "sk-0010",
"barcode": null,
"name": "Chicken Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 38,
"cost": null,
"calories": null,
"created_at": "2022-02-25 20:50:39",
"updated_at": "2022-06-07 14:40:56",
"deleted_at": null
}
]
}
# Add Price Tag Products
POST price_tags/{pricetag_id}/products/{product_id}
# Scope
admin.write
# Request
{
"price": 220.00
}
# Response
{
"data": {
"order_tag": {
"id": "965ddf6f-be02-4c39-b1aa-8e4e10d92d99",
"type": 4,
"name": "tag",
"name_localized": "tag",
"created_at": "2022-05-23 09:47:27",
"updated_at": "2022-05-23 09:47:27",
"deleted_at": null
},
"timed_events": [],
"branches": [
{
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "Branch 1",
"name_localized": "branch1",
"reference": "B01",
"type": 1,
"latitude": "30.033333",
"longitude": "31.233334",
"phone": null,
"opening_from": "01:00",
"opening_to": "22:00",
"inventory_end_of_day_time": "06:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank you",
"settings": {
"branch_tax_number": "12345",
"branch_tax_registration_name": "tax-reg-name"
},
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-05-18 22:00:11",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
},
{
"id": "9598b48e-1646-446b-92b6-08dd59bc245e",
"name": "Branch 2",
"name_localized": null,
"reference": "B02",
"type": 1,
"latitude": null,
"longitude": null,
"phone": null,
"opening_from": "00:00",
"opening_to": "00:00",
"inventory_end_of_day_time": "00:00",
"receipt_header": null,
"receipt_footer": null,
"settings": null,
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-03-01 08:24:06",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
}
],
"id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"name": "Online ordering pricing",
"name_localized": null,
"created_at": "2022-05-22 09:34:42",
"updated_at": "2022-06-30 07:41:27",
"deleted_at": null,
"modifier_options": [
{
"id": "95a52ec7-82b8-4300-b794-3059b79db30a",
"modifier_id": "959bcf39-13cc-4c36-85d6-e9277cdc18d6",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"name": "BBQ Sauce",
"name_localized": null,
"sku": "sk-0003",
"is_active": true,
"costing_method": 2,
"price": 2,
"cost": null,
"calories": null,
"created_at": "2022-02-20 14:21:09",
"updated_at": "2022-05-12 07:58:33",
"deleted_at": null,
"index": 0,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"modifier_option_id": "95a52ec7-82b8-4300-b794-3059b79db30a",
"price": 0
}
}
],
"combo_options": [
{
"id": "95afd4f4-be7c-4262-82f3-822eff400492",
"combo_item_id": "95afd492-fbc3-436f-b0a2-08b55bcdd518",
"name": "BBQ Burger",
"name_localized": null,
"created_at": "2022-02-25 21:24:06",
"updated_at": "2022-02-25 21:24:06",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"combo_option_id": "95afd4f4-be7c-4262-82f3-822eff400492",
"price": 20,
"combo_size_id": "95afd47d-2c97-4b79-9f32-2af25b2b9908",
"product_id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e"
}
},
{
"id": "95afd56e-d65c-4c78-a880-ce6924217f16",
"combo_item_id": "95afd530-5fd2-4b63-9218-c888e7c6c502",
"name": "Cola",
"name_localized": null,
"created_at": "2022-02-25 21:25:26",
"updated_at": "2022-02-25 21:25:26",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"combo_option_id": "95afd56e-d65c-4c78-a880-ce6924217f16",
"price": 3,
"combo_size_id": "95afd487-a867-43bf-b538-3b232f4090b7",
"product_id": "95afcd8d-6ba8-4e0f-b878-d58e44bc8b2b"
}
}
],
"products": [
{
"id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"category_id": "95ad35ad-2577-443b-a29a-04394d67909e",
"sku": "sk-0006",
"barcode": null,
"name": "BBQ Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 50,
"cost": null,
"calories": null,
"created_at": "2022-02-24 14:07:26",
"updated_at": "2022-03-20 21:52:28",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"product_id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e",
"price": 220
}
},
{
"id": "95afc8fe-875f-402b-a051-9bbdae39bd73",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"category_id": "95ad35ad-2577-443b-a29a-04394d67909e",
"sku": "sk-0010",
"barcode": null,
"name": "Chicken Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 38,
"cost": null,
"calories": null,
"created_at": "2022-02-25 20:50:39",
"updated_at": "2022-06-07 14:40:56",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"product_id": "95afc8fe-875f-402b-a051-9bbdae39bd73",
"price": 30
}
}
]
}
}
# Delete Price Tag from Products
DELETE price_tags/{pricetag_id}/products/{product_id}
# Scope
admin.write
# Get Price Tag Combo options
GET price_tags/{pricetag_id}/combo_options
# Scope
general.read
# Response
{
"data": [
{
"pivot": {
"price": 20,
"product": {
"id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e",
"sku": "sk-0006",
"barcode": null,
"name": "BBQ Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 50,
"cost": null,
"calories": null,
"created_at": "2022-02-24 14:07:26",
"updated_at": "2022-03-20 21:52:28",
"deleted_at": null
},
"size": {
"id": "95afd47d-2c97-4b79-9f32-2af25b2b9908",
"name": "Small",
"name_localized": null,
"created_at": "2022-02-25 21:22:47",
"updated_at": "2022-02-25 21:22:47",
"deleted_at": null
}
},
"id": "95afd4f4-be7c-4262-82f3-822eff400492",
"name": "BBQ Burger",
"name_localized": null,
"created_at": "2022-02-25 21:24:06",
"updated_at": "2022-02-25 21:24:06",
"deleted_at": null
},
{
"pivot": {
"price": 3,
"product": {
"id": "95afcd8d-6ba8-4e0f-b878-d58e44bc8b2b",
"sku": "sk-0013",
"barcode": null,
"name": "Cola",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 5,
"cost": null,
"calories": null,
"created_at": "2022-02-25 21:03:24",
"updated_at": "2022-02-25 21:03:24",
"deleted_at": null
},
"size": {
"id": "95afd487-a867-43bf-b538-3b232f4090b7",
"name": "Large",
"name_localized": null,
"created_at": "2022-02-25 21:22:54",
"updated_at": "2022-02-25 21:22:54",
"deleted_at": null
}
},
"id": "95afd56e-d65c-4c78-a880-ce6924217f16",
"name": "Cola",
"name_localized": null,
"created_at": "2022-02-25 21:25:26",
"updated_at": "2022-02-25 21:25:26",
"deleted_at": null
}
]
}
# Add Price Tag Combo options
POST /price_tags/{pricetag_id}/combo_options/{combo_options_id}/sizes/{sizes_id}/products/{product_id}
# Scope
admin.write
# Request
{
"price": 220.00
}
# Response
{
"data": {
"order_tag": {
"id": "965ddf6f-be02-4c39-b1aa-8e4e10d92d99",
"type": 4,
"name": "tag",
"name_localized": "tag",
"created_at": "2022-05-23 09:47:27",
"updated_at": "2022-05-23 09:47:27",
"deleted_at": null
},
"timed_events": [],
"branches": [
{
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "Branch 1",
"name_localized": "branch1",
"reference": "B01",
"type": 1,
"latitude": "30.033333",
"longitude": "31.233334",
"phone": null,
"opening_from": "01:00",
"opening_to": "22:00",
"inventory_end_of_day_time": "06:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank you",
"settings": {
"branch_tax_number": "12345",
"branch_tax_registration_name": "tax-reg-name"
},
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-05-18 22:00:11",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
},
{
"id": "9598b48e-1646-446b-92b6-08dd59bc245e",
"name": "Branch 2",
"name_localized": null,
"reference": "B02",
"type": 1,
"latitude": null,
"longitude": null,
"phone": null,
"opening_from": "00:00",
"opening_to": "00:00",
"inventory_end_of_day_time": "00:00",
"receipt_header": null,
"receipt_footer": null,
"settings": null,
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-03-01 08:24:06",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
}
],
"id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"name": "Online ordering pricing",
"name_localized": null,
"created_at": "2022-05-22 09:34:42",
"updated_at": "2022-06-30 07:48:38",
"deleted_at": null,
"modifier_options": [
{
"id": "95a52ec7-82b8-4300-b794-3059b79db30a",
"modifier_id": "959bcf39-13cc-4c36-85d6-e9277cdc18d6",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"name": "BBQ Sauce",
"name_localized": null,
"sku": "sk-0003",
"is_active": true,
"costing_method": 2,
"price": 2,
"cost": null,
"calories": null,
"created_at": "2022-02-20 14:21:09",
"updated_at": "2022-05-12 07:58:33",
"deleted_at": null,
"index": 0,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"modifier_option_id": "95a52ec7-82b8-4300-b794-3059b79db30a",
"price": 0
}
}
],
"combo_options": [
{
"id": "95afd4f4-be7c-4262-82f3-822eff400492",
"combo_item_id": "95afd492-fbc3-436f-b0a2-08b55bcdd518",
"name": "BBQ Burger",
"name_localized": null,
"created_at": "2022-02-25 21:24:06",
"updated_at": "2022-02-25 21:24:06",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"combo_option_id": "95afd4f4-be7c-4262-82f3-822eff400492",
"price": 220,
"combo_size_id": "95afd47d-2c97-4b79-9f32-2af25b2b9908",
"product_id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e"
}
},
{
"id": "95afd56e-d65c-4c78-a880-ce6924217f16",
"combo_item_id": "95afd530-5fd2-4b63-9218-c888e7c6c502",
"name": "Cola",
"name_localized": null,
"created_at": "2022-02-25 21:25:26",
"updated_at": "2022-02-25 21:25:26",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"combo_option_id": "95afd56e-d65c-4c78-a880-ce6924217f16",
"price": 3,
"combo_size_id": "95afd487-a867-43bf-b538-3b232f4090b7",
"product_id": "95afcd8d-6ba8-4e0f-b878-d58e44bc8b2b"
}
}
],
"products": [
{
"id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"category_id": "95ad35ad-2577-443b-a29a-04394d67909e",
"sku": "sk-0006",
"barcode": null,
"name": "BBQ Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 50,
"cost": null,
"calories": null,
"created_at": "2022-02-24 14:07:26",
"updated_at": "2022-03-20 21:52:28",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"product_id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e",
"price": 220
}
},
{
"id": "95afc8fe-875f-402b-a051-9bbdae39bd73",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"category_id": "95ad35ad-2577-443b-a29a-04394d67909e",
"sku": "sk-0010",
"barcode": null,
"name": "Chicken Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 38,
"cost": null,
"calories": null,
"created_at": "2022-02-25 20:50:39",
"updated_at": "2022-06-07 14:40:56",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"product_id": "95afc8fe-875f-402b-a051-9bbdae39bd73",
"price": 30
}
}
]
}
}
# Delete Price Tag from Combo Options
DELETE /price_tags/{pricetag_id}/combo_options/{combo_options_id}/sizes/{sizes_id}/products/{product_id}
# Scope
admin.write
# Get Price Tag Modifier Options
GET price_tags/{pricetag_id}/modifier_options
# Scope
general.read
# Response
{
"data": [
{
"pivot": {
"price": 0
},
"id": "95a52ec7-82b8-4300-b794-3059b79db30a",
"name": "BBQ Sauce",
"name_localized": null,
"sku": "sk-0003",
"is_active": true,
"costing_method": 2,
"price": 2,
"cost": null,
"calories": null,
"created_at": "2022-02-20 14:21:09",
"updated_at": "2022-05-12 07:58:33",
"deleted_at": null,
"index": 0
}
]
}
# Add Price Tag Modifier Options
POST /price_tags/{prics_tags_id}/modifier_options/{modifier_options_id}
# Scope
admin.write
# Request
{
"price": 5
}
# Response
{
"data": {
"order_tag": {
"id": "965ddf6f-be02-4c39-b1aa-8e4e10d92d99",
"type": 4,
"name": "tag",
"name_localized": "tag",
"created_at": "2022-05-23 09:47:27",
"updated_at": "2022-05-23 09:47:27",
"deleted_at": null
},
"timed_events": [],
"branches": [
{
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "Branch 1",
"name_localized": "branch1",
"reference": "B01",
"type": 1,
"latitude": "30.033333",
"longitude": "31.233334",
"phone": null,
"opening_from": "01:00",
"opening_to": "22:00",
"inventory_end_of_day_time": "06:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank you",
"settings": {
"branch_tax_number": "12345",
"branch_tax_registration_name": "tax-reg-name"
},
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-05-18 22:00:11",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
},
{
"id": "9598b48e-1646-446b-92b6-08dd59bc245e",
"name": "Branch 2",
"name_localized": null,
"reference": "B02",
"type": 1,
"latitude": null,
"longitude": null,
"phone": null,
"opening_from": "00:00",
"opening_to": "00:00",
"inventory_end_of_day_time": "00:00",
"receipt_header": null,
"receipt_footer": null,
"settings": null,
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-03-01 08:24:06",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null
}
],
"id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"name": "Online ordering pricing",
"name_localized": null,
"created_at": "2022-05-22 09:34:42",
"updated_at": "2022-06-30 07:52:41",
"deleted_at": null,
"modifier_options": [
{
"id": "95a52ec7-82b8-4300-b794-3059b79db30a",
"modifier_id": "959bcf39-13cc-4c36-85d6-e9277cdc18d6",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"name": "BBQ Sauce",
"name_localized": null,
"sku": "sk-0003",
"is_active": true,
"costing_method": 2,
"price": 2,
"cost": null,
"calories": null,
"created_at": "2022-02-20 14:21:09",
"updated_at": "2022-05-12 07:58:33",
"deleted_at": null,
"index": 0,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"modifier_option_id": "95a52ec7-82b8-4300-b794-3059b79db30a",
"price": 0
}
},
{
"id": "95afc868-e245-48ee-87e6-5791a26489df",
"modifier_id": "959bcf39-13cc-4c36-85d6-e9277cdc18d6",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"name": "Ranch Sauce",
"name_localized": null,
"sku": "sk-0009",
"is_active": true,
"costing_method": 2,
"price": 3,
"cost": null,
"calories": null,
"created_at": "2022-02-25 20:49:01",
"updated_at": "2022-03-13 22:22:04",
"deleted_at": null,
"index": 0,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"modifier_option_id": "95afc868-e245-48ee-87e6-5791a26489df",
"price": 5
}
}
],
"combo_options": [
{
"id": "95afd4f4-be7c-4262-82f3-822eff400492",
"combo_item_id": "95afd492-fbc3-436f-b0a2-08b55bcdd518",
"name": "BBQ Burger",
"name_localized": null,
"created_at": "2022-02-25 21:24:06",
"updated_at": "2022-02-25 21:24:06",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"combo_option_id": "95afd4f4-be7c-4262-82f3-822eff400492",
"price": 220,
"combo_size_id": "95afd47d-2c97-4b79-9f32-2af25b2b9908",
"product_id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e"
}
},
{
"id": "95afd56e-d65c-4c78-a880-ce6924217f16",
"combo_item_id": "95afd530-5fd2-4b63-9218-c888e7c6c502",
"name": "Cola",
"name_localized": null,
"created_at": "2022-02-25 21:25:26",
"updated_at": "2022-02-25 21:25:26",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"combo_option_id": "95afd56e-d65c-4c78-a880-ce6924217f16",
"price": 3,
"combo_size_id": "95afd487-a867-43bf-b538-3b232f4090b7",
"product_id": "95afcd8d-6ba8-4e0f-b878-d58e44bc8b2b"
}
}
],
"products": [
{
"id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"category_id": "95ad35ad-2577-443b-a29a-04394d67909e",
"sku": "sk-0006",
"barcode": null,
"name": "BBQ Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 50,
"cost": null,
"calories": null,
"created_at": "2022-02-24 14:07:26",
"updated_at": "2022-03-20 21:52:28",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"product_id": "95ad35ce-b8e7-4c2e-810a-76fb61a1634e",
"price": 220
}
},
{
"id": "95afc8fe-875f-402b-a051-9bbdae39bd73",
"tax_group_id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"category_id": "95ad35ad-2577-443b-a29a-04394d67909e",
"sku": "sk-0010",
"barcode": null,
"name": "Chicken Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": null,
"price": 38,
"cost": null,
"calories": null,
"created_at": "2022-02-25 20:50:39",
"updated_at": "2022-06-07 14:40:56",
"deleted_at": null,
"pivot": {
"price_tag_id": "965bd7e4-499b-4c06-959e-4a851bdd5a23",
"product_id": "95afc8fe-875f-402b-a051-9bbdae39bd73",
"price": 30
}
}
]
}
}
# Delete Price Tag from Modifier Options
DELETE /price_tags/{pricetag_id}/modifier_options/{modifier_options_id}
# Scope
admin.write