{"id":15578344,"url":"https://github.com/developifynet/brightpearl-php","last_synced_at":"2025-04-24T01:20:26.983Z","repository":{"id":56966565,"uuid":"186958082","full_name":"developifynet/brightpearl-php","owner":"developifynet","description":"Brightpearl PHP API Wrapper","archived":false,"fork":false,"pushed_at":"2019-05-16T10:19:17.000Z","size":9,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-30T05:31:26.993Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/developifynet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-16T05:34:45.000Z","updated_at":"2024-05-30T12:44:45.000Z","dependencies_parsed_at":"2022-08-21T11:20:29.200Z","dependency_job_id":null,"html_url":"https://github.com/developifynet/brightpearl-php","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/developifynet%2Fbrightpearl-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/developifynet%2Fbrightpearl-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/developifynet%2Fbrightpearl-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/developifynet%2Fbrightpearl-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/developifynet","download_url":"https://codeload.github.com/developifynet/brightpearl-php/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250541465,"owners_count":21447521,"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":[],"created_at":"2024-10-02T19:09:18.654Z","updated_at":"2025-04-24T01:20:26.968Z","avatar_url":"https://github.com/developifynet.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Brightpearl PHP API WRAPPER\n\n\u003ca href=\"https://travis-ci.org/developifynet/brightpearl-php\"\u003e\u003cimg src=\"https://travis-ci.org/developifynet/brightpearl-php.svg\" alt=\"Build Status\"\u003e\u003c/a\u003e\n\u003ca href=\"https://packagist.org/packages/developifynet/brightpearl-php\"\u003e\u003cimg src=\"https://poser.pugx.org/developifynet/brightpearl-php/downloads.svg\" alt=\"Total Downloads\"\u003e\u003c/a\u003e\n\u003ca href=\"https://packagist.org/packages/developifynet/brightpearl-php\"\u003e\u003cimg src=\"https://poser.pugx.org/developifynet/brightpearl-php/v/stable.svg\" alt=\"Latest Stable Version\"\u003e\u003c/a\u003e\n\u003ca href=\"https://packagist.org/packages/developifynet/brightpearl-php\"\u003e\u003cimg src=\"https://poser.pugx.org/developifynet/brightpearl-php/license.svg\" alt=\"License\"\u003e\u003c/a\u003e\n\nThis package uses arrays for the same json requests as you would send to the Brightpearl API. Please refer to the [Brightpearl API docs](http://api-docs.brightpearl.com/) for extra/optional field info.\n\n## Installation\n\nBegin by pulling in the package through Composer.\n\n```bash\ncomposer require developifynet/brightpearl-php\n```\n\n## Usage\n\nPlease note that all requests in \n\n### Basic (any php app)\n\n```php\nuse \\Developifynet\\Brightpearl\\BrightpearlClient;\n\n$client = new BrightpearlClient([\n                'app_reference' =\u003e 'your-api-reference',\n                'account_code'  =\u003e 'your-account',\n                'account_token' =\u003e 'your-app-token',\n                'api_domain'    =\u003e 'ws-eu1.brightpearl.com', // [optional], Provide URL or remove this line\n            ]);\n            \n// or\n\n$client = new BrightpearlClient();\n$client-\u003esettings([\n    'app_reference' =\u003e 'your-api-reference',\n    'account_code'  =\u003e 'your-account',\n    'account_token' =\u003e 'your-app-token',\n    'api_domain'    =\u003e 'ws-eu1.brightpearl.com', // [optional], Provide URL or remove this line\n]);\n\n            \n/**\n * Example Call\n * For more api calls check 'resources' folder\n */\n$response = $client-\u003egetOrderStockStatus();\n```\n\n### Laravel\n\n```php\n$client = Brightpearl::settings([\n                'app_reference' =\u003e 'your-api-reference',\n                'account_code'  =\u003e 'your-account',\n                'account_token' =\u003e 'your-app-token',\n                'api_domain'    =\u003e 'ws-eu1.brightpearl.com', // [optional], Provide URL or remove this line\n            ]);\n/**\n * Example Calls\n * For more api calls check 'resources' folder\n */\n$response = Brightpearl::getOrderStockStatus();             // Optional $ids,  e.g. '1' or '1-3,4,5'\n$response = Brightpearl::getOrder();                        // Optional $ids,  e.g. '1' or '1-3,4,5'\n```\n\nServices\n--------\nThese are the api method calls generated by the service config files using GuzzleHttp/Guzzle-Services. For\n\n### Contact\n\n`getContact()` - Retrieve contact info\n\n```php\n// All Contacts\n$contact = $client-\u003egetContact();\n\n// Contact by idset\n$contact = $client-\u003egetContact(['id' =\u003e '1-3,4,5']);\n\n// get a specific contact by id\n$contact = $client-\u003egetContact(['id' =\u003e '1']);\n```\n\n### Order\n\n`getOrder()` - Retrieve order(s)\n\n```php\n// All Orders\n$order = $client-\u003egetOrder();\n\n// Order by id\n$order = $client-\u003egetOrder('1');\n\n// Orders by idset\n$orders = $client-\u003egetOrder('1-3,4,5');\n```\n\n### Other Available Services\n\n```php\n// Order Types\n$order_types = $client-\u003egetOrderType();             // Optional $ids,  e.g. '1' or '1-3,4,5'\n// Product Prices\n$product_prices = $client-\u003egetProductPrice();       // Optional $ids,  e.g. '1' or '1-3,4,5'\n// Price Lists\n$price_lists = $client-\u003egetPriceList();             // Optional $ids,  e.g. '1' or '1-3,4,5'\n// All Price Lists Urls\n$price_list_urls = $client-\u003eoptionsProductPrice();  // Optional $ids,  e.g. '1' or '1-3,4,5'\n// All Contacts Urls\n$contact_urls = $client-\u003eoptionsContact();          // Optional $ids,  e.g. '1' or '1-3,4,5'\n// All Orders Urls\n$order_urls = $client-\u003eoptionsOrder();              // Optional $ids,  e.g. '1' or '1-3,4,5'\n// All Orders Urls\n$order_urls = $client-\u003eoptionsOrder();              // Optional $ids,  e.g. '1' or '1-3,4,5'\n// Order Statuses\n$order_statuses = $client-\u003egetOrderStatus();\n// Warehouses\n$warehouses = $client-\u003egetWarehouse();\n// Channels\n$channels = $client-\u003egetChannel();\n// Order Stock Statuses\n$order_stock_statuses = $client-\u003egetOrderStockStatus();\n// Order Shipping Statuses\n$order_shipping_statuses = $client-\u003egetOrderShippingStatus();\n// Order Types\n$order_types = $client-\u003egetOrderType();\n```\n\n#### Contributing\n\nCurrently API coverage only represents fetching data portion of the Brightpearl API. If you want to contribute send bug fixes, additional resource/services and features in a pull request at the develop branch. Thanks!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevelopifynet%2Fbrightpearl-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevelopifynet%2Fbrightpearl-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevelopifynet%2Fbrightpearl-php/lists"}