Loading, please wait...

OFF POS

Popular Search:

  • Forums, 
  • Getting Started, 
  • Community

ItemAPI Example

Product API Description

You can use the following example API to add items.

{
    "api_auth_key": "c10edad9-e361-4ba1-97e3-387f27ba4265",
    "name": "Wardrobe",
    "alternative_name": "wardrobe",
    "type": "General_Product",
    "category_name": "",
    "brand_name": "RFL",
    "supplier_name": "Mr.RFL",
    "alert_quantity": "5",
    "unit_type": "Single Unit",
    "purchase_unit_name": "PCS",
    "sale_unit_name": "PCS",
    "conversion_rate": "1",
    "purchase_price": "33",
    "whole_sale_price": "40",
    "sale_price": "55",
    "description": "Item description",
    "warranty": "1",
    "warranty_type": "Year",
    "guarantee": "1",
    "guarantee_type": "Month",
    "photo": "test.png",
    "loyalty_point": "0",
    "del_status": "Live",
    "opening_stock": [
        {
            "iem_description": "",
            "stock_quantity": "20",
            "outlet_name": "Mirput"
        },
        {
            "iem_description": "",
            "stock_quantity": "20",
            "outlet_name": "Uttara"
        }
    ],
    "tax_information": [
        {
            "tax_field_name": "CGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "SGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "IGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "Vat",
            "tax_field_percentage": "20"
        }
    ]
}

You can use the following example API to edit items.

{
    "api_auth_key": "c10edad9-e361-4ba1-97e3-387f27ba4265",
    "name": "Wardrobe",
    "alternative_name": "wardrobe",
    "type": "General_Product",
    "category_name": "",
    "brand_name": "RFL",
    "supplier_name": "Mr.RFL",
    "alert_quantity": "5",
    "unit_type": "Single Unit",
    "purchase_unit_name": "PCS",
    "sale_unit_name": "PCS",
    "conversion_rate": "1",
    "purchase_price": "33",
    "whole_sale_price": "40",
    "sale_price": "55",
    "description": "Item description",
    "warranty": "1",
    "warranty_type": "Year",
    "guarantee": "1",
    "guarantee_type": "Month",
    "photo": "test.png",
    "loyalty_point": "0",
    "del_status": "Live",
    "opening_stock": [
        {
            "iem_description": "",
            "stock_quantity": "20",
            "outlet_name": "Mirput"
        },
        {
            "iem_description": "",
            "stock_quantity": "20",
            "outlet_name": "Uttara"
        }
    ],
    "tax_information": [
        {
            "tax_field_name": "CGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "SGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "IGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "Vat",
            "tax_field_percentage": "20"
        }
    ]
}

You can use the following example API to update items.

{
    "api_auth_key": "c10edad9-e361-4ba1-97e3-387f27ba4265",
    "name": "Wardrobe",
    "alternative_name": "wardrobe",
    "type": "General_Product",
    "category_name": "",
    "brand_name": "RFL",
    "supplier_name": "Mr.RFL",
    "alert_quantity": "5",
    "unit_type": "Single Unit",
    "purchase_unit_name": "PCS",
    "sale_unit_name": "PCS",
    "conversion_rate": "1",
    "purchase_price": "33",
    "whole_sale_price": "40",
    "sale_price": "55",
    "description": "Item description",
    "warranty": "1",
    "warranty_type": "Year",
    "guarantee": "1",
    "guarantee_type": "Month",
    "photo": "test.png",
    "loyalty_point": "0",
    "del_status": "Live",
    "opening_stock": [
        {
            "iem_description": "",
            "stock_quantity": "20",
            "outlet_name": "Mirput"
        },
        {
            "iem_description": "",
            "stock_quantity": "20",
            "outlet_name": "Uttara"
        }
    ],
    "tax_information": [
        {
            "tax_field_name": "CGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "SGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "IGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "Vat",
            "tax_field_percentage": "20"
        }
    ]
}

You can use the following example API to view the list of items.

{
    "api_auth_key": "c10edad9-e361-4ba1-97e3-387f27ba4265",
    "name": "Wardrobe",
    "alternative_name": "wardrobe",
    "type": "General_Product",
    "category_name": "",
    "brand_name": "RFL",
    "supplier_name": "Mr.RFL",
    "alert_quantity": "5",
    "unit_type": "Single Unit",
    "purchase_unit_name": "PCS",
    "sale_unit_name": "PCS",
    "conversion_rate": "1",
    "purchase_price": "33",
    "whole_sale_price": "40",
    "sale_price": "55",
    "description": "Item description",
    "warranty": "1",
    "warranty_type": "Year",
    "guarantee": "1",
    "guarantee_type": "Month",
    "photo": "test.png",
    "loyalty_point": "0",
    "del_status": "Live",
    "opening_stock": [
        {
            "iem_description": "",
            "stock_quantity": "20",
            "outlet_name": "Mirput"
        },
        {
            "iem_description": "",
            "stock_quantity": "20",
            "outlet_name": "Uttara"
        }
    ],
    "tax_information": [
        {
            "tax_field_name": "CGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "SGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "IGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "Vat",
            "tax_field_percentage": "20"
        }
    ]
}

ou can use the following example API to delete items.

{
    "api_auth_key": "c10edad9-e361-4ba1-97e3-387f27ba4265",
    "name": "Wardrobe",
    "alternative_name": "wardrobe",
    "type": "General_Product",
    "category_name": "",
    "brand_name": "RFL",
    "supplier_name": "Mr.RFL",
    "alert_quantity": "5",
    "unit_type": "Single Unit",
    "purchase_unit_name": "PCS",
    "sale_unit_name": "PCS",
    "conversion_rate": "1",
    "purchase_price": "33",
    "whole_sale_price": "40",
    "sale_price": "55",
    "description": "Item description",
    "warranty": "1",
    "warranty_type": "Year",
    "guarantee": "1",
    "guarantee_type": "Month",
    "photo": "test.png",
    "loyalty_point": "0",
    "del_status": "Live",
    "opening_stock": [
        {
            "iem_description": "",
            "stock_quantity": "20",
            "outlet_name": "Mirput"
        },
        {
            "iem_description": "",
            "stock_quantity": "20",
            "outlet_name": "Uttara"
        }
    ],
    "tax_information": [
        {
            "tax_field_name": "CGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "SGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "IGST",
            "tax_field_percentage": "20"
        },
        {
            "tax_field_name": "Vat",
            "tax_field_percentage": "20"
        }
    ]
}

Was this page helpful?

Thank you for your feedback!

0 Comments

Leave a Comment

Sign in to post your comment or signup if you dont have any account.

Ai Replying
This website uses cookies

In publishing and graphic design, Lorem ipsum is a placeholder text commonly used to demonstrate the visual form of a document or a typeface without relying on meaningful content. Lorem ipsum may be used as a placeholder before final copy is available.

Accept All Reject All