Some of the URLs in this documentation contain placeholders for values that your API client program must provide. These placeholders are shown in curly braces, like {this}. When you construct the URL to access these resources, replace those placeholders with the values you want to use.
.
This request will return all Categories from hungrytext against Merchant provided categories and the accountno or token.
string
(required)string
(required)string
(required)200
ShowHide
Content-Type: application/json
authorization: Basic Key
{
"data": [
{
"id": "18",
"code": "02",
"name": "Quick Bites",
"image": "URL/api/assets/uploads/no_image.png",
"parent_id": "0",
"short_name": "",
"category_tags": ""
},
{
"id": "19",
"code": "03",
"name": "Quick Soups",
"image": "URL/api/assets/uploads/no_image.png",
"parent_id": "0",
"short_name": "",
"category_tags": ""
}
]
}
This request will add the new categories and return with category code that you have recently insert.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"categories": [
{
"code": "ZEE1",
"name": "Pizza ZEE1",
"image": "ccd442f8cf5e421806220180f15e6bb4.jpg",
"parent_id": "0",
"short_name": "ZEE1",
"category_tags": "Pizza,ZEE1"
},
{
"code": "ZEE2",
"name": "Pizzete ZEE2",
"image": "6f1e42836a11ef449b7b43bfa11be7e8.jpeg",
"parent_id": "0",
"short_name": "ZEE2",
"category_tags": "Pizzete,ZEE2"
}
]
}
200
ShowHide
{
"status": "200",
"data": "ZEE1,ZEE2,"
}
This request will update the categories against the category code and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"categories": [
{
"code": "ZEE1",
"name": "Pizza ZEE1",
"image": "ccd442f8cf5e421806220180f15e6bb4.jpg",
"parent_id": "0",
"short_name": "ZEE1",
"category_tags": "Pizza,ZEE1"
},
{
"code": "ZEE2",
"name": "Pizzete ZEE2",
"image": "6f1e42836a11ef449b7b43bfa11be7e8.jpeg",
"parent_id": "0",
"short_name": "ZEE2",
"category_tags": "Pizzete,ZEE2"
}
]
}
200
ShowHide
{
"status": "200",
"data": "ZEE1,ZEE2,"
}
This request will delete the categories against the category code and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"categories": [
{
"code": "ZEE1",
"name": "Pizza ZEE1",
"image": "ccd442f8cf5e421806220180f15e6bb4.jpg",
"parent_id": "0",
"short_name": "ZEE1",
"category_tags": "Pizza,ZEE1"
},
{
"code": "ZEE2",
"name": "Pizzete ZEE2",
"image": "6f1e42836a11ef449b7b43bfa11be7e8.jpeg",
"parent_id": "0",
"short_name": "ZEE2",
"category_tags": "Pizzete,ZEE2"
}
]
}
200
ShowHide
{
"status": "200",
"data": "Successfully deleted"
}
This request will return all products against the category id by provider, the accountno or token.
string
(required)string
(required)integer
(required)string
(required)200
ShowHide
Content-Type: application/json
authorization: Basic Key
{
"data": [
{
"id": "90",
"code": "02",
"name": "Salted Lassi",
"short": "#02",
"unit": "12",
"cost": "4.0000",
"price": "4.0000",
"alert_quantity": "10000.0000",
"image": "URL/api/assets/uploads/no_image.png",
"category_id": "17",
"subcategory_id": null,
"quantity": "0.0000",
"tax_rate": "1",
"track_quantity": "1",
"details": "",
"warehouse": null,
"barcode_symbology": "code128",
"file": null,
"product_details": "",
"tax_method": "0",
"type": "standard",
"sale_unit": "12",
"purchase_unit": "12",
"brand": "0",
"status": "1",
"popular": "0",
"allow_attributes": "1",
"product_tags": ""
},
{
"id": "91",
"code": "03",
"name": "Mango Lassi",
"short": "#03",
"unit": "12",
"cost": "5.0000",
"price": "5.0000",
"alert_quantity": "10000.0000",
"image": "URL/api/assets/uploads/no_image.png",
"category_id": "17",
"subcategory_id": null,
"quantity": "0.0000",
"tax_rate": "1",
"track_quantity": "1",
"details": "",
"warehouse": null,
"barcode_symbology": "code128",
"file": null,
"product_details": "",
"tax_method": "0",
"type": "standard",
"sale_unit": "12",
"purchase_unit": "12",
"brand": "0",
"status": "1",
"popular": "0",
"allow_attributes": "1",
"product_tags": ""
}
]
}
This request will add the new products and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"accountno":"",
"token":"",
"authorization" : "",
"products": [
{
"code": "0022",
"name": "Salted Lassi",
"short": "#02",
"unit": "12",
"cost": "4.0000",
"price": "4.0000",
"alert_quantity": "10000.0000",
"image": "URL/api/assets/uploads/no_image.png",
"category_id": "17",
"subcategory_id": null,
"quantity": "0.0000",
"tax_rate": "1",
"track_quantity": "1",
"details": "",
"warehouse": null,
"barcode_symbology": "code128",
"file": null,
"product_details": "",
"tax_method": "0",
"type": "standard",
"sale_unit": "12",
"purchase_unit": "12",
"brand": "0",
"status": "1",
"popular": "0",
"allow_attributes": "1",
"product_tags": "",
"optional": [
{
"product_id": "159",
"name": "Mild",
"cost": null,
"price": "2.0000",
"quantity": null,
"variant_type": "optional",
"short": ""
},
{
"product_id": "159",
"name": "Hot",
"cost": null,
"price": "0.0000",
"quantity": null,
"variant_type": "optional",
"short": ""
}
],
"required": [
{
"product_id": "159",
"name": "Lamb",
"cost": null,
"price": "1.0000",
"quantity": null,
"variant_type": "required",
"short": ""
},
{
"product_id": "159",
"name": "Vegetable",
"cost": null,
"price": "0.0000",
"quantity": null,
"variant_type": "required",
"short": ""
}
]
}
}
200
ShowHide
{
"status": "200",
"data": "Product added successfully"
}
This request will update the products against product code and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"accountno":"",
"token":"",
"authorization" : "",
"products": [
{
"code": "002",
"name": "Salted Lassi",
"short": "#02",
"unit": "12",
"cost": "4.0000",
"price": "4.0000",
"alert_quantity": "10000.0000",
"image": "URL/api/assets/uploads/no_image.png",
"category_id": "17",
"subcategory_id": null,
"quantity": "0.0000",
"tax_rate": "1",
"track_quantity": "1",
"details": "",
"warehouse": null,
"barcode_symbology": "code128",
"file": null,
"product_details": "",
"tax_method": "0",
"type": "standard",
"sale_unit": "12",
"purchase_unit": "12",
"brand": "0",
"status": "1",
"popular": "0",
"allow_attributes": "1",
"product_tags": ""
}
]
}
200
ShowHide
{
"status": "200",
"data": "Product updated successfully"
}
This request will delete the products against the product code and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"accountno":"",
"token":"",
"authorization" : "",
"products": [
{
"code": "002",
"name": "Salted Lassi",
"short": "#02",
"unit": "12",
"cost": "4.0000",
"price": "4.0000",
"alert_quantity": "10000.0000",
"image": "URL/api/assets/uploads/no_image.png",
"category_id": "17",
"subcategory_id": null,
"quantity": "0.0000",
"tax_rate": "1",
"track_quantity": "1",
"details": "",
"warehouse": null,
"barcode_symbology": "code128",
"file": null,
"product_details": "",
"tax_method": "0",
"type": "standard",
"sale_unit": "12",
"purchase_unit": "12",
"brand": "0",
"status": "1",
"popular": "0",
"allow_attributes": "1",
"product_tags": ""
}
]
}
200
ShowHide
{
"status": "200",
"data": "product successfully deleted"
}
This request will return all Variants against this Parameters.
string
(required)string
(required)string
(required)200
ShowHide
Content-Type: application/json
authorization: Basic Key
{
"data": [
{
"id": "1",
"name": "Chicken",
"variant_tags": "",
"short": "chick001"
},
{
"id": "2",
"name": "Lamb",
"variant_tags": "",
"short": ""
},
{
"id": "3",
"name": "Vegetable",
"variant_tags": "",
"short": ""
},
{
"id": "4",
"name": "Mild",
"variant_tags": "",
"short": ""
},
{
"id": "5",
"name": "Medium",
"variant_tags": "",
"short": "med001"
}
]
}
This request will add the new variants and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"accountno":"",
"token":"",
"authorization" : "Basic Key",
"varients": [
{
"name": "mytest ZEE1",
"variant_tags": "tag1 , tag2",
"short": "ZEE1"
},
{
"name": "mytest2 ZEE2",
"variant_tags": "tag1",
"short": "ZEE2"
}
]
}
200
ShowHide
{
"status": "200",
"data":"mytest ZEE1,mytest2 ZEE2,"
}
This request will update the variants against the variants name and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"accountno":"",
"token":"",
"authorization" : "Basic Key",
"varients": [
{
"name": "mytest ZEE1",
"variant_tags": "tag1 , tag2, tag3",
"short": "ZEE1"
},
{
"name": "mytest2 ZEE2",
"variant_tags": "tag1, tag2",
"short": "ZEE2"
}
]
}
200
ShowHide
{
"status": "200",
"data": "mytest ZEE1,mytest2 ZEE2,"
}
This request will delete the variants against the variants name and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"accountno":"",
"token":"",
"authorization" : "Basic Key",
"varients": [
{
"name": "mytest ZEE1",
"variant_tags": "hehe, hoho, haha",
"short": "ZEE1"
},
{
"name": "mytest2 ZEE2",
"variant_tags": "jinga, laa, laa",
"short": "ZEE2"
}
]
}
200
ShowHide
{
"status": "200",
"data": "Variant Successfully deleted"
}
This request will return all taxes against this Parameters.
string
(required)string
(required)string
(required)200
ShowHide
Content-Type: application/json
authorization: Basic Key
{
"data": [
{
"id": "1",
"name": "No Tax",
"code": "NT",
"rate": "0.0000",
"type": "2"
},
{
"id": "5",
"name": "NYC @8.88",
"code": "NYT",
"rate": "8.8750",
"type": "1"
}
]
}
This request will add the new tax and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"accountno":"",
"token":"",
"authorization" : "Basic Key",
"tax_rates": [
{
"name": "mytax 1",
"code": "EURO",
"rate": "2.5",
"type": "1"
},
{
"name": "mytax 2",
"code": "USA",
"rate": "5.0",
"type": "2"
}
]
}
200
ShowHide
{
"status": "200",
"data":"mytax 1,mytax 2,"
}
This request will update the tax against the tax code and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"accountno":"",
"token":"",
"authorization" : "Basic Key",
"tax_rates": [
{
"name": "pak rate",
"code": "PAK",
"rate": "2.5",
"type": "1"
},
{
"name": "india rate",
"code": "INDIA",
"rate": "5.0",
"type": "2"
}
]
}
200
ShowHide
{
"status": "200",
"data":"pak rate,india rate,"
}
This request will update the tax against the tax code and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"accountno":"",
"token":"",
"authorization" : "Basic Key",
"tax_rates": [
{
"name": "mytax 1",
"code": "EURO",
"rate": "2.5",
"type": "1"
},
{
"name": "mytax 2",
"code": "USA",
"rate": "5.0",
"type": "2"
}
]
}
200
ShowHide
{
"status": "200",
data":"Tax rate Successfully deleted"
}
This request will return all customers against this Parameters.
string
(required)string
(required)string
(required)200
ShowHide
Content-Type: application/json
authorization: Basic Key
{
"data": [
{
"group_id": "3",
"group_name": "customer",
"customer_group_id": "1",
"customer_group_name": "General",
"name": "HungryText",
"company": "Hungry Text",
"vat_no": "",
"address": "720 Monroe Street, Suite e210",
"city": "Hoboken",
"state": "NJ",
"postal_code": "07030",
"country": null,
"phone": "9295221000",
"email": "ranazeeshan41@gmail.com",
"cf1": "",
"cf2": "",
"cf3": "",
"cf4": "",
"cf5": "",
"cf6": "",
"invoice_footer": null,
"payment_term": "0",
"logo": "logo.png",
"award_points": "0",
"deposit_amount": null,
"price_group_id": "1",
"price_group_name": "Default",
"full_address": null,
"phone2": "2123727200",
"notes": "Delivery Notes",
"phone_type": "home",
"address2": "",
"delivery_instructions": "Old Woman - Dont Ring the Bell"
}
]
}
This request will add the new cusmtomer and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"accountno":"",
"token":"",
"authorization" : "Basic Key",
"customers": [
{
"group_id" : "3",
"group_name" : "customer",
"customer_group_id" : "1",
"customer_group_name" : "General",
"name" : "dino",
"company" : "hungrytext",
"vat_no" : "",
"address" : "new york",
"city" : "lahore",
"state" : "punjab",
"postal_code" : "112233",
"country" : "new york",
"phone" : "987654321",
"email" : "info@hungrytext.com",
"cf1" : "",
"cf2" : "",
"cf3" : "",
"cf4" : "",
"cf5" : "",
"cf6" : "",
"invoice_footer" : "",
"payment_term" : "",
"logo" : "",
"award_points" : "",
"deposit_amount" : "",
"price_group_id" : "",
"price_group_name" : "",
"full_address" : "",
"phone2" : "",
"notes" : "",
"phone_type" : "",
"address2" : "",
"delivery_instructions" : ""
},
{
"group_id" : "3",
"group_name" : "customer",
"customer_group_id" : "1",
"customer_group_name" : "General",
"name" : "waqas",
"company" : "novelty",
"vat_no" : "",
"address" : "70 R model town",
"city" : "lahore",
"state" : "punjab",
"postal_code" : "54000",
"country" : "pakistan",
"phone" : "123456789",
"email" : "waqas@noveltysoft.com",
"cf1" : "",
"cf2" : "",
"cf3" : "",
"cf4" : "",
"cf5" : "",
"cf6" : "",
"invoice_footer" : "",
"payment_term" : "",
"logo" : "",
"award_points" : "",
"deposit_amount" : "",
"price_group_id" : "",
"price_group_name" : "",
"full_address" : "",
"phone2" : "",
"notes" : "",
"phone_type" : "",
"address2" : "",
"delivery_instructions" : ""
}
]
}
200
ShowHide
{
"status": "200",
"data": "hungrytext,novelty,"
}
This request will update the customers against the customers phone number and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"accountno":"",
"token":"",
"authorization" : "Basic Key",
"customers": [
{
"group_id" : "3",
"group_name" : "customer",
"customer_group_id" : "1",
"customer_group_name" : "General",
"name" : "dino",
"company" : "hungrytext",
"vat_no" : "",
"address" : "new york",
"city" : "lahore",
"state" : "punjab",
"postal_code" : "112233",
"country" : "new york",
"phone" : "987654321",
"email" : "info@hungrytext.com",
"cf1" : "",
"cf2" : "",
"cf3" : "",
"cf4" : "",
"cf5" : "",
"cf6" : "",
"invoice_footer" : "",
"payment_term" : "",
"logo" : "",
"award_points" : "",
"deposit_amount" : "",
"price_group_id" : "",
"price_group_name" : "",
"full_address" : "",
"phone2" : "",
"notes" : "",
"phone_type" : "",
"address2" : "",
"delivery_instructions" : ""
},
{
"group_id" : "3",
"group_name" : "customer",
"customer_group_id" : "1",
"customer_group_name" : "General",
"name" : "waqas",
"company" : "novelty",
"vat_no" : "",
"address" : "70 R model town",
"city" : "lahore",
"state" : "punjab",
"postal_code" : "54000",
"country" : "pakistan",
"phone" : "123456789",
"email" : "waqas@noveltysoft.com",
"cf1" : "",
"cf2" : "",
"cf3" : "",
"cf4" : "",
"cf5" : "",
"cf6" : "",
"invoice_footer" : "",
"payment_term" : "",
"logo" : "",
"award_points" : "",
"deposit_amount" : "",
"price_group_id" : "",
"price_group_name" : "",
"full_address" : "",
"phone2" : "",
"notes" : "",
"phone_type" : "",
"address2" : "",
"delivery_instructions" : ""
}
]
}
200
ShowHide
{
"status": "200",
"data": "hungrytext,novelty,"
}
This request will delete the customers against the customers phone number and return its details.
string
(required)string
(required)string
(required)Content-Type: application/json
authorization: Basic Key
{
"accountno":"",
"token":"",
"authorization" : "Basic Key",
"customers": [
{
"group_id" : "3",
"group_name" : "customer",
"customer_group_id" : "1",
"customer_group_name" : "General",
"name" : "dino",
"company" : "hungrytext",
"vat_no" : "",
"address" : "new york",
"city" : "lahore",
"state" : "punjab",
"postal_code" : "112233",
"country" : "new york",
"phone" : "987654321",
"email" : "info@hungrytext.com",
"cf1" : "",
"cf2" : "",
"cf3" : "",
"cf4" : "",
"cf5" : "",
"cf6" : "",
"invoice_footer" : "",
"payment_term" : "",
"logo" : "",
"award_points" : "",
"deposit_amount" : "",
"price_group_id" : "",
"price_group_name" : "",
"full_address" : "",
"phone2" : "",
"notes" : "",
"phone_type" : "",
"address2" : "",
"delivery_instructions" : ""
},
{
"group_id" : "3",
"group_name" : "customer",
"customer_group_id" : "1",
"customer_group_name" : "General",
"name" : "waqas",
"company" : "novelty",
"vat_no" : "",
"address" : "70 R model town",
"city" : "lahore",
"state" : "punjab",
"postal_code" : "54000",
"country" : "pakistan",
"phone" : "123456789",
"email" : "waqas@noveltysoft.com",
"cf1" : "",
"cf2" : "",
"cf3" : "",
"cf4" : "",
"cf5" : "",
"cf6" : "",
"invoice_footer" : "",
"payment_term" : "",
"logo" : "",
"award_points" : "",
"deposit_amount" : "",
"price_group_id" : "",
"price_group_name" : "",
"full_address" : "",
"phone2" : "",
"notes" : "",
"phone_type" : "",
"address2" : "",
"delivery_instructions" : ""
}
]
}
200
ShowHide
{
"status": "200",
"data": "Customer Successfully Deleted"
}