{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ee68a348-6265-4f6a-8266-d20a3286573c","name":"BJS Order Management","description":"<img src=\"https://bjshomedelivery.com/assets/img/logo.png\">\n\n**Our order management APIs provide flexible and speedy access to create and manage customer orders.**\n\n---\n\n## Changelog\n\n| Date | API | Notes |\n| --- | --- | --- |\n| 30/04/2020 | all | Initial publication to postman |\n| 15/07/2020 | [Create Order](#5caf1c13-1711-4401-83d6-f5fbbdcbfeaf), [Update Address](#305f31da-181e-4670-a883-79613916ae67) | Added what3words integration |\n| 11/09/2020 | Label Specs | Added additional details to label specs |\n| 20/01/2021 | [Create Order](#5caf1c13-1711-4401-83d6-f5fbbdcbfeaf), [Update Products](#f8e4c260-c8b8-458b-8faa-74793383ca6d) | Added support for return locations |\n| 10/02/2021 | v2 | Added v2 endpoints for return locations |\n| 24/02/2021 | [Create Order](#5caf1c13-1711-4401-83d6-f5fbbdcbfeaf) | Added notes for collections and exchange use cases |\n| 15/04/2021 | [Create Order](#5caf1c13-1711-4401-83d6-f5fbbdcbfeaf) | Added support for Consignor EORI and packaging type for customs declarations |\n| 02/10/2021 | [Create Order](#5caf1c13-1711-4401-83d6-f5fbbdcbfeaf) | Added support for order product 'Source', used to determine if order products are being injected into the network or picked from stock if 3PL model applies to the account |\n| 16/01/2023 | [Create Order](#5caf1c13-1711-4401-83d6-f5fbbdcbfeaf) | Added new Timed Service values |\n| 20/10/2023 | [Generate Product Labels](https://bjsdevs.postman.co/workspace/BJS-(Collections)~ddb46a20-4b02-4045-8231-db270c7526be/documentation/30091448-6b7244ee-6023-4644-9a65-f2133e8bb667?entity=request-231b1c89-d4b5-42b2-b686-691247f4bce9) | Added support for Clients as well as Suppliers to generate product labels independently using OrderNumber |\n| 08/09/2025 | [Create Order](#5caf1c13-1711-4401-83d6-f5fbbdcbfeaf) | Added support for creating Irish Postcode Orders. Clients can now create orders using both Northern/Southern Ireland postcodes. Additional required fields for Irish orders have also been included. |\n| 5/12/2025 | [Create Order](#5caf1c13-1711-4401-83d6-f5fbbdcbfeaf) | Northern/Southern Ireland postcodes. Moved the Order 4 custom fields to product custom fields CommodityCode,CountryOfOrigin,ItemInvoiceAmount,NIAdditionalInformationCodes |\n| 18/03/2026 | [Create Order](#5caf1c13-1711-4401-83d6-f5fbbdcbfeaf) | Collect Disposal add for order level. |\n| 18/05/2026 | [Create Order](#5caf1c13-1711-4401-83d6-f5fbbdcbfeaf) | Order creation now supports the addition of product-level add-on services, allowing each product line in an order to have its own associated services. |\n\n[legacy API docs](https://docs.google.com/document/d/1GpRxCMd-29X71e2Ql71Uq5cfeMAy2BJifCqma9vqf4k)\n\nLegacy EDI docs available on [request](https://mailto:integration@bjshomedelivery.com)\n\n---\n\n# Getting Started\n\n> Auth is handled through API keys. [Contact us](https://mailto:integration@bjshomedelivery.com) to obtain an API key.  \nYou must provide your IP addresses to be whitelisted for server access.  \nAll connections must be made over **TLS 1.2**  \nAccount based 'fair use' policies apply, although rate-limiting is not currently enforced \n  \n\n## Help, Questions & Suggestions\n\n[Contact us](https://mailto:integration@bjshomedelivery.com) if you have any queries or require further assistance or to provide feedback and suggestions.\n\n---\n\n# Making Your First Call\n\n- Add a new environment in Postman for BJS API Staging\n- Add new environment variables for `BaseURL`, `Key` and `AccountNumber`\n- Set value `https://api.development.bjshomedelivery.com/v1` for `BaseURL`\n- Set the provided values for `Key` and `AccountNumber` respectively\n    \n\n## Environments\n\n> You will be provided separate details for `BaseURL`, `Key` and `AccountNumber` for **production**.  \nData in the staging environment does not interact with or affect production.  \nComms are **not** executed in Staging. See [recipient communication documentation](https://docs.google.com/document/d/12G2NCz934FTMI_6ag8RID_qej4llcSUI4nmswQXG4v8) for details of comms executed on order state changes in production. \n  \n\n## Events\n\n> Order state changes produce `Events` throughout the service stack.  \nEvents can be consumed by partners to retain visibility of order updates or state changes. See [outbound events documentation](https://docs.google.com/document/d/1fjTp-eB4hKOVX_PeQgLfyBBs8TXB-v3sF9O0VV3Ck8Y) for details. \n  \n\n**Inbound Events**\n\n> BJS can also consume a number of updates from partners. See [inbound events documentation](https://docs.google.com/document/d/1YZIUYeEYB_ZWARV9qvvypxqSiSdZA-b9LHbTAqafM3E) for details. \n  \n\n## Labels\n\n> BJS recommends clients generate their own code 128 'product' barcodes and self-label products before dispatching to BJS. We recommend periodically syncing our [zone/list](https://developer.bjshomedelivery.com/#10364bf4-09b3-445f-9f0f-1fa94dde886d) API to look up 'Depot' prefix required for labels. If product 'barcode' values are not specified, a unique barcode will be returned in the create order API response for each product on the order. \n  \n> Additional details and Label specification available [here](https://docs.google.com/document/d/1qL7W2ekV30k6LVHVMHxS3S6oLa_0O4P6C-rItTDVKIw). \n  \n\n# Integration Models\n\n<p><img src=\"https://drive.google.com/uc?id=1COv175RYatuLcAyRc2Rb8Smn7CYedEdm&amp;export=download\" alt=\"Integration\"></p>\n\n# Cheatsheet\n\n| Use case(s) | API |\n| --- | --- |\n| Place new delivery, collection or exchange order with BJS | [Create Order](#5caf1c13-1711-4401-83d6-f5fbbdcbfeaf) |\n| Add or removes a product from an order  <br>Generate an updated number of labels for order  <br>Update any product attributes | [Update Products](#f8e4c260-c8b8-458b-8faa-74793383ca6d) |\n| Customer provided updated contact details | [Update Contact Details](#06a998d3-2f93-409c-a5f4-f87908c4ba14) |\n| Customer provided additional information for the delivery crew | [Update Delivery Instructions](#cb1be040-1206-45e9-934a-db602118b292) |\n| Customer updated the delivery address | [Update Address](#305f31da-181e-4670-a883-79613916ae67) |\n| Stock QC needs to be requested  <br>Add an audit note to the order for BJS customer service | [Add Flag](#ff10b4f9-ea2c-46a3-9775-23b0993edb07) |\n| Order no longer required | [Cancel Order](#f61e3470-03b7-423c-91be-12efcbf5ce48) |\n| Stock (Partially / fully) received for order fulfilment  <br>Products shipped to BJS | [Release Products](#896136d7-fec9-408f-bf67-c33fbf3a16d3) |\n\n# Existing Integrations\n\nBJS partners with a number of third party platforms, including order management, fulfilment and carrier management solutions.  \nAs such, our customers may be able to use some of the existing integrations BJS has with its partners. For more information please contact the vendor and our [integrations team](https://mailto:integration@bjshomedelivery.com). Whilst we've tried to make working with our APIs super easy, it might save you development and management cost to leverage an existing integration into BJS!\n\n#### Route Genie\n\nCarrier management platform - directly integrated with BJS and currently in use by customers.\n\n#### Aptean WMS\n\nDirectly integrated with BJS - currently in use. Aptean can clarify if the integration is readily available to other customers.\n\n#### Despatch Cloud\n\nMulti channel order - stock management. Directly integrated with BJS, pending go live with current customer.\n\n#### Mintsoft\n\nOrder management platform - uses a legacy API for integration -- limited functionality (basic order create) is available for all customers to use.\n\n#### Netsuite\n\nWMS integrations actively in use by customers. Likely not reusable directly, but direct integration with BJS is possible!\n\n#### Brightpearl\n\nRetail management - currently in use. Likely not reusable directly, but direct integration with BJS is possible!\n\n#### Shopify App\n\n_Coming Soon_ BJS is building its very own shopify plug in to allow retail partners to plug into BJS systems and integrate with just a few clicks!\n\n#### Wayfair\n\nBJS are directly integrated with Wayfair -- shipping via BJS can be enabled quite quickly.\n\n#### Orderwise\n\nWMS - direct integration pending testing and go live.\n\n## Tracking Integrations\n\n#### Parcel Perform\n\nDirect Integration with BJS via API. BJS is listed as an approved carrier.\n\n#### Aftership\n\nDirect Integration with BJS via FTP and API. BJS is listed as an approved carrier.\n\n#### Amazon\n\nDirect integration with BJS via API. BJS is listed as an approved carrier.\n\n#### ItinSell\n\nDirect integration with BJS via FTP - able to receive tracking events from BJS.\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1796716","collectionId":"ee68a348-6265-4f6a-8266-d20a3286573c","publishedId":"SzYbwwTB","public":true,"publicUrl":"https://developer.bjshomedelivery.com","privateUrl":"https://go.postman.co/documentation/1796716-ee68a348-6265-4f6a-8266-d20a3286573c","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.11.2","publishDate":"2020-04-03T18:10:00.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"BJS API/DEV ENV","id":"dd78c640-4bd2-4094-ab54-e2387f713515","owner":"1796716","values":[{"key":"BaseURL","value":"https://api.development.bjshomedelivery.com/v1","enabled":true},{"key":"Key","value":"**************","enabled":true},{"key":"AccountNumber","value":"*******","enabled":true},{"key":"CarrierReference","value":"**************","enabled":true},{"key":"User","value":"NewRetailPartner","enabled":true},{"key":"OrderNumber","value":"*********","enabled":true},{"key":"BaseURLv2","value":"https://api.development.bjshomedelivery.com/v2","enabled":true},{"key":"SupplierAccountNumber","value":"******","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://bjshomedelivery.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"BJS API/DEV ENV","value":"1796716-dd78c640-4bd2-4094-ab54-e2387f713515"}],"canonicalUrl":"https://developer.bjshomedelivery.com/view/metadata/SzYbwwTB"}