{"id":24200214,"url":"https://github.com/codeboxrcodehub/pathao-courier","last_synced_at":"2025-04-09T21:15:38.336Z","repository":{"id":58136903,"uuid":"523704861","full_name":"codeboxrcodehub/pathao-courier","owner":"codeboxrcodehub","description":"Laravel package for Pathao Courier ","archived":false,"fork":false,"pushed_at":"2024-10-29T06:55:00.000Z","size":18,"stargazers_count":20,"open_issues_count":0,"forks_count":18,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T21:15:28.563Z","etag":null,"topics":["api","bd-courier","courier","courier-api","courier-service","courier-tracking","laravel-package","pathao-api","pathao-courier","pathao-courier-laravel","pathao-merchant"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codeboxrcodehub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-11T11:54:40.000Z","updated_at":"2025-02-10T11:47:36.000Z","dependencies_parsed_at":"2024-10-29T07:27:37.103Z","dependency_job_id":null,"html_url":"https://github.com/codeboxrcodehub/pathao-courier","commit_stats":{"total_commits":9,"total_committers":3,"mean_commits":3.0,"dds":0.4444444444444444,"last_synced_commit":"e737383a315137771fcdbc944cc3f8dece5d7666"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeboxrcodehub%2Fpathao-courier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeboxrcodehub%2Fpathao-courier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeboxrcodehub%2Fpathao-courier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeboxrcodehub%2Fpathao-courier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeboxrcodehub","download_url":"https://codeload.github.com/codeboxrcodehub/pathao-courier/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248111973,"owners_count":21049578,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","bd-courier","courier","courier-api","courier-service","courier-tracking","laravel-package","pathao-api","pathao-courier","pathao-courier-laravel","pathao-merchant"],"created_at":"2025-01-13T20:41:37.678Z","updated_at":"2025-04-09T21:15:38.307Z","avatar_url":"https://github.com/codeboxrcodehub.png","language":"PHP","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://pathao.com/wp-content/uploads/2019/02/Pathao-logo.svg\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003ePathao Courier Banagladesh\u003c/h1\u003e\n\u003cp align=\"center\" \u003e\n\u003cimg src=\"https://img.shields.io/packagist/dt/codeboxr/pathao-courier\"\u003e\n\u003cimg src=\"https://img.shields.io/packagist/stars/codeboxr/pathao-courier\"\u003e\n\u003c/p\u003e\n\nThis is a Laravel/PHP package for [Pathao](https://pathao.com) BD Courier System. This package can be used in laravel or without laravel/php projects. You can use this package for headless/rest implementation as well as blade or regular mode development. We created this package while working for a project and thought to made it release for all so that it helps. This package is available as regular php [composer package](https://packagist.org/packages/codeboxr/pathao-courier).\n\n## Features\n\n1. [Fetch Pathao delivery/store city list](https://github.com/codeboxrcodehub/pathao-courier#1-get-pathao-delivery-city-list)\n2. [Fetch Pathao delivery/store zone list](https://github.com/codeboxrcodehub/pathao-courier#2-to-get-pathao-zone-list)\n3. [Fetch Pathao delivery/store area list](https://github.com/codeboxrcodehub/pathao-courier#3-to-get-pathao-delivery-area-list)\n4. [Create pickup store](https://github.com/codeboxrcodehub/pathao-courier#4-create-new-store)\n5. [Fetch pickup store list](https://github.com/codeboxrcodehub/pathao-courier#5-get-store-list)\n6. [Create parcel](https://github.com/codeboxrcodehub/pathao-courier#6-create-new-parcel)\n7. [Fetch Parcel Details](https://github.com/codeboxrcodehub/pathao-courier#7-get-order-details)\n\n\n## Requirements\n\n- PHP \u003e=7.4\n- Laravel \u003e= 6\n\n## Installation\n\n```bash\ncomposer require codeboxr/pathao-courier\n```\n\n### vendor publish (config)\n```bash\nphp artisan vendor:publish --provider=\"Codeboxr\\PathaoCourier\\PathaoCourierServiceProvider\"\n```\n\nAfter publish config file setup your credential. you can see this in your config directory pathao.php file\n```\n\"sandbox\"       =\u003e env(\"PATHAO_SANDBOX\", false), // for sandbox mode use true\n\"client_id\"     =\u003e env(\"PATHAO_CLIENT_ID\", \"\"),\n\"client_secret\" =\u003e env(\"PATHAO_CLIENT_SECRET\", \"\"),\n\"username\"      =\u003e env(\"PATHAO_USERNAME\", \"\"),\n\"password\"      =\u003e env(\"PATHAO_PASSWORD\", \"\")\n```\n\n### Set .env configuration\n```\nPATHAO_SANDBOX=true // for production mode use false\nPATHAO_CLIENT_ID=\"\"\nPATHAO_CLIENT_SECRET=\"\"\nPATHAO_USERNAME=\"\"\nPATHAO_PASSWORD=\"\"\n```\n\n\n## Usage\n\n### 1. Get pathao delivery city list\n\n```\nuse Codeboxr\\PathaoCourier\\Facade\\PathaoCourier\n\nreturn PathaoCourier::area()-\u003ecity();\n\n```\n\n### 2. To get pathao zone list\n\n```\nuse Codeboxr\\PathaoCourier\\Facade\\PathaoCourier\n\nreturn PathaoCourier::area()-\u003ezone($cityId); // City ID\n```\n\n### 3. To get pathao delivery area list\n\n```\nuse Codeboxr\\PathaoCourier\\Facade\\PathaoCourier\n\nreturn PathaoCourier::area()-\u003earea($zoneId); // Zone ID\n```\n\n\n### 4. Create new store\n\n```\nuse Codeboxr\\PathaoCourier\\Facade\\PathaoCourier\n\nreturn PathaoCourier::store()\n                        -\u003ecreate([\n                            \"name\"              =\u003e \"\", // Store Name\n                            \"contact_name\"      =\u003e \"\", // Store contact person name\n                            \"contact_number\"    =\u003e \"\", // Contact person number\n                            \"address\"           =\u003e \"\", // Store address\n                            \"secondary_contact\" =\u003e \"\", // Contact person secondary number not mandatory\n                            \"city_id\"           =\u003e \"\", // Find in city method\n                            \"zone_id\"           =\u003e \"\", // Find in zone method\n                            \"area_id\"           =\u003e \"\", // Find in Area method\n                        ]);\n```\n\n### 5. Get Store List\n\n```\nuse Codeboxr\\PathaoCourier\\Facade\\PathaoCourier\n\nreturn PathaoCourier::store()-\u003elist();\n```\n\n### 6. Create new parcel\n\n```\nuse Codeboxr\\PathaoCourier\\Facade\\PathaoCourier\n\nreturn PathaoCourier::order()\n                        -\u003ecreate([\n                            \"store_id\"            =\u003e \"\", // Find in store list,\n                            \"merchant_order_id\"   =\u003e \"\", // Unique order id\n                            \"recipient_name\"      =\u003e \"\", // Customer name\n                            \"recipient_phone\"     =\u003e \"\", // Customer phone\n                            \"recipient_address\"   =\u003e \"\", // Customer address\n                            \"recipient_city\"      =\u003e \"\", // Find in city method\n                            \"recipient_zone\"      =\u003e \"\", // Find in zone method\n                            \"recipient_area\"      =\u003e \"\", // Find in Area method\n                            \"delivery_type\"       =\u003e \"\", // 48 for normal delivery or 12 for on demand delivery\n                            \"item_type\"           =\u003e \"\", // 1 for document,\n2 for parcel\n                            \"special_instruction\" =\u003e \"\",\n                            \"item_quantity\"       =\u003e \"\", // item quantity\n                            \"item_weight\"         =\u003e \"\", // parcel weight\n                            \"amount_to_collect\"   =\u003e \"\", // amount to collect\n                            \"item_description\"    =\u003e \"\" // product details\n                        ]);\n```\n\n### 7. Get Order Details\n\n```\nuse Codeboxr\\PathaoCourier\\Facade\\PathaoCourier\n\nreturn PathaoCourier::order()-\u003eorderDetails($consignmentId); // After successfully create order they given a consignment_id\n```\n\n\n\n\n## Contributing\n\nContributions to the Pathao package are welcome. Please note the following guidelines before submitting your pull request.\n\n- Follow [PSR-4](http://www.php-fig.org/psr/psr-4/) coding standards.\n- Read Pathao API documentations first\n\n## License\n\nPathao package is licensed under the [MIT License](http://opensource.org/licenses/MIT).\n\nCopyright 2022 [Codeboxr](https://codeboxr.com)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeboxrcodehub%2Fpathao-courier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeboxrcodehub%2Fpathao-courier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeboxrcodehub%2Fpathao-courier/lists"}