NAV Navbar
http
  • Introduction
  • General Setting
  • Authentication
  • Geos
  • Businesses
  • Trackings
  • Webhook
  • Request
  • Introduction

    Welcome to the Snappy API! You can use our API to access Snappy API endpoints, which can get information on various trackings, businesses and payments in our database.

    We have language bindings in Http and you can view code examples in the dark area to the right.

    General Setting

    Environment

    Authentication

    The first you must have a snappy account by access https://snappy.vn/register or login into our website via https://snappy.vn/login. After that, you can redirect to https://snappy.vn/businesses to show all of your businesses. Then pick one of your favorite business. And finally, you can create Snappy's access_token and callback URL using for webhook from the API tab.

    Snappy expects for the access_token to be included in almost API requests to the server as a param that looks like the following:

    Authorization: access_token

    Geos

    Get Provinces

    GET /geo/provinces HTTP/1.1
    

    Response

    {
        "data": [
            {
                "id": "101",
                "name": "Hà Nội",
                "name_en": "ha noi"
            },
            {
                "id": "701",
                "name": "Hồ Chí Minh",
                "name_en": "ho chi minh"
            },
            {
                "id": "221",
                "name": "Bắc Giang",
                "name_en": "bac giang"
            },
            {
                "id": "207",
                "name": "Bắc Kạn",
                "name_en": "bac kan"
            },
            {
                "id": "821",
                "name": "Bạc Liêu",
                "name_en": "bac lieu"
            },
            ...
        ]
    }
    

    This endpoint retrieves all provinces.

    HTTP Request

    GET /geo/provinces

    Get Districts

    GET /geo/districts HTTP/1.1
    

    Response

    {
        "data": [
            {
                "id": "10101",
                "name": "Quận Ba Đình",
                "name_en": "ba dinh"
            },
            {
                "id": "10129",
                "name": "Huyện Ba Vì",
                "name_en": "ba vi"
            },
            {
                "id": "10155",
                "name": "Quận Bắc Từ Liêm",
                "name_en": "bac tu liem"
            },
            {
                "id": "10113",
                "name": "Quận Cầu Giấy",
                "name_en": "cau giay"
            },
            {
                "id": "10141",
                "name": "Huyện Chương Mỹ",
                "name_en": "chuong my"
            },
            ...
        ]
    }
    

    This endpoint retrieves all districts of given province.

    HTTP Request

    GET /geo/districts

    Query Parameters

    Parameter Required Type Default Description
    province_id true string Province id of districts you want to retrieve. Get province id in api GET /geo/provinces

    Get Communes

    GET /geo/communes HTTP/1.1
    

    Response

    {
        "data": [
            {
                "id": "1010115",
                "name": "Phường Cống Vị",
                "name_en": "cong vi"
            },
            {
                "id": "1010109",
                "name": "Phường Điện Biên",
                "name_en": "dien bien"
            },
            {
                "id": "1010113",
                "name": "Phường Đội Cấn",
                "name_en": "doi can"
            },
            {
                "id": "1010119",
                "name": "Phường Giảng Võ",
                "name_en": "giang vo"
            },
            {
                "id": "1010111",
                "name": "Phường Kim Mã",
                "name_en": "kim ma"
            },
            ...
        ]
    }
    

    This endpoint retrieves all communes of given district.

    HTTP Request

    GET /geo/communes

    Query Parameters

    Parameter Required Type Default Description
    district_id true string District id of communes you want to retrieve. Get district id in api GET /geo/districts

    Businesses

    Get All Businesses

    GET /snappy/users/me?access_token=<access_token> HTTP/1.1
    

    Response

    {
        "businesses": [
            {
                "addresses": [
                    {
                        "address": "Số 1 ABC",
                        "commune_id": null,
                        "district_id": "10101",
                        "full_address": "SG1 - Số 1 ABC, Quận Ba Đình, Hà Nội",
                        "id": "82019ce2-088d-4cb1-8e8a-c6255d12ce6c",
                        "is_default": true,
                        "phone_number": "+84937123123",
                        "province_id": "101",
                        "zipcode": null
                    }
                ],
                "business_payments": [],
                "id": 63,
                "inserted_at": "2018-04-17T15:07:49",
                "is_default": true,
                "is_owner": true,
                "last_payment_at": null,
                "name": "SG1",
                "owner_id": "14d4a1a1-ea42-4164-805d-e240f2561f71",
                "owner_name": "SG1",
                "packages": [],
                "payment_methods": [],
                "phone_number": "0937123123",
                "remaining_balance": 0,
                "total_balance": 0,
                "tracking_count": 3,
                "unique_name": "S61",
                "updated_at": "2018-04-17T15:14:26"
            }
        ],
        "data": {
            "email": "user37@gmail.com",
            "fb_id": null,
            "id": "14d4a1a1-ea42-4164-805d-e240f2561f71",
            "name": "SG1",
            "phone_number": "+84937123123"
        },
        "me": {
            "fb_id": null,
            "uid": "14d4a1a1-ea42-4164-805d-e240f2561f71"
        },
        "success": true,
        "uid": "14d4a1a1-ea42-4164-805d-e240f2561f71"
    }
    

    This endpoint retrieves all businesses and basic user info.

    HTTP Request

    GET /snappy/users/me

    Query Parameters

    Parameter Required Type Default Description
    access_token true string Your personal acess_token

    Get a Specific Business

    GET /snappy/businesses/<ID>?access_token=<access_token> HTTP/1.1
    

    Response

    {
        "business": {
            "addresses": [
                {
                    "address": "Số 1 ABC",
                    "commune_id": null,
                    "district_id": "10101",
                    "full_address": "SG1 - Số 1 ABC, Quận Ba Đình, Hà Nội",
                    "id": "82019ce2-088d-4cb1-8e8a-c6255d12ce6c",
                    "is_default": true,
                    "phone_number": "+84937123123",
                    "province_id": "101",
                    "zipcode": null
                }
            ],
            "business_payments": [],
            "coupons": [],
            "id": 63,
            "inserted_at": "2018-04-17T15:07:49",
            "is_default": true,
            "is_owner": true,
            "last_payment_at": null,
            "name": "SG1",
            "owner_id": "14d4a1a1-ea42-4164-805d-e240f2561f71",
            "owner_name": "SG1",
            "packages": [],
            "payment_methods": [],
            "phone_number": "0937123123",
            "remaining_balance": 0,
            "total_balance": 0,
            "tracking_count": 3,
            "unique_name": "S61",
            "updated_at": "2018-04-17T15:14:26"
        },
        "success": true
    }
    

    This endpoint retrieves a specific business.

    HTTP Request

    GET /snappy/businesses/<ID>

    URL Parameters

    Parameter Required Type Default Description
    access_token true string Your personal acess_token
    ID true integer Id of a business in list businesses. Get in api GET /user/me

    Create Business Address

    POST /snappy/businesses/address/create?access_token=<access_token> HTTP/1.1
    

    Sample params

    {
        "business_id": 63,
        "name": "Kho hàng Thái Hà",
        "phone_number": "0999999999",
        "address": "123 Thái Hà",
        "province_id": "101",
        "district_id": "10109",
        "commune_id": "1010939",
        "is_default": true
    }
    

    Response if success

    {
        "business": {
            "addresses": [
                {
                    "address": "123 Thái Hà",
                    "commune_id": "1010101",
                    "district_id": "10101",
                    "full_address": "Kho hàng Thái Hà - 123 Thái Hà Phường Láng Hạ, Quận Đống Đa, Hà Nội",
                    "id": "6c5d5327-5e1d-4a01-9022-d4f3c5fa229e",
                    "is_default": true,
                    "phone_number": "+84999999999",
                    "province_id": "101",
                    "zipcode": null
                }
            ],
            "business_payments": [],
            "hotlines": null,
            "id": 63,
            "inserted_at": "2018-03-17T15:07:49",
            "is_default": true,
            "is_owner": true,
            "last_payment_at": "2018-04-19T15:34:27",
            "name": "SG1",
            "owner_id": "14d4a1a1-ea42-4164-805d-e240f2561f71",
            "owner_name": "SG1",
            "packages": [],
            "payment_methods": [],
            "phone_number": "0888888888",
            "tracking_count": 6,
            "unique_name": "S63",
            "updated_at": "2018-12-10T10:28:12"
        },
        "message": "Bạn đã tạo kho hàng mới thành công",
        "success": true
    }
    

    This endpoint create an address into your business.

    HTTP Request

    POST /snappy/businesses/address/create

    URL Parameters

    Parameter Required Type Default Description
    access_token true string Your personal acess_token
    business_id true integer Id of a business in list businesses. Get in api GET /user/me
    name true string Name of business address
    phone_number true string Phone number of business address
    address true string Address of business address
    province_id true string Id of business address's province. Get in api GET /geo/provinces
    district_id true string Id of business address's district. Get in api GET /geo/districts
    commune_id false string Id of business address's commune. Get in api GET /geo/communes
    is_default false boolean false If true this business address will set to default business address

    Update Business Address

    POST /snappy/businesses/address/update?access_token=<access_token> HTTP/1.1
    

    Sample params

    {
        "business_address_id": "27d22b0e-0153-4830-8632-38645ab2a642",
        "business_id": 63,
        "name": "Kho hàng Thái Hà",
        "phone_number": "0999999999",
        "address": "123 Thái Hà",
        "province_id": "101",
        "district_id": "10109",
        "commune_id": "1010939",
        "is_default": true
    }
    

    Response if success

    {
        "business": {
            "addresses": [
                {
                    "address": "123 Thái Hà",
                    "commune_id": "1010101",
                    "district_id": "10101",
                    "full_address": "Kho hàng Thái Hà - 123 Thái Hà Phường Láng Hạ, Quận Đống Đa, Hà Nội",
                    "id": "6c5d5327-5e1d-4a01-9022-d4f3c5fa229e",
                    "is_default": true,
                    "phone_number": "+84999999999",
                    "province_id": "101",
                    "zipcode": null
                }
            ],
            "business_payments": [],
            "hotlines": null,
            "id": 63,
            "inserted_at": "2018-03-17T15:07:49",
            "is_default": true,
            "is_owner": true,
            "last_payment_at": "2018-04-19T15:34:27",
            "name": "SG1",
            "owner_id": "14d4a1a1-ea42-4164-805d-e240f2561f71",
            "owner_name": "SG1",
            "packages": [],
            "payment_methods": [],
            "phone_number": "0888888888",
            "tracking_count": 6,
            "unique_name": "S63",
            "updated_at": "2018-12-10T10:28:12"
        },
        "message": "Bạn đã cập nhật kho hàng thành công",
        "success": true
    }
    

    This endpoint update an address into your business.

    HTTP Request

    POST /snappy/businesses/address/update

    URL Parameters

    Parameter Required Type Default Description
    access_token true string Your personal acess_token
    business_id true integer Id of a business in list businesses. Get in api GET /user/me
    business_address_id true string Id UUID of one of business address. Get in api GET /businesses/
    name true string Name of business address
    phone_number true string Phone number of business address
    address true string Address of business address
    province_id true string Id of business address's province. Get in api GET /geo/provinces
    district_id true string Id of business address's district. Get in api GET /geo/districts
    commune_id false string Id of business address's commune. Get in api GET /geo/communes
    is_default false boolean false If true this business address will set to default business address

    Trackings

    Get Trackings

    GET /snappy/trackings?access_token=<access_token> HTTP/1.1
    

    Response

    {
        "success": true,
        "trackings_data": {
            "page_number": 1,
            "page_size": 20,
            "total_entries": 1,
            "total_pages": 1,
            "trackings": [
                {
                    "business_address_id": "524a9669-2cd4-4ec1-9c7f-1a18412391aa",
                    "department": {
                        "address": "35 Lê Văn Thiêm, Phường Nhân Chính",
                        "commune_id": "1011101",
                        "district_id": "10111",
                        "district_name": "Quận Thanh Xuân",
                        "full_address": "35 Lê Văn Thiêm, Phường Nhân Chính Quận Thanh Xuân Hà Nội",
                        "id": -1,
                        "name": "Snappy HN",
                        "province_id": "101",
                        "province_name": "Hà Nội",
                        "second_phone_number": "",
                        "shippo_id": "1161"
                    },
                    "creator_id": "51f003b6-28c1-444f-a1dd-670a2234ab8d",
                    "status_color": "#639026",
                    "picked_up_at": "2020-08-18T10:49:38",
                    "returned_at": null,
                    "customer_tracking_id": "SNAPPY172233NCM2018",
                    "tags": [],
                    "last_update": {
                        "last_updated_at": null,
                        "location": null,
                        "note": "Thành Công",
                        "status": "Giao thành công",
                        "status_color": "#639026",
                        "updated_at": "2020-08-19T07:44:39"
                    },
                    "addition_services": [],
                    "receiver_commune_id": null,
                    "from": {
                        "address": "Số 37, Ngõ 107 Đào Tấn, Ba Đình, Hà Nội",
                        "commune_id": "1010115",
                        "district_id": "10101",
                        "full_address": "Đuôi Gà - Số 37, Ngõ 107 Đào Tấn, Ba Đình, Hà Nội - Phường Cống Vị, Quận Ba Đình, Hà Nội",
                        "id": "524a9669-2cd4-4ec1-9c7f-1a18412391aa",
                        "name": "Đuôi Gà",
                        "phone_number": "0328023559",
                        "province_id": "101",
                        "real_address": {
                            "address": "Số 12A ngách 121 Ngõ Thịnh Quang, Đi Từ Vĩnh Hồ Vào Đên Cuối Đường Rẽ Trái",
                            "commune_id": "",
                            "district_id": "10109",
                            "full_address": "Số 12A ngách 121 Ngõ Thịnh Quang, Đi Từ Vĩnh Hồ Vào Đên Cuối Đường Rẽ Trái - Quận Đống Đa, Hà Nội",
                            "province_id": "101"
                        },
                        "return_address": null
                    },
                    "current_status": "Giao thành công",
                    "business": {
                        "hotlines": "0944603696, 0336895861, 0961309527, 0974573885",
                        "id": 1523,
                        "name": "duoigashop",
                        "owner": {
                            "avatar_url": null,
                            "email": "phantronggiap@gmail.com",
                            "fb_id": null,
                            "id": "51f003b6-28c1-444f-a1dd-670a2234ab8d",
                            "name": "duoigashop",
                            "permission": 1,
                            "phone_number": "+84974573885",
                            "signatures": null
                        },
                        "phone_number": "+84974573885"
                    },
                    "id": "S29975697",
                    "receiver_province_id": "101",
                    "creator": {
                        "avatar_url": null,
                        "email": "phantronggiap@gmail.com",
                        "fb_id": null,
                        "id": "51f003b6-28c1-444f-a1dd-670a2234ab8d",
                        "name": "duoigashop",
                        "permission": 1,
                        "phone_number": "+84974573885",
                        "signatures": null
                    },
                    "log": {
                        "payment_status": "locked",
                        "updated_at": "2020-08-19T14:05:01"
                    },
                    "balance_adjustment": -16000,
                    "short_id": 997569,
                    "sny_warehouse_id": null,
                    "business_id": 1523,
                    "delivered_at": "2020-08-18T16:04:36",
                    "updated_at": "2020-08-19T07:46:02",
                    "tracking_undeliverable": null,
                    "updates": [
                        {
                            "is_extend_update": true,
                            "last_updated_at": null,
                            "location": null,
                            "note": "Đã giao",
                            "status": "Giao thành công",
                            "updated_at": "2020-08-18T16:04:36"
                        },
                        {
                            "is_extend_update": true,
                            "last_updated_at": null,
                            "location": null,
                            "note": "Đang giao",
                            "status": "Đang giao",
                            "updated_at": "2020-08-18T13:17:57"
                        },
                        {
                            "is_extend_update": true,
                            "last_updated_at": null,
                            "location": null,
                            "note": "Chờ giao",
                            "status": "Đang trong kho",
                            "updated_at": "2020-08-18T10:49:38"
                        },
                        {
                            "is_extend_update": true,
                            "last_updated_at": null,
                            "location": null,
                            "note": "Tạo đơn",
                            "status": "Đang lấy hàng",
                            "updated_at": "2020-08-18T09:15:03"
                        },
                        {
                            "editor": {
                                "avatar_url": null,
                                "email": "phantronggiap@gmail.com",
                                "fb_id": null,
                                "id": "51f003b6-28c1-444f-a1dd-670a2234ab8d",
                                "name": "duoigashop",
                                "permission": 1,
                                "phone_number": "+84974573885",
                                "signatures": null
                            },
                            "last_editor": {
                                "avatar_url": null,
                                "email": "phantronggiap@gmail.com",
                                "fb_id": null,
                                "id": "51f003b6-28c1-444f-a1dd-670a2234ab8d",
                                "name": "duoigashop",
                                "permission": 1,
                                "phone_number": "+84974573885",
                                "signatures": null
                            },
                            "last_updated_at": "2020-08-18T09:15:02",
                            "location": "Đuôi Gà - Số 37, Ngõ 107 Đào Tấn, Ba Đình, Hà Nội - Phường Cống Vị, Quận Ba Đình, Hà Nội",
                            "note": "Gọi cho khách trước khi đến. Shop cám ơn bưu tá",
                            "status": "Đơn mới",
                            "status_color": "#AD7E05",
                            "updated_at": "2020-08-18T09:15:02"
                        }
                    ],
                    "receiver_district_id": "10113",
                    "services": {
                        "cod_service": {
                            "amount": 0,
                            "cost": 0,
                            "is_save_log_cod": true,
                            "use_cod": false
                        },
                        "discount": {
                            "department": "HN",
                            "discount_percentage": 20
                        },
                        "insurance_cost": 0,
                        "is_allow_checking_good": true,
                        "is_allow_try_out": false,
                        "is_confirm_returned": false,
                        "is_exchange": false,
                        "is_new_customer": false,
                        "is_receiver_pay": false,
                        "name": "same_day",
                        "name_vi": "Trong ngày",
                        "shipping_cost": 16000,
                        "shipping_cost_of_shop": 0
                    },
                    "inserted_at": "2020-08-18T09:15:02",
                    "current_status_en": "delivered",
                    "shop_id": null,
                    "to": {
                        "address": "Ngõ 11 duy tân sau toà nhà viettel ( cầu giấy) - sđt khác 0978795766",
                        "commune_id": null,
                        "district_id": "10113",
                        "full_address": "Ngõ 11 duy tân sau toà nhà viettel ( cầu giấy) - sđt khác 0978795766 - Quận Cầu Giấy, Hà Nội",
                        "id": null,
                        "name": "Đào Mai",
                        "phone_number": "0936361700",
                        "province_id": "101",
                        "real_address": null,
                        "return_address": null
                    },
                    "print_data": {
                        "district_type": "NT",
                        "receiver_province": "HN",
                        "sender_province": "HN"
                    },
                    "returned_editor": null,
                    "package_info": {
                        "items": [
                            {
                                "name": "Hộ vớ đi chân",
                                "quantity": 1,
                                "retail_price": 0,
                                "selected": false,
                                "weight": 100
                            }
                        ],
                        "snippet": "1 x 100g Hộ vớ đi chân",
                        "total_weight": 100,
                        "value": 0
                    }
                }
            ]
        }
    }
    

    This endpoint retrieves all trackings into your business.

    HTTP Request

    GET /snappy/trackings

    Query Parameters

    Parameter Required Type Default Description
    access_token true string Your personal acess_token
    business_id true integer Id one business in list businesses you get in api GET /user/me
    page false integer 1 Page number
    start_date false integer Start date timestamp
    end_date false integer End date timestamp
    sort_by false string inserted_at If sort_by= "updated_at" trackings will sort by updated_at instead of default sort by inserted_at
    filter_by_status false string One or more status of trackings separate by ,
    filter_inner_outer false integer 1 is inner, 2 is outer in same province and 3 is outer
    creator_id false string id of creator UUID
    keyword false string keyword for search by address, phone number, tracking id, ...

    Create tracking

    POST /snappy/trackings/create?access_token=<access_token> HTTP/1.1
    Content-Type: application/json
    

    Sample params

    {
        "access_token": "eyJ1aWQiOiIxNGQ0YTFhMS1lYTQyLTQxNjQtODA1ZC1lMjQwZjI1NjFmNzEiLCJpYXQiOj",
        "business_id": 37,
        "business_address_id": "82019ce2-088d-4cb1-8e8a-c6255d12ce6c",
        "receiver_name": "test",
        "receiver_phone_number": "0955555555",
        "receiver_address": "12 test",
        "receiver_province_id": "701",
        "receiver_district_id": "70101",
        "receiver_commune_id": "7010101",
        "items": [
            {
                "name": "sp 1",
                "weight": 100,
                "quantity": 1
            },
            {
                "name": "sp 2",
                "weight": 200,
                "quantity": 2
            }
        ],
        "cod": 500000,
        "value" : 600000
    }
    

    Response if success

    {
        "message": "Vận đơn đã được khởi tạo thành công",
        "success": true,
        "tracking": {
            "business_address_id": "ca4fb6d3-51aa-4d85-a2fb-f22018809f6a",
            "department": {
                "address": "35 Lê Văn Thiêm, Phường Nhân Chính",
                "commune_id": "1011101",
                "district_id": "10111",
                "district_name": "Quận Thanh Xuân",
                "full_address": "35 Lê Văn Thiêm, Phường Nhân Chính Quận Thanh Xuân Hà Nội",
                "id": -1,
                "name": "Snappy HN",
                "phone_number": "1900636505",
                "phone_number_care_ghtk": "0918392442",
                "province_id": "101",
                "province_name": "Hà Nội",
                "second_phone_number": "",
            },
            "creator_id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
            "status_color": "#AD7E05",
            "picked_up_at": null,
            "returned_at": null,
            "customer_tracking_id": null,
            "print_department": null,
            "tags": [],
            "last_update": {
                "editor": {
                    "avatar_url": null,
                    "email": "sonhgc00016@gmail.com",
                    "fb_id": "1361243100592751",
                    "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                    "name": "Hoàng Sơn",
                    "permission": 15,
                    "phone_number": "+84968999999",
                    "signatures": null
                },
                "last_editor": {
                    "avatar_url": null,
                    "email": "sonhgc00016@gmail.com",
                    "fb_id": "1361243100592751",
                    "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                    "name": "Hoàng Sơn",
                    "permission": 15,
                    "phone_number": "+84968999999",
                    "signatures": null
                },
                "last_updated_at": "2020-08-19T15:05:40",
                "location": "test - sô 58 tố hữu - Phường Trung Văn, Quận Nam Từ Liêm, Hà Nội",
                "note": "Khởi tạo vận đơn",
                "status": "Đơn mới",
                "status_color": "#AD7E05",
                "updated_at": "2020-08-19T15:05:40"
            },
            "addition_services": [],
            "receiver_commune_id": null,
            "from": {
                "address": "sô 58 tố hữu",
                "commune_id": "1012123",
                "district_id": "10121",
                "full_address": "test - sô 58 tố hữu - Phường Trung Văn, Quận Nam Từ Liêm, Hà Nội",
                "id": "ca4fb6d3-51aa-4d85-a2fb-f22018809f6a",
                "name": "test",
                "phone_number": "+84987654321",
                "province_id": "101",
                "real_address": null,
                "return_address": null
            },
            "current_status": "Đơn mới",
            "business": {
                "hotlines": "0999999999, 0888888888",
                "id": 37,
                "name": "Hemlock",
                "owner": {
                    "avatar_url": null,
                    "email": "sonhgc00016@gmail.com",
                    "fb_id": "1361243100592751",
                    "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                    "name": "Hoàng Sơn",
                    "permission": 15,
                    "phone_number": "+84968999999",
                    "signatures": null
                },
                "phone_number": "+84916880806"
            },
            "id": "S29994515",
            "receiver_province_id": "101",
            "creator": {
                "avatar_url": null,
                "email": "sonhgc00016@gmail.com",
                "fb_id": "1361243100592751",
                "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                "name": "Hoàng Sơn",
                "permission": 15,
                "phone_number": "+84968999999",
                "signatures": null
            },
            "log": null,
            "balance_adjustment": 0,
            "short_id": 999451,
            "sny_warehouse_id": null,
            "business_id": 37,
            "delivered_at": null,
            "print_district": null,
            "updated_at": "2020-08-19T15:05:40",
            "tracking_undeliverable": null,
            "updates": [
                {
                    "editor": {
                        "avatar_url": null,
                        "email": "sonhgc00016@gmail.com",
                        "fb_id": "1361243100592751",
                        "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                        "name": "Hoàng Sơn",
                        "permission": 15,
                        "phone_number": "+84968999999",
                        "signatures": null
                    },
                    "last_editor": {
                        "avatar_url": null,
                        "email": "sonhgc00016@gmail.com",
                        "fb_id": "1361243100592751",
                        "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                        "name": "Hoàng Sơn",
                        "permission": 15,
                        "phone_number": "+84968999999",
                        "signatures": null
                    },
                    "last_updated_at": "2020-08-19T15:05:40",
                    "location": "test - sô 58 tố hữu - Phường Trung Văn, Quận Nam Từ Liêm, Hà Nội",
                    "note": "Khởi tạo vận đơn",
                    "status": "Đơn mới",
                    "status_color": "#AD7E05",
                    "updated_at": "2020-08-19T15:05:40"
                }
            ],
            "receiver_district_id": "10101",
            "services": {
                "cod_service": {
                    "amount": 200000,
                    "cost": 0,
                    "is_save_log_cod": false,
                    "use_cod": true
                },
                "discount": {
                    "department": "HN",
                    "discount_percentage": 20
                },
                "insurance_cost": 0,
                "is_allow_checking_good": false,
                "is_allow_try_out": false,
                "is_confirm_returned": false,
                "is_exchange": false,
                "is_receiver_pay": false,
                "is_save_log_insurance_cost": false,
                "is_save_log_return": false,
                "is_save_log_shipping_cost": false,
                "is_save_log_shipping_cost_of_shop": false,
                "name": "same_day",
                "name_vi": "Trong ngày",
                "shipping_cost": 16000,
                "shipping_cost_of_shop": 0
            },
            "inserted_at": "2020-08-19T15:05:40",
            "current_status_en": "request_received",
            "shop_id": null,
            "to": {
                "address": "addess test",
                "commune_id": null,
                "district_id": "10101",
                "full_address": "addess test - Quận Ba Đình, Hà Nội",
                "id": null,
                "name": "test",
                "phone_number": "0999999999",
                "province_id": "101",
                "real_address": null,
                "return_address": null
            },
            "print_data": {
                "district_type": "NT",
                "receiver_province": "HN",
                "sender_province": "HN"
            },
            "returned_editor": null,
            "partner_info": {},
            "package_info": {
                "items": [
                    {
                        "name": "test",
                        "quantity": 1,
                        "retail_price": 0,
                        "selected": false,
                        "weight": 20
                    }
                ],
                "snippet": "1 x 20g test",
                "total_weight": 20,
                "value": 200000
            }
        }
    }
    

    This endpoint create a tracking into your business.

    HTTP Request

    POST /snappy/trackings/create

    Query Parameters

    Parameter Required Type Default Description
    access_token true string Your personal acess_token
    business_id true integer Id of a business in list businesses. Get in api GET /user/me
    business_address_id true string Id UUID of one of business address. Get in api GET /businesses/
    pickup_note false string Pickup note of shop
    delivery_note false string Delivery note of shop
    receiver_name true string Name of receiver
    receiver_phone_number true string Phone number of receiver
    receiver_address true string Address of receiver
    receiver_province_id true string Id of receiver's province. Get in api GET /geo/provinces
    receiver_district_id true string Id of receiver's district. Get in api GET /geo/districts
    receiver_commune_id false string Id of receiver's commune. Get in api GET /geo/communes
    items true array List of items in tracking package
    service_name false string Name of service one of express or standard. Get in api GET /snappy/trackings/cal_shipping_cost
    cod false integer Amount of cod or values of all items in package
    value false integer Insurance premium value, which is the basis for calculating insurance premiums and compensation when an incident occurs
    note false string Khởi tạo vận đơn Note of each status in tracking
    customer_tracking_id false string The custom id of customer
    is_receiver_pay false boolean false If true all cost of the tracking will be paid by the receiver
    is_allow_checking_good false boolean false If true means to allow the receiver to see the product
    is_allow_try_out false boolean false If true means to allow the receiver to try the product
    shop_note false string false Private note of shop

    Params items

    Parameter Required Type Default Description
    name true string Name of item or product
    weight true integer Weight of item or product
    quantity true integer Quantity of item or product

    Calculate shipping cost

    POST /snappy/trackings/cal_shipping_cost HTTP/1.1
    Content-Type: application/json
    

    Sample params

    {
        "business_id": 37,
        "sender_district_id": "10101",
        "receiver_district_id": "70129",
        "receiver_commune_id": "7012901",
        "cod": 1000000,
        "value": 1000000,
        "total_weight": 100,
        "is_receiver_pay": false
    }
    

    Response if success

    {
        "cod": 0,
        "cod_cost": 0,
        "discount": null,
        "error": null,
        "insurance_cost": 0,
        "is_receiver_pay": false,
        "message": null,
        "receiver_district_id": "70129",
        "services": {
            "express": {
                "cost": 30000,
                "delivery_time": "1 - 2 ngày",
                "each_500": 10000,
                "weight_threshold": 500
            },
            "standard": {
                "cost": 25000,
                "delivery_time": "3 - 4 ngày",
                "each_500": 5000,
                "weight_threshold": 1000
            }
        },
        "shipping_cost": 30000,
        "success": true,
        "value": 0
    }
    

    This endpoint calculate all cost of a tracking.

    HTTP Request

    POST /snappy/trackings/cal_shipping_cost

    Query Parameters

    Parameter Required Type Default Description
    business_id true integer Id of a business in list businesses. Get in api GET /user/me
    sender_district_id true string Id of sender's district. Get in api GET /geo/districts
    receiver_district_id true string Id of receiver's district. Get in api GET /geo/districts
    receiver_commune_id false string Id of receiver's commune. Get in api GET /geo/communes
    cod false integer 0 Amount of cod
    value false integer 0 Value of all products using for calculate insurance fee
    total_weight false integer 0 Total weight of all products (gram)
    is_receiver_pay false boolean false If true all cost of the tracking will be paid by the receiver

    Cancel tracking

    DELETE /snappy/trackings/cancel?access_token=<access_token> HTTP/1.1
    Content-Type: application/json
    

    Sample params

    {
        "access_token": "eyJ1aWQiOiIxNGQ0YTFhMS1lYTQyLTQxNjQtODA1ZC1lMjQwZjI1NjFmNzEiLCJpYXQiOj",
        "tracking_id": "S29994515",
        "note": "Lý do hủy vận đơn"
    }
    

    Response if success

    {
        "message": "Cập nhật trạng thái vận đơn thành công",
        "success": true,
        "tracking": {
            "package_info": {
                "items": [
                    {
                        "name": "test",
                        "quantity": 1,
                        "retail_price": 0,
                        "selected": false,
                        "weight": 20
                    }
                ],
                "snippet": "1 x 20g test",
                "total_weight": 20,
                "value": 200000
            },
            "shop_id": null,
            "customer_tracking_id": null,
            "services": {
                "cod_service": {
                    "amount": 200000,
                    "cost": 0,
                    "is_save_log_cod": false,
                    "use_cod": true
                },
                "discount": {
                    "department": "HN",
                    "discount_percentage": 20
                },
                "insurance_cost": 0,
                "is_allow_checking_good": false,
                "is_allow_try_out": false,
                "is_confirm_returned": false,
                "is_exchange": false,
                "is_new_customer": false,
                "is_receiver_pay": false,
                "is_save_log_return": false,
                "name": "same_day",
                "name_vi": "Trong ngày",
                "shipping_cost": 16000,
                "shipping_cost_of_shop": 0
            },
            "department": {
                "address": "35 Lê Văn Thiêm, Phường Nhân Chính",
                "commune_id": "1011101",
                "district_id": "10111",
                "district_name": "Quận Thanh Xuân",
                "full_address": "35 Lê Văn Thiêm, Phường Nhân Chính Quận Thanh Xuân Hà Nội",
                "id": -1,
                "name": "Snappy HN",
                "phone_number": "1900636505",
                "phone_number_care_ghtk": "0918392442",
                "pickup_shippo_id": 10010376,
                "province_id": "101",
                "province_name": "Hà Nội",
                "second_phone_number": ""
            },
            "to": {
                "address": "addess test",
                "commune_id": null,
                "district_id": "10101",
                "full_address": "addess test - Quận Ba Đình, Hà Nội",
                "id": null,
                "name": "test",
                "phone_number": "0999999999",
                "province_id": "101",
                "real_address": null,
                "return_address": null
            },
            "creator": {
                "avatar_url": null,
                "email": "sonhgc00016@gmail.com",
                "fb_id": "1361243100592751",
                "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                "name": "Hoàng Sơn",
                "permission": 15,
                "phone_number": "+84968999999",
                "signatures": null
            },
            "addition_services": [],
            "tags": [],
            "updates": [
                {
                    "editor": {
                        "avatar_url": null,
                        "email": "sonhgc00016@gmail.com",
                        "fb_id": "1361243100592751",
                        "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                        "name": "Hoàng Sơn",
                        "permission": 15,
                        "phone_number": "+84968999999",
                        "signatures": null
                    },
                    "last_editor": {
                        "avatar_url": null,
                        "email": "sonhgc00016@gmail.com",
                        "fb_id": "1361243100592751",
                        "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                        "name": "Hoàng Sơn",
                        "permission": 15,
                        "phone_number": "+84968999999",
                        "signatures": null
                    },
                    "last_updated_at": "2020-08-19T15:18:45",
                    "location": null,
                    "note": "Đã hủy",
                    "sny_warehouse": null,
                    "status": "Đã hủy",
                    "status_color": "#DB3E36",
                    "updated_at": "2020-08-19T15:18:45"
                },
                {
                    "editor": {
                        "avatar_url": null,
                        "email": "sonhgc00016@gmail.com",
                        "fb_id": "1361243100592751",
                        "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                        "name": "Hoàng Sơn",
                        "permission": 15,
                        "phone_number": "+84968999999",
                        "signatures": null
                    },
                    "last_editor": {
                        "avatar_url": null,
                        "email": "sonhgc00016@gmail.com",
                        "fb_id": "1361243100592751",
                        "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                        "name": "Hoàng Sơn",
                        "permission": 15,
                        "phone_number": "+84968999999",
                        "signatures": null
                    },
                    "last_updated_at": "2020-08-19T15:05:40",
                    "location": "test - sô 58 tố hữu - Phường Trung Văn, Quận Nam Từ Liêm, Hà Nội",
                    "note": "Khởi tạo vận đơn",
                    "status": "Đơn mới",
                    "status_color": "#AD7E05",
                    "updated_at": "2020-08-19T15:05:40"
                }
            ],
            "id": "S29994515",
            "picked_up_at": null,
            "business_address_id": "ca4fb6d3-51aa-4d85-a2fb-f22018809f6a",
            "updated_at": "2020-08-19T15:18:45",
            "log": null,
            "short_id": 999451,
            "creator_id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
            "returned_editor": null,
            "balance_adjustment": 0,
            "current_status": "Đã hủy",
            "receiver_province_id": "101",
            "last_update": {
                "editor": {
                    "avatar_url": null,
                    "email": "sonhgc00016@gmail.com",
                    "fb_id": "1361243100592751",
                    "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                    "name": "Hoàng Sơn",
                    "permission": 15,
                    "phone_number": "+84968999999",
                    "signatures": null
                },
                "last_editor": {
                    "avatar_url": null,
                    "email": "sonhgc00016@gmail.com",
                    "fb_id": "1361243100592751",
                    "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                    "name": "Hoàng Sơn",
                    "permission": 15,
                    "phone_number": "+84968999999",
                    "signatures": null
                },
                "last_updated_at": "2020-08-19T15:18:45",
                "location": null,
                "note": "Lý do hủy vận đơn",
                "sny_warehouse": null,
                "status": "Đã hủy",
                "status_color": "#DB3E36",
                "updated_at": "2020-08-19T15:18:45"
            },
            "business_id": 37,
            "receiver_district_id": "10101",
            "returned_at": null,
            "status_color": "#DB3E36",
            "partner_info": {
                "ems": {
                    "cod_cost": 0,
                    "insurance_cost": 0,
                    "shipping_cost": 17500
                },
                "ghtk": {
                    "cod_cost": 0,
                    "insurance_cost": 0,
                    "shipping_cost": 16000,
                    "transport": "fly"
                },
                "njv": {
                    "cod_cost": 0,
                    "insurance_cost": 0,
                    "shipping_cost": 25000
                }
            },
            "inserted_at": "2020-08-19T15:05:40",
            "tracking_undeliverable": null,
            "current_status_en": "canceled",
            "delivered_at": null,
            "business": {
                "hotlines": "0999999999, 0888888888",
                "id": 37,
                "name": "Hemlock",
                "owner": {
                    "avatar_url": null,
                    "email": "sonhgc00016@gmail.com",
                    "fb_id": "1361243100592751",
                    "id": "ba1762fb-c3f5-4faa-9eea-e03b9ed9eb31",
                    "name": "Hoàng Sơn",
                    "permission": 15,
                    "phone_number": "+84968999999",
                    "signatures": null
                },
                "phone_number": "+84916880806"
            },
            "sny_warehouse_id": null,
            "print_data": {
                "district_type": "NT",
                "receiver_province": "HN",
                "sender_province": "HN"
            },
            "from": {
                "address": "sô 58 tố hữu",
                "commune_id": "1012123",
                "district_id": "10121",
                "full_address": "test - sô 58 tố hữu - Phường Trung Văn, Quận Nam Từ Liêm, Hà Nội",
                "id": "ca4fb6d3-51aa-4d85-a2fb-f22018809f6a",
                "name": "test",
                "phone_number": "+84987654321",
                "province_id": "101",
                "real_address": null,
                "return_address": null
            },
            "receiver_commune_id": null
        }
    }
    

    This endpoint cancel a tracking into your business.

    HTTP Request

    DELETE /snappy/trackings/cancel

    Query Parameters

    Parameter Required Type Default Description
    access_token true string Your personal acess_token
    tracking_id true string Unique id of tracking
    note true string Hủy vận đơn Note of status canceled

    Tracking Status

    Name Vn Name Color code Description
    request_received Đơn mới #AD7E05 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings
    processing_picked_up Đang lấy hàng #039BE5 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings
    picked_up_fail Chưa lấy được hàng #C62828 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings
    picked_up Đã lấy #277790 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings
    processing_on_the_way Đang trung chuyển #9C27B0 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings
    on_the_way Đang trong kho #129797 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings
    out_for_delivery Đang giao #0063B8 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings
    part_delivery Giao một phần #4CAF50 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings
    delivered Giao thành công #639026 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings
    undeliverable Giao không thành #DB3E36 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings
    waiting_for_return Chờ hoàn #FF4081 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings
    returning Đang hoàn #51ACC7 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings
    returned Đã hoàn #FF4500 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings
    canceled Đã hủy #DB3E36 Vn Name is current_status and Name is current_status_en of api GET /snappy/trackings

    Tracking Print

    This is special part. With this api you must be redirect or open new tab in your browser and apply this link https://snappy.vn/print/<ids>&business_id=<business_id>&access_token=<access_token>

    Parameter Required Type Description
    ids true string ids of trackings need to print separate by comma , eg. S20010048,S20009784,S20010275
    business_id true integer
    access_token true string

    Webhook

    Sample params send to callback url

    {
        "addition_services": [],
        "balance_adjustment": 0,
        "business": {
            "id": 63,
            "name": "SG1",
            "owner": {
                "fb_id": null,
                "name": "SG1"
            },
            "phone_number": "+84937123123"
        },
        "business_id": 63,
        "creator": {
            "fb_id": null,
            "name": "SG1"
        },
        "creator_id": "14d4a1a1-ea42-4164-805d-e240f2561f71",
        "current_status": "Đã khởi tạo",
        "current_status_en": "request_received",
        "custom_id": "S61180418001",
        "customer_tracking_id": null,
        "department": {
            "address": "127/19 Hoàng Hoa Thám, Phường 13, Tân Bình",
            "district_name": "Quận Tân Bình",
            "phone_number": "0886.332.882",
            "province_name": "Hồ Chí Minh",
            "second_phone_number": "0886.334.884"
        },
        "from": {
            "address": "Số 1 ABC",
            "commune_id": null,
            "district_id": "10101",
            "full_address": "SG1 - Số 1 ABC, Quận Ba Đình, Hà Nội",
            "id": "82019ce2-088d-4cb1-8e8a-c6255d12ce6c",
            "name": "SG1",
            "phone_number": "+84937123123",
            "province_id": "101"
        },
        "id": "E80008142",
        "inserted_at": "2018-04-18T15:42:56",
        "last_update": {
            "location": "SG1 - Số 1 ABC, Quận Ba Đình, Hà Nội",
            "note": "Khởi tạo vận đơn",
            "status": "Đã khởi tạo",
            "status_color": "#AD7E05",
            "updated_at": "2018-04-18T15:42:56"
        },
        "logs": [],
        "package_info": {
            "items": [
                {
                    "name": "sp 1",
                    "quantity": 2,
                    "weight": 100
                }
            ],
            "snippet": "2 x 100g sp 1",
            "total_weight": 200
        },
        "services": {
            "cod_service": {
                "amount": 500000,
                "cost": 0,
                "is_save_log_cod": false,
                "use_cod": true
            },
            "insurance_cost": 0,
            "is_allow_checking_good": false,
            "is_allow_try_out": false,
            "is_receiver_pay": false,
            "is_save_log_insurance_cost": false,
            "is_save_log_return": false,
            "is_save_log_shipping_cost": false,
            "is_save_log_shipping_cost_of_shop": false,
            "name": "expedited",
            "name_vi": "Chuyển phát nhanh",
            "shipping_cost": 30000,
            "shipping_cost_of_shop": 0
        },
        "short_id": 814,
        "status_color": "#AD7E05",
        "to": {
            "address": "12 test",
            "commune_id": "7010101",
            "district_id": "70101",
            "full_address": "Phường Tân Định, Quận 1, Hồ Chí Minh",
            "id": null,
            "name": "test",
            "phone_number": "095555555",
            "province_id": "701"
        },
        "updated_at": "2018-04-18T15:42:56",
        "updates": [
            {
                "location": "SG1 - Số 1 ABC, Quận Ba Đình, Hà Nội",
                "note": "Khởi tạo vận đơn",
                "status": "Đã khởi tạo",
                "status_color": "#AD7E05",
                "updated_at": "2018-04-18T15:42:56"
            }
        ]
    }
    

    When tracking update status to another status, Snappy will send a POST request following the callback url created in api POST /snappy/trackings/webhook. Max retry of the request with each tracking status to callback url is 10 times. List tracking status Tracking Status. The body of POST request sent to callback url similar to tracking field response from api POST /snappy/trackings/create

    Create Webhook

    POST /snappy/businesses/<business_id>/webhook?access_token=<access_token> HTTP/1.1
    

    Sample params

    {
        "access_token": "eyJ1aWQiOiIxNGQ0YTFhMS1lYTQyLTQxNjQtODA1ZC1lMjQwZjI1NjFmNzEiLCJpYXQiOj",
        "callback_url": "https://postman-echo.com/post"
    }
    

    Response if success

    {
        "success": true,
        "webhook": {
            "business_id": 1,
            "callback_url": "https://postman-echo.com/post"
        }
    }
    

    This endpoint create an unique webhook callback url into your business.

    HTTP Request

    POST /snappy/businesses/<business_id>/webhook

    URL Parameters

    Parameter Required Type Default Description
    access_token true string Your personal acess_token
    business_id true integer Id of a business in list businesses. Get in api GET /user/me
    callback_url true string The endpoint Snappy will send POST request

    Get a Specific Webhook

    GET /snappy/businesses/<business_id>/webhook&access_token=<access_token> HTTP/1.1
    

    Response

    {
        "success": true,
        "webhook": {
            "business_id": 1,
            "callback_url": "https://postman-echo.com/post"
        }
    }
    

    This endpoint retrieves a specific webhook callback url into your specific business.

    HTTP Request

    GET /snappy/businesses/<business_id>/webhook

    URL Parameters

    Parameter Required Type Default Description
    access_token true string Your personal acess_token
    business_id true integer Id of a business in list businesses. Get in api GET /user/me

    Update Webhook

    PUT /snappy/businesses/<business_id>/webhook&access_token=<access_token> HTTP/1.1
    

    Response

    {
        "success": true,
        "webhook": {
            "business_id": 1,
            "callback_url": "https://postman-echo.com/post"
        }
    }
    

    This endpoint retrieves a specific webhook callback url into your specific business.

    HTTP Request

    PUT /snappy/businesses/<business_id>/webhook

    URL Parameters

    Parameter Required Type Default Description
    access_token true string Your personal acess_token
    business_id true integer Id of a business in list businesses. Get in api GET /user/me
    callback_url true string The endpoint Snappy will send POST request

    Request

    Request Category

    Category Translate Sample Changes Sample Updates
    request_delivering Yêu cầu giao hàng null null
    request_pickup Yêu cầu lấy hàng null null
    request_return Yêu cầu trả hàng null null
    update_cod Đổi COD vận đơn { cod: 100000 } { key: "Tiền COD", old: "0 ₫", new: "100000 ₫" }
    update_phone_number Đổi tên, số điện thoại hoặc thêm số điện thoại Người nhận { name: "hoàng sơn", phone_number: "0999999999" } { key: "Thông tin người nhận", old: "Phạm thị hậu 0888888888", new: "hoàng sơn 0999999999" }
    update_receiver_address Đổi địa chỉ giao hàng { address: "123 chinh kinh nhan chinh", receiver_district_id: "10111", receiver_commune_id: "1011101", full_address: "123 chinh kinh nhan chinh Phường Nhân Chính Quận Thanh Xuân Hà Nội" } { key: "Địa chỉ giao hàng", old: "Số 24 ngõ 1 ngách 1 Lý Tự Trọng Phường - Phường La Khê, Quận Hà Đông, Hà Nội", new: "123 chinh kinh nhan chinh Phường Nhân Chính Quận Thanh Xuân Hà Nội" }
    update_pickup_address Đổi thông tin điểm lấy { business_address_id: "9c538687-71b5-453e-8cd0-b2c9b380e4af" } { key: "Điểm lấy hàng", old: "58 Tố Hữu, Phường Kim Mã, Quận Ba Đình, Hà Nội", new: "kho hang moi moi - dia chi moi moii - Phường Đội Cấn, Quận Ba Đình, Hà Nội" }
    other Khác null null
    complain_attitude Thái độ của Nhân viên Snappy null null
    complain_lost Hàng thất lạc, giao thiếu, giao nhầm null null
    complain_break Hàng hỏng, vỡ null null
    complain_cod Thu sai tiền thu hộ null null
    complain_wrong_payment Đối soát thiếu tiền null null
    complain_delay_payment Chưa nhận được tiền chuyển khoản null null

    Request Tag

    Tag Translate
    1 GẤP
    2 Quan trọng

    Create Request

    POST /snappy/request?access_token=<access_token> HTTP/1.1
    

    Sample params

    {
        "access_token": "eyJ1aWQiOiIxNGQ0YTFhMS1lYTQyLTQxNjQtODA1ZC1lMjQwZjI1NjFmNzEiLCJpYXQiOj",
        "tracking_id": "S00037457"
        "category": "request_delivering",
        "reason": "Giao lại giúp mình vào ngày mai nhé",
        "changes": null,
        "updates": null,
        "delivery_date": "2020-10-20",
        "tag": 1
    }
    

    Response if success

    {
        "message": "Gửi yêu cầu hỗ trợ thành công",
        "request": {
            "business": {
                "hotlines": "0111111111, 0222222222",
                "id": 1,
                "name": "Snappy",
                "phone_number": "0999999999"
            },
            "business_id": 1,
            "category_vi": "Yêu cầu giao lại/ lấy/ trả hàng",
            "changes": null,
            "creator": {
                "avatar_url": null,
                "email": "sonhgc00016@gmail.com",
                "fb_id": "1361232487260479",
                "id": "200da0c1-da68-42ad-ad3e-455d84e4e864",
                "name": "Hoàng Sơn",
                "phone_number": "+84999999999"
            },
            "creator_id": "200da0c1-da68-42ad-ad3e-455d84e4e864",
            "delivery_date": "2020-10-20",
            "department": -1,
            "editor": null,
            "editor_id": null,
            "handle_time": null,
            "handler": null,
            "handler_id": null,
            "id": 103,
            "inserted_at": "2020-10-13T23:08:57",
            "is_shop_recently_updated": null,
            "last_message": {
                "creator": {
                    "avatar_url": null,
                    "email": "sonhgc00016@gmail.com",
                    "fb_id": "1361232487260479",
                    "id": "200da0c1-da68-42ad-ad3e-455d84e4e864",
                    "name": "Hoàng Sơn",
                    "phone_number": "+84999999999"
                },
                "creator_id": "200da0c1-da68-42ad-ad3e-455d84e4e864",
                "delivery_date": "2020-10-20",
                "id": "c31301c1-fadf-4a2e-80bc-262424e289fe",
                "inserted_at": "2020-10-13T23:08:57",
                "is_mod": null,
                "message": "Giao lại giúp mình vào ngày mai nhé",
                "request_id": 103
            },
            "last_shop_message": {
                "counter": 1,
                "creator": {
                    "avatar_url": null,
                    "email": "sonhgc00016@gmail.com",
                    "id": "200da0c1-da68-42ad-ad3e-455d84e4e864",
                    "name": "Hoàng Sơn",
                    "phone_number": "+84999999999"
                },
                "creator_id": "200da0c1-da68-42ad-ad3e-455d84e4e864",
                "delivery_date": "2020-10-20",
                "id": "c31301c1-fadf-4a2e-80bc-262424e289fe",
                "inserted_at": "2020-10-13T23:08:57",
                "is_mod": null,
                "message": "Giao lại giúp mình vào ngày mai nhé",
                "request_id": 103
            },
            "last_sny_message": null,
            "rate": null,
            "rate_note": null,
            "reason": "Giao lại giúp mình vào ngày mai nhé",
            "status": 1,
            "sub_category_vi": "Yêu cầu giao hàng",
            "tags": [
                0,
                1
            ],
            "tracking": {
                "from": {
                    "address": "58 Tố Hữu",
                    "commune_id": "1010111",
                    "district_id": "10101",
                    "full_address": "58 Tố Hữu, Phường Kim Mã, Quận Ba Đình, Hà Nội",
                    "id": "f1e378e9-47d3-494e-960d-cbcebd34d424",
                    "name": "One piece",
                    "phone_number": "0988123789",
                    "province_id": "101",
                    "real_address": null,
                    "return_address": null
                },
                "services": {
                    "cod": 0,
                    "cod_cost": 0,
                    "cod_service": {
                        "amount": 0,
                        "cost": 0,
                        "is_save_log_cod": false,
                        "use_cod": false
                    },
                    "delivery_note": "",
                    "discount": {
                        "department": "HN",
                        "shipping_cost_suburban_lt_5000": 22000
                    },
                    "error": null,
                    "insurance_cost": 0,
                    "is_allow_checking_good": true,
                    "is_allow_try_out": true,
                    "is_confirm_returned": false,
                    "is_exchange": false,
                    "is_new_customer": false,
                    "is_receiver_pay": false,
                    "is_save_log_insurance_cost": false,
                    "is_save_log_return": false,
                    "is_save_log_shipping_cost": false,
                    "is_save_log_shipping_cost_of_shop": false,
                    "name": "express",
                    "name_vi": "Chuyển phát nhanh",
                    "pickup_note": "",
                    "receiver_district_id": "10125",
                    "shipping_cost": 22000,
                    "shipping_cost_of_shop": 0,
                    "shop_note": "",
                    "value": 0
                },
                "to": {
                    "address": "Số 2 LK6A Làng Việt Kiều Châu Âu Đường Nguyễn Văn Lộc Phường",
                    "commune_id": "1012503",
                    "district_id": "10125",
                    "full_address": "Số 2 LK6A Làng Việt Kiều Châu Âu Đường Nguyễn Văn Lộc Phường - Phường Mộ Lao, Quận Hà Đông, Hà Nội",
                    "id": null,
                    "name": "Trần Mai Hằng",
                    "phone_number": "0999999999",
                    "province_id": "101",
                    "real_address": null,
                    "return_address": null
                }
            },
            "tracking_id": "S00037442",
            "unread_count": 0,
            "updated_at": "2020-10-13T23:08:57",
            "updates": null
        },
        "success": true
    }
    

    This endpoint create an unique webhook callback url into your business.

    HTTP Request

    POST /snappy/request

    URL Parameters

    Parameter Required Type Default Description
    access_token true string Your personal acess_token
    tracking_id true string tracking id of a tracking
    category true string Category of request. Get in Request Category
    reason true string Reason of request
    delivery_date false string delivery date of request category request_delivering
    tag false integer Tag of request. Get in Request Tag
    changes true map Changes of request must have for request category update_cod, update_phone_number, update_receiver_address and update_pickup_address. Get in Request Tag
    updates true map Updates of request must have for request category update_cod, update_phone_number, update_receiver_address and update_pickup_address. Get in Request Tag

    Get List Requests for Trackings

    GET /snappy/request&access_token=<access_token> HTTP/1.1
    

    Response

    {
        "success": true,
        "trackings": [
            {
                "id": "S00037457",
                "requests": [
                    {
                        "business": {
                            "hotlines": "0111111111, 0222222222",
                            "id": 1,
                            "name": "Snappy",
                            "phone_number": "0999999999"
                        },
                        "business_id": 1,
                        "category_vi": "Yêu cầu giao lại/ lấy/ trả hàng",
                        "changes": null,
                        "creator": {
                            "avatar_url": null,
                            "email": "sonhgc00016@gmail.com",
                            "fb_id": "1361232487260479",
                            "id": "200da0c1-da68-42ad-ad3e-455d84e4e864",
                            "name": "Hoàng Sơn",
                            "phone_number": "+84999999999",
                        },
                        "creator_id": "200da0c1-da68-42ad-ad3e-455d84e4e864",
                        "delivery_date": "2020-10-20",
                        "department": -1,
                        "editor": null,
                        "editor_id": null,
                        "handle_time": null,
                        "handler": null,
                        "handler_id": null,
                        "id": 101,
                        "inserted_at": "2020-10-13T22:57:59",
                        "last_message": {
                            "creator": {
                                "avatar_url": null,
                                "email": "sonhgc00016@gmail.com",
                                "fb_id": "1361232487260479",
                                "id": "200da0c1-da68-42ad-ad3e-455d84e4e864",
                                "name": "Hoàng Sơn",
                                "phone_number": "+84999999999"
                            },
                            "creator_id": "200da0c1-da68-42ad-ad3e-455d84e4e864",
                            "delivery_date": "2020-10-20",
                            "id": "92142d60-dff6-4544-a647-de1ca0a6eabd",
                            "inserted_at": "2020-10-13T22:57:59",
                            "is_mod": null,
                            "message": "1111",
                            "request_id": 101
                        },
                        "last_shop_message": {
                            "counter": 1,
                            "creator": {
                                "avatar_url": null,
                                "email": "sonhgc00016@gmail.com",
                                "fb_id": "1361232487260479",
                                "id": "200da0c1-da68-42ad-ad3e-455d84e4e864",
                                "name": "Hoàng Sơn",
                                "phone_number": "+84999999999"
                            },
                            "creator_id": "200da0c1-da68-42ad-ad3e-455d84e4e864",
                            "delivery_date": "2020-10-20",
                            "id": "92142d60-dff6-4544-a647-de1ca0a6eabd",
                            "inserted_at": "2020-10-13T22:57:59",
                            "is_mod": null,
                            "message": "1111",
                            "request_id": 101
                        },
                        "last_sny_message": null,
                        "rate": null,
                        "rate_note": null,
                        "reason": "1111",
                        "status": 1,
                        "sub_category_vi": "Yêu cầu giao hàng",
                        "tags": [
                            0
                        ],
                        "tracking": {
                            "from": {
                                "address": "58 Tố Hữu",
                                "commune_id": "1010111",
                                "district_id": "10101",
                                "full_address": "58 Tố Hữu, Phường Kim Mã, Quận Ba Đình, Hà Nội",
                                "id": "f1e378e9-47d3-494e-960d-cbcebd34d424",
                                "name": "One piece",
                                "phone_number": "0988123789",
                                "province_id": "101",
                                "real_address": null,
                                "return_address": null
                            },
                            "services": {
                                "cod": 0,
                                "cod_cost": 0,
                                "cod_service": {
                                    "amount": 0,
                                    "cost": 0,
                                    "is_save_log_cod": false,
                                    "use_cod": false
                                },
                                "delivery_note": "",
                                "discount": {
                                    "department": "HN",
                                    "shipping_cost_suburban_lt_5000": 22000
                                },
                                "error": null,
                                "insurance_cost": 0,
                                "is_allow_checking_good": true,
                                "is_allow_try_out": true,
                                "is_confirm_returned": false,
                                "is_exchange": false,
                                "is_new_customer": false,
                                "is_receiver_pay": false,
                                "is_save_log_insurance_cost": false,
                                "is_save_log_return": false,
                                "is_save_log_shipping_cost": false,
                                "is_save_log_shipping_cost_of_shop": false,
                                "name": "express",
                                "name_vi": "Chuyển phát nhanh",
                                "pickup_note": "",
                                "receiver_district_id": "10125",
                                "shipping_cost": 22000,
                                "shipping_cost_of_shop": 0,
                                "shop_note": "",
                                "value": 0
                            },
                            "to": {
                                "address": "Chung cư xuân mai complex dương nội (toà L) Phường",
                                "commune_id": "1012519",
                                "district_id": "10125",
                                "full_address": "Chung cư xuân mai complex dương nội (toà L) Phường - Phường Yên Nghĩa, Quận Hà Đông, Hà Nội",
                                "id": null,
                                "name": "Nguyễn thuỳ linh",
                                "phone_number": "0999999999",
                                "province_id": "101",
                                "real_address": null,
                                "return_address": null
                            }
                        },
                        "tracking_id": "S00037457",
                        "unread_count": 0,
                        "updated_at": "2020-10-13T22:57:59",
                        "updates": null
                    }
                ]
            },
        ]
    }
    

    This endpoint retrieves a specific webhook callback url into your specific business.

    HTTP Request

    GET /snappy/request

    URL Parameters

    Parameter Required Type Default Description
    access_token true string Your personal acess_token
    business_id true integer Id of a business in list businesses. Get in api GET /user/me
    tracking_ids true string List of tracking ids separate by comma. Sample: S00037457,S00037442,S0003743