Exertis UK does not provide any warranty as to the availability, performance, accuracy or suitability of the API or data provided by it. Exertis shall not be liable for any loss whatsoever which might arise from the use of this API. Exertis reserve the right to change, withdraw or replace the API at any time without notice, or refuse or remove access to it. By using these APIs you agree to our standard acceptable usage policy as published at https://www.exertis.co.uk/policy-accept.php
\nBefore you can register with eHUB, you must be a customer of Exertis UK.
\nIf you are not a customer, then please use the contact us page to request an account.
\nPlease Note: it can take several days to create your account, depending on the checks required
\nOnce you have an Exeris UK account, you can then register for eHUB access via the registration page register here
\nRegistration requires you to identify your SAP Account Number & Account Manager in order for us to configure your access correctly.
\nWe also need you to identify the APIs that you want to consume.
For customers only requiring price and availability, please only select the P&A API, as this will speed up your onboarding time
For customers only requiring B&H, please only select the B&H API, as this will speed up your onboarding time
\nFor customers wanting to place orders via API, please select P&A / orders / status APIs.
Once you have submitted your request, you will receive confirmation that it has been sent.
Please allow 3-5 days for the account to be setup (depending on which APIs you’ve specified)
Initially you will be setup with a TEST account. Once setup is complete, you will be notified by email, containing instructions on how to proceed
\nBefore you can consume the APIs, you will need to obtain your Identity token, which is then used to create a bearer token - passed in via the header of every API call.
\nThe bearer token is used to authenticate your access and needs to be renewed every15 minutes.
\nTo obtain / renew your identity token, you must log into the eHUB Portal as an account manager, then follow the instructions to create / renew your Identity token.
\nonce you have your Identity token, you can then generate your short-lived bearer token, to be used to access Order and Product APIs
\nPart of the setup process is to create a small subset of products within your test account.
\nWhen placing orders, you will be expected to have fetched your product catalogue (which provides you with SKU codes, stock levels and pricing) and use this information to place orders.
\nWe suggest placing several orders, a couple that test the success path, plus a couple of orders that test the failure paths.
\nWhen an order fails, you will be returned a 40x response, with an overview of the issue. You will be expected to handle these issue's, fix and then resubmit.
\n*Exertis will not hold / process any failed orders.__*
\nSuccessful orders will be received into the PENDING|SENT status. at this point, you will need to contact support and ask them to move the orders on - so that you can then start testing the Status endpoints.
\nOnce you have completed a number of tests, we can then proceed to putting your account live
\nOnce testing has been successfully completed, you will need to ask support to create a production account. this account is separate from your test account and will use a different Identity token.
\nAgain, it may take a couple of days to setup your account, depending on your pricing structure.
\nOnce setup, and orders sent to this account will be fulfilled, and would be difficult to intercept
\nFrom time to time, you may have to deal with errors, when making requests on the Exertis API.
These can be categories as follows:
Content error – Invalid content in the API request.
\nNetwork error – Intermittent communication problems between client and server.
\nServer error – A problem on the Exertis servers.
\nYou should be expected to handle errors and ideally have a retry process in-place.
\nExertis uses HTTP response status codes to indicate the success or failure of your API requests.
If your request fails, Exertis returns an error using the appropriate status code.
In general, there are three status code ranges you can expect:
\n2xx success status codes confirm that your request worked as expected
\n4xx error status codes indicate an error because of the information provided.
\n5xx error status codes indicate an error with Exertis’ servers
\nif this does not help resolve the issue, then please contact us
\nAll of our API's that return multiple records will require paginating through.
\nYou can expect to find these in the \"links\" section in the response. Unless otherwise defined against an API, expected values can be.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Warranty","slug":"warranty"},{"content":"Getting started","slug":"getting-started"},{"content":"Registration","slug":"registration"},{"content":"API Consumption","slug":"api-consumption"},{"content":"Testing","slug":"testing"},{"content":"Go Live Process","slug":"go-live-process"},{"content":"Error Handling","slug":"error-handling"},{"content":"Error codes","slug":"error-codes"},{"content":"Paginating our APIs","slug":"paginating-our-apis"}],"owner":"1120620","collectionId":"6f4ff79f-bf37-40b5-87e0-c29d8aba988f","publishedId":"2s93Y5Q138","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-12-18T12:37:58.000Z"},"item":[{"name":"Authentication","item":[{"name":"Authenticate","event":[{"listen":"test","script":{"id":"81a23016-2274-4fcb-8690-960a7164b661","exec":["var jsonData = pm.response.json();\r","if(jsonData.data && jsonData.data.bearer && jsonData.data.bearer.token){\r"," pm.environment.set(\"customerBearer\", jsonData.data.bearer.token)\r","}\r",""],"type":"text/javascript","packages":{}}}],"id":"fc941454-1013-41a8-b948-73de87df508a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{accountNumber}}"},{"key":"password","value":"{{identityToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept-Version","value":"v1","description":"(Required)
\n"},{"key":"Accept","value":"application/json"}],"url":"https://ehub.exertis.io/token/authenticate","urlObject":{"path":["token","authenticate"],"host":["https://ehub.exertis.io"],"query":[],"variable":[]}},"response":[{"id":"49b6808b-e78a-4674-94aa-d55f10b67a56","name":"200 OK - Bearer token refreshed","originalRequest":{"method":"POST","header":[{"description":"(Required) ","key":"Accept-Version","value":"v1"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicCustomer facing APIs available for managing API access
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{accountNumber}}"},{"key":"password","value":"{{identityToken}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"58e4cfd6-8dd6-45ce-8c22-0e2883f53051","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"88cb59f6-cd23-439d-8c86-daeffc45c070","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"be1ec926-b4e9-418f-8c71-c54e2ca26fa9"},{"name":"Order","item":[{"name":"Create Order","event":[{"listen":"test","script":{"id":"a559a63f-a33b-41ac-98eb-79d83d1a429a","exec":[""],"type":"text/javascript"}}],"id":"caef8cae-e412-4f00-9af8-f5d884090b8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"(Required)
\n","key":"Accept-Version","value":"v1"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer_ref\": \"1234_my_order\",\n \"shipping_address\": {\n \"title\": \"Mrs\",\n \"forename\": \"Dan\",\n \"surname\": \"Tompson\",\n \"phone\": \"05665656466\",\n \"mobile\": \"05665656466\",\n \"email\": \"dant@email.com\",\n \"organisation\": \"To create an order within our system there is a minimum amount of information we require.
\nHere is an example or an order with no payment validation required:
\n{\n \"customer_ref\": \"{{YOUR_ORDER_REFERENCE}}\",\n \"shipping_address\": {\n \"forename\":\"Dan\",\n \"surname\": \"Torello\",\n \"phone\":\"02380\",\n \"email\": \"danT@email.com\",\n \"address1\": \"My Delivery House\",\n \"postcode\": \"GT45 5FD\",\n \"town\":\"Hampshire\",\n \"country\":\"GB\"\n },\n \"billing_address\": {\n \"forename\":\"Dan\",\n \"surname\": \"Torello\",\n \"email\": \"danT@email.com\",\n \"address1\": \"My Billing House\",\n \"postcode\": \"GT45 5FD\"\n },\n \"items\": [\n {\n \"sku\": \"10288115\",\n \"price\": 10.5,\n \"qty\": 1\n },\n {\n \"sku\": \"10288116\",\n \"price\": 10.5,\n \"qty\": 1\n }\n ],\n \"order_total\": 21.00\n}\n\nYou can find other examples on this page, in the examples section. It will show payloads depending on your account type, for example if we are to handle payments then valid payment objects must be passed through.
\n(Required)
\n"},{"key":"Accept","value":"application/json"}],"url":"https://ehub.exertis.io/order?page[size]=100","description":"This API is designed to let you see where the order is in the fulfilment process.
\nBy using the response you received for a successful placement of an order you can check on that order, or change filters to receive multiple statuses back.
\nThis table will highlight and describe each status you may receive when checking up on an order.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{customerBearer}}"}]},"isInherited":true,"source":{"_postman_id":"691e8392-c3e4-4285-b6c8-0c78c57f8cf1","id":"691e8392-c3e4-4285-b6c8-0c78c57f8cf1","name":"Order","type":"folder"}},"urlObject":{"path":["order"],"host":["https://ehub.exertis.io"],"query":[{"disabled":true,"description":{"content":"Json encoded string containing the search criteria.
\n","type":"text/plain"},"key":"filter","value":"{\"customer_order_ref\":\"order_ref1\", \"status\": [\"PENDING\",\"LIVE\"]}"},{"key":"page[size]","value":"100"},{"disabled":true,"description":{"content":"Returning orders whose status has been updated since last unix timestamp
\n","type":"text/plain"},"key":"status_updated_since","value":"1756721486"}],"variable":[]}},"response":[{"id":"4ae06949-ed02-4d60-8076-027734e19e55","name":"200 OK - Order List","originalRequest":{"method":"GET","header":[{"key":"Accept-Version","value":"v1","description":"(Required) "},{"key":"Authorization","value":"Bearer(Required)
\n"},{"key":"Accept","value":"application/json"},{"key":"Channel","value":"PORTAL"}],"url":"https://ehub.exertis.io/order/bill-and-hold","description":"Search for a list of orders by criteria supplied
\nUse this endpoint to retrieve your bill and hold information. A Paginated list of records will be returned if your account number supplied is valid
\nStartFragment
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{customerBearer}}"}]},"isInherited":true,"source":{"_postman_id":"691e8392-c3e4-4285-b6c8-0c78c57f8cf1","id":"691e8392-c3e4-4285-b6c8-0c78c57f8cf1","name":"Order","type":"folder"}},"urlObject":{"path":["order","bill-and-hold"],"host":["https://ehub.exertis.io"],"query":[],"variable":[]}},"response":[{"id":"c33a88f4-c421-4069-a680-a159a8b32ea5","name":"200 OK - Success","originalRequest":{"method":"GET","header":[{"key":"Accept-Version","value":"v1","description":"(Required) "},{"key":"Accept","value":"application/json"},{"key":"Channel","value":"PORTAL"}],"url":"https://ehub.exertis.io/order/bill-and-hold"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Jul 2024 09:33:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"ea-ingress-01CORS=7fe61f29f98021985fc8c329556734be; Path=/; SameSite=None; Secure"},{"key":"Set-Cookie","value":"ea-ingress-01=7fe61f29f98021985fc8c329556734be; Path=/"},{"key":"Set-Cookie","value":"ihub-ingress-001CORS=7ebb65d052dc49b55dc66b0f3841061f; Path=/; SameSite=None; Secure"},{"key":"Set-Cookie","value":"ihub-ingress-001=7ebb65d052dc49b55dc66b0f3841061f; Path=/"},{"key":"X-Powered-By","value":"PHP/8.2.20"},{"key":"Server","value":"nginx"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Security-Policy","value":"default-src 'none'; script-src 'self'; connect-src 'self'; img-src 'self'; style-src 'self'"},{"key":"X-Content-Security-Policy","value":"default-src 'none'; script-src 'self'; connect-src 'self'; img-src 'self'; style-src 'self'"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"data\": [\n {\n \"account_code\": \"XXXXXXXXXX\",\n \"customer_ref\": \"\",\n \"material_id;\": \"0000000000XXXXXXXX\",\n \"description\": \"Customer facing APIs available for managing order fulfilment
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{customerBearer}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"13c956a5-d6fe-4d98-842c-6869ceae0876","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"909d9ebc-4ff8-458e-9514-f153f23e04e0","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"691e8392-c3e4-4285-b6c8-0c78c57f8cf1"},{"name":"Product","item":[{"name":"Get Product Catalogue","id":"e4567093-e945-48cb-abfd-b7a5291cf71f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept-Version","value":"v1","description":"(Required)
\n"},{"key":"Accept","value":"application/json"}],"url":"https://ehub.exertis.io/product/catalogue?page[size]=1&filter={\"sku\":\"sku_123\"}&stock_updated_since=1756721486","description":"Allows customers to view smaller subset of product information suitable for stock and price control
\nJson encoded string containing the search criteria.'
\n","type":"text/plain"},"key":"filter","value":"{\"sku\":\"sku_123\"}"},{"description":{"content":"Returning products whose stock has been updated since last unix timestamp
\n","type":"text/plain"},"key":"stock_updated_since","value":"1756721486"}],"variable":[]}},"response":[{"id":"85378139-12ea-446d-8ab9-ddbcd5a6ced9","name":"200 OK - Product Catalogue List","originalRequest":{"method":"GET","header":[{"key":"Accept-Version","value":"v1","description":"(Required) "},{"key":"Authorization","value":"BearerCustomer facing APIs available for managing product integration
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{customerBearer}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"351a1418-ce48-4b18-8d77-fd30cdb2bf43","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"631bd8c1-1a0c-4e3b-847a-e96784688d22","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"8c9ed629-95c6-495e-aeba-c8918e800ee9"}],"event":[{"listen":"prerequest","script":{"id":"61d5c4d5-7192-4ddc-8444-98cd79127d5f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"30f33928-66bb-4c4b-96dc-404009886bf3","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://ehub.exertis.io"},{"key":"eHubBaseUrl","value":"https://ehub.exertis.io"},{"key":"identityToken","value":"{{identityToken}}"},{"key":"bearerToken","value":"{{bearerToken}}"},{"key":"accountNumber","value":"{{accountNumber}}"}]}