Boxy API
  1. Regions
Boxy API
  • Getting Started
    • Introduction
    • Environments
    • Security & Authentication
    • Rate Limit
    • Postman Collections
    • Schemas
    • Webhooks
  • Guides
    • Order Flow (Statuses)
    • Provinces & Regions
  • API Reference
    • Merchant
      • Get Merchant Info
    • Orders
      • Create Order
      • Create Bulk Orders (Sync)
      • Create Bulk Orders (Async)
      • List Orders
      • Show Order By UID
      • Show Order By Custom ID
      • Get Label Single
      • Get Label Bulk
      • Cancel Order
      • Update Order
      • Delete Order
    • Pick-ups
      • Request Pick-up
      • Request Pick-up Bulk
      • List Pick-ups
      • Show Pick-up
      • Get Pick-up Labels
      • Cancel Pick-up
      • Cancel Bulk Pick-ups
    • Pick-up Locations
      • Create Pick-up Location
      • List Pick-up Locations
      • Show Pick-up Location
      • Show Cash Drop-off Location
      • Update Pick-up Location
      • Delete Pick-up Location
    • Regions
      • List Regions
        GET
  1. Regions

List Regions

Production
https://api.tryboxy.com/api/v1/
Production
https://api.tryboxy.com/api/v1/
GET
merchants/regions/provinces
List of regions

Request

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.tryboxy.com/api/v1/merchants/regions/provinces' \
--header 'api-key: ' \
--header 'api-secret: '

Responses

🟢200Success
application/json
Body

Example
{
    "status": "success",
    "code": 200,
    "message": "Successfully done.",
    "object": [
        {
            "uid": "01JBYGPFDV30MY8AZ603N7YVGK",
            "province_code": "BGD",
            "province_en_name": "baghdad",
            "province": "بغداد",
            "zaeem_area_id": 276,
            "area_name": "الشعب",
            "area_name_slug": "BGD1",
            "remote": 0,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFDWB5XAW0EPC3BR8ASR",
            "province_code": "KRB",
            "province_en_name": "karbala",
            "province": "كربلاء",
            "zaeem_area_id": 517,
            "area_name": "ناحية عون",
            "area_name_slug": "KRB303",
            "remote": 0,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFDYCK63P9PBEM9B7ADJ",
            "province_code": "BBL",
            "province_en_name": "babel",
            "province": "بابل الحلة",
            "zaeem_area_id": 525,
            "area_name": "الحلة",
            "area_name_slug": "BBL1244",
            "remote": 0,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFDYCK63P9PBEM9B7AJN",
            "province_code": "DWN",
            "province_en_name": "diwania",
            "province": "الديوانية",
            "zaeem_area_id": 628,
            "area_name": "الشامية",
            "area_name_slug": "DWN1407",
            "remote": 1,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFDZQZF0Y3D8B7A7DTN0",
            "province_code": "NJF",
            "province_en_name": "najaf",
            "province": "النجف",
            "zaeem_area_id": 1407,
            "area_name": "الحيدرية",
            "area_name_slug": "NJF1553",
            "remote": 0,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFE0QVQMJ94T5EHMSPMG",
            "province_code": "BAS",
            "province_en_name": "basra",
            "province": "البصرة",
            "zaeem_area_id": 661,
            "area_name": "شط العرب",
            "area_name_slug": "BAS2393",
            "remote": 1,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFE1A37N9XTQ8EVG185F",
            "province_code": "AMA",
            "province_en_name": "maysan",
            "province": "العمارة ميسان",
            "zaeem_area_id": 1467,
            "area_name": "العمارة",
            "area_name_slug": "AMA2633",
            "remote": 0,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFE1A37N9XTQ8EVG1893",
            "province_code": "SAH",
            "province_en_name": "saladin",
            "province": "صلاح الدين",
            "zaeem_area_id": 479,
            "area_name": "تكريت",
            "area_name_slug": "SAH2749",
            "remote": 0,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFE1A37N9XTQ8EVG18AK",
            "province_code": "ANB",
            "province_en_name": "anbar",
            "province": "الانبار رمادي",
            "zaeem_area_id": 798,
            "area_name": "ناحية الفرات",
            "area_name_slug": "ANB2797",
            "remote": 1,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFE1A37N9XTQ8EVG18CX",
            "province_code": "NAS",
            "province_en_name": "zeeqar",
            "province": "الناصرية ذي قار",
            "zaeem_area_id": 831,
            "area_name": "الرفاعي",
            "area_name_slug": "NAS2871",
            "remote": 1,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFE1A37N9XTQ8EVG18GA",
            "province_code": "KOT",
            "province_en_name": "koot",
            "province": "الكوت واسط",
            "zaeem_area_id": 873,
            "area_name": "النعمانية",
            "area_name_slug": "KOT2980",
            "remote": 0,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFE2VADJ0RFRV0B8AAA6",
            "province_code": "SAM",
            "province_en_name": "simawa",
            "province": "السماوة المثنى",
            "zaeem_area_id": 641,
            "area_name": "السماوة",
            "area_name_slug": "SAM3078",
            "remote": 0,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFE2VADJ0RFRV0B8AAC5",
            "province_code": "KRK",
            "province_en_name": "karkok",
            "province": "كركوك",
            "zaeem_area_id": 938,
            "area_name": "داقوق",
            "area_name_slug": "KRK3141",
            "remote": 1,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFE2VADJ0RFRV0B8AAHH",
            "province_code": "SMH",
            "province_en_name": "solaimania",
            "province": "السليمانيه",
            "zaeem_area_id": 975,
            "area_name": "بكره جو",
            "area_name_slug": "SMH3313",
            "remote": 1,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFE3PMPTV49F4YG2QTBT",
            "province_code": "ARB",
            "province_en_name": "arbeel",
            "province": "اربيل",
            "zaeem_area_id": 1035,
            "area_name": "كويه",
            "area_name_slug": "ARB3494",
            "remote": 1,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFE3PMPTV49F4YG2QTJ9",
            "province_code": "DOH",
            "province_en_name": "dihok",
            "province": "دهوك",
            "zaeem_area_id": 508,
            "area_name": "ناحية زاويتة",
            "area_name_slug": "DOH3701",
            "remote": 1,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFE3PMPTV49F4YG2QTNV",
            "province_code": "MOS",
            "province_en_name": "mosul",
            "province": "موصل",
            "zaeem_area_id": 1059,
            "area_name": "سومر",
            "area_name_slug": "MOS3815",
            "remote": 0,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        {
            "uid": "01JBYGPFE4EEFS4SKB1DYPYET7",
            "province_code": "DYL",
            "province_en_name": "diyala",
            "province": "ديالى",
            "zaeem_area_id": 1185,
            "area_name": "خانقين",
            "area_name_slug": "DYL4057",
            "remote": 0,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        }
    ]
}
Modified at 2025-02-05 15:57:27
Previous
Delete Pick-up Location
Built with