Blink API Documentation

Introduction

To integrate with our API, you will need to obtain a username and password from our company, Blink. These credentials will serve as your authentication information for making API requests.

Follow these steps to acquire the necessary credentials:

Contact our company, Blink, to express your interest in integrating with our API. You can reach out to our support team or designated API contact for assistance.
Provide the required details about your application and the purpose of integration. This information will help us understand your specific needs and ensure a smooth integration process.
Once your request is approved, we will provide you with a unique username and password. These credentials will be associated with your account and grant you access to our API.
Safeguard your username and password as confidential information. Treat them with the same level of security as you would for other sensitive credentials associated with your application.
You are now ready to proceed with integrating our API into your application. Include the provided username and password in your API requests as part of the authentication process.

Important: Keep your credentials secure and avoid sharing them with unauthorized individuals. If you suspect any compromise or unauthorized access, contact our support team immediately.

Base URLs

Production

api.blinkco.io

Sandbox

stg-api.blinkco.io

Authorization API

The Authorization API allows you to interact with Blink API's. Obtain a bearer token using your credentials.

Endpoint

POST /interface/v1/login

Request Parameters

Parameter	Type	Required	Description
username	string	required	Blink will provide the required username.
password	string	required	Blink will provide the required password.

Sample Payload

{
    "username": "xxxxxxxxx",
    "password": "xxxxxxxxx"
}

Sample Response

{
    "token_type": "Bearer",
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9....."
}

If your request is valid, the authorization server will return an access token. If your request is invalid, it will return an error message.

Using the Token

curl -X GET \
    URL/interface/v1/branches \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1Qi...' \
    -H 'Content-Type: application/json'

Import Menu

The Products API allows you to manage products in your restaurant's menu. The Menu Sync API allows you to synchronize your local menu data with our system. By sending the menu data in the specified format, you can update, add, or remove menu items from your account.

Endpoint

POST /interface/v1/importMenu

Request Parameters

Parameter	Type	Required	Description
products	array	required	An array containing the details of the products.
products.id	string	required	The ID of the product.
products.sku	string	required	The SKU (Stock Keeping Unit) of the product.
products.name	string	required	The name of the product.
products.description	string	nullable	The description of the product.
products.tags	string	nullable	The tags of the product help in searching.
products.uom	string	nullable	The unit of measure of the product.
products.image	string	nullable	The URL of the product image.
products.is_active	boolean	required	Specifies whether the product is active or not.
products.price	decimal	required	The price of the product.
products.branches	array	nullable	An array containing the branches associated with the product.
products.branches.id	string	required	The ID of the branch.
products.branches.is_active	boolean	required	Specifies whether the branch is active or not.
products.branches.price	decimal	sometimes	The price of the product in the specific branch (null if price is same).
products.branches.stock_quantity	integer	sometimes	The stock of the product in the specific branch.
products.category.id	string	required	The ID of the category.
products.category.name	string	required	The name of the category.
products.category.reference	string	nullable	The reference of the category.
products.modifiers	array	nullable	An array containing the modifiers associated with the product.
products.modifiers.id	string	required_with: modifiers	The ID of the modifier.
products.modifiers.name	string	required_with: modifiers	The name of the modifier.
products.modifiers.maximum_options	integer	required_with: modifiers	The maximum number of options allowed for the modifier.
products.modifiers.priority	integer	required_with: modifiers	The priority of the modifier.
products.modifiers.options	array	required_with: modifiers	An array containing the options associated with the modifier.
products.modifiers.options.id	string	required_with: modifiers	The ID of the option.
products.modifiers.options.name	string	required_with: modifiers	The name of the option.
products.modifiers.options.is_active	boolean	required_with: modifiers	Specifies whether the option is active or not.
products.modifiers.options.priority	integer	required_with: modifiers	The priority of the option.
products.modifiers.options.branches	array	nullable	An array containing the branches associated with the option.
products.modifiers.options.branches.id	string	required_with: branches	The ID of the branch.

Sample Payload

{
    "products": [
        {
            "category": {
                "id": "97358e65-33c9-400c-af7d-b43a95726e08",
                "name": "pizza",
                "reference": "2",
                "image": null,
                "deleted_at": null
            },
            "modifiers": [],
            "id": "97358ea0-242f-4ffa-818f-ab07c441c291",
            "sku": "sk-0004",
            "name": "ranch pizza",
            "description": null,
            "image": null,
            "is_active": true,
            "uom": "kg",
            "tags": "pizza,chicken,fast food",
            "is_stock_product": false,
            "price": 75,
            "deleted_at": null,
            "branches": []
        },
        {
            "category": {
                "id": "97358e65-33c9-400c-af7d-b43a95726e08",
                "name": "pizza",
                "reference": "2",
                "image": null,
                "deleted_at": null
            },
            "branches": [
                {
                    "id": "12345",
                    "is_active": true,
                    "price": 94.72,
                    "is_in_stock": 1
                }
            ],
            "modifiers": [
                {
                    "options": [
                        {
                            "id": "973593a5-46ba-4e4b-868f-f55d7987bdd7",
                            "name": "ranch",
                            "sku": "sk-0010",
                            "is_active": true,
                            "price": 223.33,
                            "priority": 1,
                            "deleted_at": null,
                            "branches": [
                                {
                                    "id": 12345,
                                    "is_active": true,
                                    "price": 94.72,
                                    "is_in_stock": 1
                                }
                            ]
                        },
                        {
                            "id": "973593d1-7078-4968-b5ee-fc1400d88b5e",
                            "name": "sweet chili",
                            "sku": "sk-0011",
                            "is_active": true,
                            "price": 11,
                            "priority": 2,
                            "deleted_at": null,
                            "branches": []
                        }
                    ],
                    "minimum_options": 1,
                    "maximum_options": 3,
                    "priority": 0,
                    "id": "97359318-210a-451d-8a1f-88e2e46bd566",
                    "name": "sauceeE",
                    "deleted_at": null
                }
            ],
            "id": "97358ecc-06aa-4a8c-8249-6113261ac5a8",
            "sku": "sk-0005",
            "name": "BBQ Pizza 10",
            "description": null,
            "image": "https://s3-console-sandbox.s3./images/logo.jpg",
            "is_active": true,
            "is_stock_product": false,
            "price": 94.72,
            "deleted_at": null
        }
    ]
}

Fetch Menu

This API allows you to fetch products from your Blink restaurant's menu.

Endpoint

GET /interface/v1/fetchMenu

Response Parameters

Parameter	Type	Nullable	Description
total_items	integer	no	Total number of items available across all pages.
last_page	integer	no	The last page number of the paginated response.
current_page	integer	no	The current page number in the response.
per_page	integer	no	Number of items per page.
next_page_path	string	yes	URL to the next page of results.
last_page_path	string	yes	URL to the last page of results.
data[]	array	no	Array of menu items.
data[].id	string	no	Item ID.
data[].name	string	no	Item name.
data[].price	string	no	Item price.
data[].discount_price	string	yes	Discounted price if available.
data[].category	array	no	An array of categories the item belongs to.
data[].category[].id	integer	no	ID of the category.
data[].category[].code	string	yes	Optional code of the category.
data[].category[].name	string	no	Name of the category.
data[].branches	array	yes	List of branches offering this item.
data[].modifiers	array	yes	List of modifiers that can be applied to the item.
data[].modifiers[].id	integer	no	Modifier ID.
data[].modifiers[].code	string	yes	Modifier code.
data[].modifiers[].name	string	no	Name of the modifier group.
data[].modifiers[].is_required	boolean	no	Whether the modifier is mandatory for selection.
data[].modifiers[].max_multi_select_count	integer	no	Maximum number of options that can be selected.
data[].modifiers[].min_multi_select_count	integer	no	Minimum number of options that must be selected.
data[].modifiers[].modifier_options	array	no	List of selectable options within a modifier.
data[].modifiers[].modifier_options[].id	integer	no	ID of the modifier option.
data[].modifiers[].modifier_options[].code	string	yes	Optional code of the option.
data[].modifiers[].modifier_options[].name	string	no	Name of the option.
data[].modifiers[].modifier_options[].price	string	no	Price of the option.
data[].modifiers[].modifier_options[].discount_price	string	no	Discounted price if available.

Sample Response

{
    "total_items": 9,
    "last_page": 5,
    "current_page": 2,
    "per_page": 2,
    "next_page_path": "https://api.blinkco.io/interface/v1/fetchMenu?page=3",
    "last_page_path": "https://api.blinkco.io/interface/v1/fetchMenu?page=5",
    "data": [
        {
            "id": "",
            "name": "Parisian Platter of Mini Sandwiches",
            "price": "7199.980",
            "discount_price": "0.000",
            "category": [
                {
                    "id": 126873,
                    "code": null,
                    "name": "Cocktails & Aperitifs"
                }
            ],
            "branches": [],
            "modifiers": []
        },
        {
            "id": "",
            "name": "The PAUL Baguette with Cheese",
            "price": "1299.990",
            "discount_price": "0.000",
            "category": [
                {
                    "id": 126875,
                    "code": null,
                    "name": "Breads"
                }
            ],
            "branches": [],
            "modifiers": [
                {
                    "id": 1531139,
                    "code": null,
                    "name": "test1",
                    "is_required": false,
                    "max_multi_select_count": 3,
                    "min_multi_select_count": 2,
                    "modifier_options": [
                        {
                            "id": 12289595,
                            "code": "",
                            "name": "testa",
                            "price": "20.000",
                            "discount_price": "0.000"
                        },
                        {
                            "id": 12289596,
                            "code": "",
                            "name": "testb",
                            "price": "15.000",
                            "discount_price": "0.000"
                        }
                    ]
                }
            ]
        }
    ]
}

Stock and Price Syncing

This API allows you to manage products stock & prices in your restaurant's menu. By sending the menu data in the specified format, you can update the stock and price.

Endpoint

POST /interface/v1/syncStockAndPrice

Request Parameters

Parameter	Type	Required	Description
products	array	required	An array containing the details of the products.
products.id	string	required	The ID of the product.
products.price	decimal	required	The price of the product.
products.discount_price	decimal	required	The discount price of the product (send 0 if no discount).
products.branches	array	required	An array containing the branches associated with the product.
products.branches.id	string	required	The ID of the branch.
products.branches.price	decimal	sometimes	The price of the product in the specific branch (null if price is same).
products.branches.discount_price	decimal	sometimes	The discounted price of the product in the specific branch (null if price is same).
products.branches.stock_quantity	integer	sometimes	The stock of the product in the specific branch.

Sample Payload

{
    "products": [
        {
            "id": "97358ecc-06aa-4a8c-8249-6113261ac5a8",
            "price": 94.72,
            "discount_price": 94.72,
            "branches": [
                {
                    "id": "12345",
                    "is_active": true,
                    "price": 94.72,
                    "discount_price": 94.72,
                    "stock_quantity": 1
                }
            ]
        }
    ]
}

Order Status Webhook

The Order Status Webhook allows you to manage order status in your restaurant's system.

Receive Order Status Updates

A webhook is a mechanism used to inform external applications about specific events in real-time. Rather than requiring applications to constantly query the API for the latest data, Blink sends a webhook notification whenever a particular event occurs.

Please provide the webhook status update POST URL to Blink, in order to receive real-time orders status updates.

Webhook Timeout

Blink webhooks have a timeout of 5 seconds for requests. If your server fails to respond within this timeframe, the request will be terminated and not processed further.

Request Parameters

Field	Type	Description
branch_id	string	Represents the branch id of blink's system.
blink_order_id	string	Represents the order id of blink's system.
status	int	Current status of order according to order status table.
statusText	string	Represents the status text of order i.e "Accepted"/"Dispatched"/"Delivered" etc.
comment	string	Reason of order rejection.
created_at	datetime	Timestamp of when the status was updated (UTC).
action_by	string	Represents who performed the action on the order.

Sample Webhook Payload

{
    "blink_order_id": "1236589",
    "branch_id": "12345",
    "status": 4,
    "statusText": "Rejected",
    "comment": "TEST ORDER",
    "created_at": "2023-10-10 12:00:00",
    "action_by": "Restaurant"
}

Branches

The API allows you to fetch all branches from blink's system.

Endpoint

GET /interface/v1/branches

Sample Response

{
    "msg": "Success",
    "success": true,
    "error": null,
    "data": [
        {
            "id": 63,
            "blink_id": 60001,
            "branch": "Clifton-Block 4",
            "branch_address": "209 Bolvard center, caspian road beside Hollywood Cafe",
            "is_live": 1,
            "is_active": 1
        },
        {
            "id": 64,
            "blink_id": 60002,
            "branch": "SMCHS-12",
            "branch_address": "Plot#212 Rae Avenue road",
            "is_live": 1,
            "is_active": 1
        }
    ]
}

Customers

The API allows you to fetch all customers from blink's system.

Endpoint

GET /interface/v1/customers

Request Parameters

Field	Type	Required	Description
phone	string	optional	Represents the phone number of the customer (Format: 923XXXXXXXXX).
created_at	datetime	optional	Filter to return users who were created after the specified date.

Sample Response

{
    "msg": "Success",
    "success": true,
    "error": null,
    "data": {
        "current_page": 1,
        "data": [
            {
                "full_name": "John Doe",
                "phone": "+9233XXXXXXX",
                "gender": "Male",
                "date_of_birth": "1990-01-01",
                "created_at": "2023-01-01 00:00:00",
                "email": "[email protected]",
                "wallet_balance": "23",
                "loyalty_points": "100"
            }
        ],
        "first_page_url": "URL/interface/v1/customers?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "URL/interface/v1/customers?page=1",
        "next_page_url": null,
        "path": "URL/interface/v1/customers",
        "per_page": 100,
        "prev_page_url": null,
        "to": 4,
        "total": 4
    }
}

Map Branches

By following these steps you can map your branches with Blink's system.

Log in to your account and access the administration panel.
Locate and click on the Branch Settings option in the side menu.
In the Branch Settings page, you will see a list of your branches.
Find the branch you want to map and click on the Edit button. This will take you to the Edit Branch Settings page, where you can configure branch-specific settings.

Look for the tab labeled Step 2 and click on it to proceed.
Enter the branch code accurately in the Third Party Branches field.
After completing all the required configurations, click on the Save Branch Settings button to save your changes.

By following these steps, you will successfully map your system branches with our system. If you encounter any issues, please contact our support team for assistance.

Order Webhook

The Order Webhook allows you to manage orders in your restaurant's system.

Receive an Order

A webhook is a mechanism used to inform external applications about specific events in real-time. Rather than requiring applications to constantly query the API for the latest data, Blink sends a webhook notification whenever a particular event occurs.

Please provide the webhook POST URL to Blink, in order to receive real-time orders.

Webhook Timeout

Blink webhooks have a timeout of 5 seconds for requests. If your server fails to respond within this timeframe, the request will be terminated and not processed further.

Request Parameters

Field	Type	Description
blink_order_id	string	Represents the order id of blink's system.
external_order_id	string	Represents the order id of third-party channel (e.g Foodpanda).
order_key	string	The customers have this alphanumeric order no.
type	string	Represents the type of order: "PICK-UP" / "DINE-IN" / "DELIVERY".
status	string	Represents the status of the order (0, 1 etc).
status_text	string	Represents the status text (e.g "Pending", "Accepted").
currency	string	Currency of the order (e.g "PKR", "USD").
channel	string	The channel from which order is received (e.g ANDROID, IOS, WEBSITE, CALL-IN ORDER, QR ORDER, FOODPANDA).
channel_id	string	The channel Id (e.g ANDROID=7, IOS=8, WEBSITE=9, CALL-IN ORDER=10, QR ORDER=11, FOODPANDA=12).
brand_id	string	The ID of the brand associated with the order.
branch_id	string	The ID of the branch associated with the order.
area_name	string	The name of the area associated with the order.
blink_branch_id	string	The blink ID of the branch.
branch_latitude	string	The latitude of the branch.
branch_longitude	string	The longitude of the branch.
branch_address	string	The address of the branch.
total_discount_amount	integer	The total amount of discount applied.
promo_code	string	The promotional code used, if any.
promo_discount	integer	The discount amount applied through the promotional code.
loyalty_amount	float	The loyalty amount applied on order.
wallet_amount	float	The wallet amount applied on order.
fbr_pos_charge	float	The FBR POS charge applied on order.
tax	float	The tax applied on order.
kitchen_notes	string	Additional notes or instructions for the kitchen.
created_at	string	The creation time (UTC).
due_at	string	The order place time (ASAP) or due time (UTC) for pre-orders.
is_pre_order	integer	The is_pre_order will be either 0 or 1.
customer_name	string	The name of the customer placing the order.
customer_phone	string	The phone number of the customer.
customer_address_description	string	Description of the customer's address.
customer_address_latitude	null	The latitude of the customer's address.
customer_address_longitude	null	The longitude of the customer's address.
payment	boolean	Returns true if paid, else false.
payment_method	string	The payment method (Cash or other selected method).
payment_method_id	string	The payment method ID (Cash=0, or other).
delivery_charges	string	The delivery charges.
subtotal	string	The subtotal of order.
total_price	string	The total price of order.
products	array	An array of products included in the order.
products[].product_id	string	The ID of the product.
products[].quantity	integer	The quantity of the product.
products[].name	string	The name of the product.
products[].unit_price	string	The unit price of the product.
products[].total_price	integer	The total price of the product.
products[].item_price	integer	The item price of the product.
products[].item_discount_price	integer	The item discount price of the product.
products[].options	array	An array of options chosen for the product.
products[].options[].modifier_option_id	string	The ID of the selected modifier option.
products[].options[].unit_price	string	The unit price of the selected modifier option.
products[].options[].total_price	string	The total price of the selected modifier option.
products[].options[].item_price	string	The item price of the selected modifier option.
products[].options[].item_discount_price	string	The item discount price of the selected modifier option.
products[].options[].name	string	The name of the selected modifier option.
products[].options[].quantity	integer	The quantity of the selected modifier option.

Webhook Payload

{
    "blink_order_id": "1236589",
    "external_order_id": "UYI-9IY",
    "order_key": "ABND-24234",
    "type": "PICK-UP",
    "status": "0",
    "status_text": "PENDING",
    "currency": "PKR",
    "channel": "IOS",
    "channel_id": "8",
    "area_name": "Precinct-11A",
    "brand_id": "2131",
    "branch_id": "12345",
    "blink_branch_id": "50220",
    "branch_latitude": "27.4654584",
    "branch_longitude": "64.846548",
    "branch_address": "XYZ road street 13",
    "total_discount_amount": 0,
    "promo_code": "",
    "promo_discount": 0,
    "wallet_amount": 0,
    "loyalty_amount": 0,
    "tax": 0,
    "fbr_pos_charge": 1,
    "kitchen_notes": "",
    "created_at": "2024-06-26 09:26:04",
    "due_at": "2024-06-26 09:26:04",
    "is_pre_order": 0,
    "customer_name": "John Doe",
    "customer_phone": "+923300000000",
    "customer_address_description": "PICK-UP",
    "customer_address_latitude": null,
    "customer_address_longitude": null,
    "products": [
        {
            "product_id": "1c54bd7abe7b",
            "quantity": 1,
            "name": "Veg Breakfast Press COMBO",
            "unit_price": "39.000",
            "total_price": 39,
            "item_price": "39.00",
            "item_discount_price": "0.00",
            "options": [
                {
                    "modifier_option_id": "cfeed7290c4c",
                    "unit_price": "0.000",
                    "total_price": "0.000",
                    "name": "Tortilla (Wrap)",
                    "quantity": 1,
                    "item_price": "0.00",
                    "item_discount_price": "0.00"
                }
            ]
        }
    ],
    "payment": true,
    "payment_method_id": "0",
    "payment_method": "Cash",
    "delivery_charges": "0",
    "subtotal": "59",
    "total_price": "66.67"
}

Submit Order

This API allows you to push new orders to the Blink system.

Endpoint

POST /interface/v1/submitOrder

Authorization

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9............

Request Parameters

Parameter	Type	Required	Description
blink_branch_id	string	required	Represents the branch id of blink's system.
delivery.house_num	string	required	The house/flat number of the customer.
delivery.street	string	required	The street name of the customer's address.
delivery.building	string	optional	The building name in the customer's address.
delivery.area	string	required	The area/locality of the customer's address.
delivery.city	string	required	The city of the customer's address.
delivery.latitude	float	optional	The latitude coordinate of the customer's address.
delivery.longitude	float	optional	The longitude coordinate of the customer's address.
customer_name	string	required	The name of the customer placing the order.
customer_phone	string	required	The phone number. Formats: +92xxxx, +92xxx-xxx
customer_email	string	optional	The email address of the customer.
is_scheduled	integer	required	Indicates if the order is scheduled (1) or ASAP (0).
scheduled_delivery_time	string	optional	The scheduled time for delivery (if applicable).
delivery_type	string	required	The type of delivery: dinein, pickup, or delivery.
payment_method	string	required	The selected payment method: Cash or Online.
tax_amount	string	optional	The tax amount applied to the order.
tax_percentage	string	optional	The tax percentage applied on the subtotal.
subtotal	string	required	The subtotal of the order before taxes and charges.
total	string	required	The final total amount of the order.
delivery_charges	string	required	The charges applied for delivery.
delivery_eta	integer	optional	Estimated delivery time in minutes. Default: 60
instructions	string	optional	Any additional instructions from the customer.
items	array	required	An array of items included in the order.
items[].blink_item_id	string	required	The blink's ID of the ordered item.
items[].name	string	required	The name of the ordered item.
items[].description	string	optional	The description of the ordered item.
items[].notes	string	optional	Additional notes for the item.
items[].actual_price	string	required	The original price of the item.
items[].price	string	required	The selling price of the item.
items[].quantity	string	required	The quantity of the item ordered.
items[].sub_options	array	optional	An array of sub-options/modifiers for the item.
items[].sub_options[].sub_option_id	string	required	The ID of the sub-option.
items[].sub_options[].price	string	required	The price of the selected sub-option.
items[].sub_options[].quantity	string	required	The quantity of the selected sub-option.

Sample Payload

{
    "blink_branch_id": "60002",
    "delivery": {
        "house_num": "Flat B-1203",
        "street": "Rashid Minhas Road",
        "building": "Noman Grand City",
        "area": "Gulshan-e-Iqbal Block 7",
        "city": "Karachi",
        "latitude": 24.918682,
        "longitude": 67.102982
    },
    "customer_phone": "+92333-2222222",
    "customer_name": "Test Order User",
    "is_scheduled": 1,
    "scheduled_delivery_time": "22-05-2025 08:00 PM",
    "delivery_type": "delivery",
    "payment_method": "Cash",
    "tax_amount": "12",
    "tax_percentage": "0",
    "subtotal": "90",
    "total": "132",
    "delivery_charges": "30",
    "delivery_eta": 45,
    "instructions": "test note",
    "items": [
        {
            "blink_item_id": "257327",
            "name": "Nestle MilkPak Full Cream Milk 250ml",
            "description": "Nestle MilkPak Full Cream Milk 250ml",
            "notes": "test note",
            "actual_price": "110",
            "price": "85",
            "quantity": "2",
            "sub_options": [
                {
                    "sub_option_id": "596996",
                    "price": "5",
                    "quantity": "1"
                }
            ]
        }
    ]
}

Sample Response

HTTP Code: 201 Content Type: JSON

{
    "success": true,
    "msg": "Your order has been placed",
    "data": {
        "id": 988278,
        "unique_code": "2349-JLMD3"
    }
}

Fetch Order

This API allows you to get order details from blink's system.

Endpoint

GET /interface/v1/getOrder

Authorization

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9............

Query Parameters

Parameter	Type	Required	Description
order_id	string	required	The ID of the order. Example: 34862444
unique_code	string	optional	The unique code of the order.

Sample Response

HTTP Code: 201 Content Type: JSON

{
    "success": true,
    "data": {
        "id": 988309,
        "unique_code": "1T4I-C7WC1",
        "customer_name": "Test Order User",
        "customer_phone": "+923332222222",
        "latitude": "24.918682",
        "longitude": "67.102982",
        "delivery_eta": 45,
        "delivery_type": "delivery",
        "status": "ACCEPTED",
        "ordertime": "2025-05-22 08:02:10",
        "instruction": "test note",
        "payment_method": "Cash",
        "subtotal": 90,
        "total": 132,
        "delivery_charges": 30,
        "promo_code": "",
        "promo_discount": 0,
        "reject_reason": "",
        "items": [
            {
                "item_id": 257327,
                "quantity": 2,
                "price": 90,
                "actual_price": 115,
                "details": "Nestle MilkPak Full Cream Milk 250ml",
                "notes": "test note"
            }
        ]
    }
}

Order List

This API allows you to get all order details from blink's system.

Endpoint

GET /interface/v1/getOrderList

Authorization

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9............

Query Parameters

Parameter	Type	Required	Description
order_id	string	required	Orders with order_id greater than this value will return in response. Example: 34862444

Sample Response

HTTP Code: 200 Content Type: JSON

{
    "success": true,
    "data": [
        {
            "id": 34862445,
            "unique_code": "KXC2-SQ740",
            "customer_name": "John Doe",
            "customer_phone": "+920554897875",
            "delivery_type": "delivery",
            "status": "REJECTED",
            "ordertime": "2024-01-07 08:51:46",
            "payment_method": "Cash",
            "subtotal": 47,
            "total": 53.11,
            "delivery_charges": 0,
            "items": [
                {
                    "item_id": 1567138,
                    "quantity": 1,
                    "price": 23,
                    "actual_price": 23,
                    "details": "Chicken Bites 8 Pcs",
                    "notes": null
                }
            ]
        }
    ],
    "pagination": {
        "total": 441,
        "per_page": 30,
        "current_page": 1,
        "last_page": 15,
        "from": 1,
        "to": 30,
        "has_more": true
    }
}

Get Abandoned Carts

This API allows you to fetch abandoned cart data from blink's system. Use it to retrieve carts that customers created but did not convert into orders, enabling follow-up engagement and recovery campaigns.

Endpoint

GET /interface/v1/getAbandonedCarts

Authorization

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9............

Query Parameters

Parameter	Type	Required	Description
start_date	string	required	Start date-time for the query range. Format: `YYYY-MM-DD HH:mm`
end_date	string	required	End date-time for the query range. Format: `YYYY-MM-DD HH:mm`

Sample Response

HTTP Code: 200 Content Type: JSON

{
    "success": true,
    "pagination": {
        "total": 177,
        "per_page": 5,
        "current_page": 1,
        "last_page": 36,
        "from": 1,
        "to": 5,
        "has_more": true
    },
    "data": {
        "current_page": 1,
        "data": [
            {
                "order_id": "",
                "branch_id": "",
                "customer": {
                    "name": "Test User",
                    "phone": "+9233XXXXXXX",
                    "address": "",
                    "latitude": "",
                    "longitude": ""
                },
                "notification": {
                    "status": "SENT",
                    "sent_at": "2026-02-09 08:34:04"
                },
                "created_at": "2026-02-09 08:08:18",
                "cart_value": 744,
                "cart_items": [
                    {
                        "dish_id": 722688,
                        "quantity": 1,
                        "details": "Abbott Similac Total Comfort 2 (6-12 Months) 360g",
                        "unit_price": "142.000",
                        "actual_unit_price": "142.000",
                        "total_price": "344.0",
                        "actual_total_price": "344.0",
                        "selected_suboption_ids": "[]",
                        "options": [
                            {
                                "id": 707758,
                                "name": "Variation",
                                "suboptions": [
                                    {
                                        "id": 6044445,
                                        "name": "per unit",
                                        "price": "0.000",
                                        "actual_price": "0.000"
                                    }
                                ]
                            },
                            {
                                "id": 191554,
                                "name": "Sauce",
                                "suboptions": [
                                    {
                                        "id": 6052048,
                                        "name": "test",
                                        "price": "0.000",
                                        "actual_price": "200.000"
                                    },
                                    {
                                        "id": 896289,
                                        "name": "Buffalo",
                                        "price": "0.000",
                                        "actual_price": "2.000"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

Order Status Syncing

The Order Status API allows you to update order status in blink's system.

Endpoint

POST /interface/v1/syncOrderStatus

Order Status

Status	Description
0 — Pending	When the order is created in Blink it will land in the `PENDING` status.
1 — Accepted	When the order is accepted the status will be updated to `ACCEPTED`.
6 — Ready	When the order is ready for dispatch, status becomes `READY`.
2 — Dispatched	When the order is dispatched, status becomes `DISPATCHED`.
3 — Delivered	When the order is delivered, status becomes `DELIVERED`.
4 — Rejected	When the order is rejected, status becomes `REJECTED`.

Request Parameters

Parameter	Type	Required	Description
blink_order_id	string	required	An order id that is provided by Blink at the time of order.
status	int	required	Current status of order according to order status table above.
comment	string	required if status is 4	Reason of order rejection.

Sample Payloads

Accept an order:

{
    "blink_order_id": "123456",
    "status": 1
}

Reject an order:

{
    "blink_order_id": "123456",
    "status": 4,
    "comment": "Delivery area is too far"
}

Introduction to Blink Logistics

To integrate with our Logistics API, you will need to obtain a token from our Blink Logistics Portal. This token will serve as your authentication information for making API requests.

Logistics Base URLs

Production

https://api-delivery.blinkco.io

Sandbox

https://stg-delivery.blinkco.io

Important: Keep your credentials secure and avoid sharing them with unauthorized individuals. If you suspect any compromise, contact our support team immediately.

Task Creation

The API allows you to send a task to the logistics portal.

Endpoint

POST /api/client/task

Authorization

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9............

Request Parameters

Parameter	Type	Required	Description
source	string	optional	The source of the task creation.
mappingKey	string	required	Reference Task Id.
mappingCode	string	required	Reference Task Id.
mappingBranchId	string	required	The ID of the branch.
discountCode	string	optional	The discount code used in the task.
tax	decimal	optional	The tax value of the task.
taxPercent	decimal	optional	The tax percentage of the task.
discount	decimal	optional	The discount amount of the task.
deliveryCharges	decimal	optional	The delivery charges of the task.
subTotal	decimal	optional	The sub total of the task.
paymentType	string	required	Payment method: COD (Cash on Delivery) or ONLINE.
description	string	optional	The task description.
instruction	string	optional	The task instructions.
customerName	string	required	The name of the customer.
customerEmail	string	optional	The email of the customer.
customerAddress	string	required	The address of the customer.
customerPhone	string	required	The phone number of the customer.
lat	string	required	The latitude of the customer's address.
lng	string	required	The longitude of the customer's address.
pickUpTime	datetime	required	The pickup time of the task (UTC Format).
deliveryTime	datetime	required	The delivery time of the task (UTC Format).
type	integer	required	The type of task: 1 (normal) or 2 (return).

Sample Payload

{
    "source": "SourceTesting",
    "mappingKey": "12345678",
    "mappingCode": "12345678",
    "mappingBranchId": "12345",
    "discountCode": "",
    "tax": 0,
    "taxPercent": 0,
    "discount": 0,
    "deliveryCharges": 120,
    "subTotal": 2080,
    "paymentType": "COD",
    "description": "Details: Milk Buffalo 1 Ltr Pouch, Quantity: 8",
    "instruction": "",
    "customerName": "Test Customer",
    "customerEmail": "[email protected]",
    "customerAddress": "Tariq Road, PECHS Block 2",
    "customerPhone": "923001234567",
    "lat": "24.871641",
    "lng": "67.059906",
    "deliveryTime": "2024-06-06T04:29:15.000Z",
    "pickUpTime": "2024-06-06T03:29:15.000Z",
    "type": 1
}

Sample Response

HTTP Code: 201 Content Type: JSON

{
    "eventId": 20,
    "event": "TASK_CREATED",
    "data": {
        "taskId": "XYZAB-12345",
        "type": 1
    }
}

Task Update

The API allows you to update an existing task.

Endpoint

PUT /api/client/task

Authorization

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9............

Request Parameters

Parameter	Type	Required	Description
taskId	string	required	Blink logistics unique Id.
discountCode	string	optional	The discount code used in the task.
tax	decimal	optional	The tax value of the task.
taxPercent	decimal	optional	The tax percentage of the task.
discount	decimal	optional	The discount amount of the task.
deliveryCharges	decimal	optional	The delivery charges of the task.
subTotal	decimal	optional	The sub total of the task.
paymentType	string	optional	Payment method: COD or ONLINE.
description	string	optional	The task description.
instruction	string	optional	The task instructions.
customerName	string	optional	The name of the customer.
customerEmail	string	optional	The email of the customer.
customerAddress	string	optional	The address of the customer.
customerPhone	string	optional	The phone number of the customer.
lat	string	optional	The latitude of the customer's address.
lng	string	optional	The longitude of the customer's address.
pickUpTime	datetime	optional	The pickup time of the task (UTC Format).
deliveryTime	datetime	optional	The delivery time of the task (UTC Format).
type	integer	required	Task type: 1 (normal) or 2 (return).

Sample Response

HTTP Code: 201 Content Type: JSON

{
    "eventId": 21,
    "event": "TASK_UPDATED",
    "data": {
        "taskId": "XYZAB-12345",
        "type": 1
    }
}

Get Task Status

The API allows you to get the task updated status.

Endpoint

GET /api/client/task/status

Authorization

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9............

Query Parameters

Parameter	Type	Description
mappingKey	string	Reference key. Example: 12345678

Sample Response

HTTP Code: 200 Content Type: JSON

{
    "eventId": 24,
    "event": "TASK_ACCEPTED",
    "data": {
        "taskId": "XYZAB-12345",
        "type": 1,
        "reason": "",
        "agent": {
            "name": "Test Rider",
            "contact": "+923213456789"
        },
        "trackingLink": "https://delivery-stg.blinkco.io/tracking/jvkUgPIRN6f8jZg9q62xy"
    }
}

Task Status Reference

Event Id	Event Name	Description
20	TASK_CREATED	A new order or shipment has been created in the system.
21	TASK_UPDATED	An existing order or shipment details have been modified.
22	TASK_UNASSIGN	An order previously assigned to a driver is now unassigned.
23	TASK_ASSIGNED	An order has been allocated to a specific driver for processing.
24	TASK_ACCEPTED	The assigned driver has confirmed they can handle the order.
25	TASK_ARRIVED	The driver has reached the collection point.
26	TASK_STARTED	The driver has started moving toward the delivery location.
27	TASK_FINISHED	The goods have been delivered to the final destination.
28	TASK_CANCELLED	The order has been cancelled before completion.
29	TASK_REASSIGNED	The order has been re-assigned to a different driver.

Task Status Webhook

This webhook allows you to update order status according to task status.

Please update the webhook URL in the Blink Logistics portal in order to receive real-time task status.

Sample Webhook Payload

Content Type: JSON

{
    "eventId": 24,
    "event": "TASK_ACCEPTED",
    "data": {
        "taskId": "XYZAB-12345",
        "type": 1,
        "reason": "",
        "agent": {
            "name": "Test Rider",
            "contact": "+923213456789"
        },
        "trackingLink": "https://delivery-stg.blinkco.io/tracking/jvkUgPIRN6f8jZg9q62xy"
    }
}

Introduction

Base URLs

Authorization API

Endpoint

Request Parameters

Sample Payload

Sample Response

Using the Token

Import Menu

Endpoint

Request Parameters

Sample Payload

Fetch Menu

Endpoint

Response Parameters

Sample Response

Stock and Price Syncing

Endpoint

Request Parameters

Sample Payload

Order Status Webhook

Receive Order Status Updates

Webhook Timeout

Request Parameters

Sample Webhook Payload

Branches

Endpoint

Sample Response

Customers

Endpoint

Request Parameters

Sample Response

Map Branches

Order Webhook

Receive an Order

Webhook Timeout

Request Parameters

Webhook Payload

Orders

Submit Order

Endpoint

Authorization

Request Parameters

Sample Payload

Sample Response

Fetch Order

Endpoint

Authorization

Query Parameters

Sample Response

Order List

Endpoint

Authorization

Query Parameters

Sample Response

Get Abandoned Carts

Endpoint

Authorization

Query Parameters

Sample Response

Order Status Syncing

Endpoint

Order Status

Request Parameters

Sample Payloads

Logistics

Introduction to Blink Logistics

Logistics Base URLs

Task Creation

Endpoint

Authorization

Request Parameters

Sample Payload

Sample Response

Task Update

Endpoint

Authorization

Request Parameters

Sample Response

Get Task Status