iHub Services
- Dean Bazeley
- James Seabrook
- 1 Introduction
- 2 Available Services
- 2.1 7.1. Echo – echo/v1
- 2.2 7.2. Products – products/v1
- 2.3 7.3. Receipt – receipts/v1
- 2.4 7.4. Company – companies/v1
- 2.5 7.5. Sales Order – salesorders/v1
- 2.5.1 7.5.1. /submit - Submit order
- 2.5.2 7.5.2. /websubmit – Submit Web Order
- 2.5.3 7.5.3. /cancel/reasoncode – Cancel a sales order with a reason code
- 2.5.4 7.5.4. /releasefromhold – Release the Sales Order from Hold
- 2.5.5 7.5.5. /cancelfromhold
- 2.5.6 7.5.6. /status – Check status of order
- 2.5.7 7.5.7. /tracking – Check tracking details of a sales order
- 2.6 7.6. Stock – stock/v1
- 2.6.1 7.6.1. /submit/adjustment – Load Stock Adjustments
- 2.6.2 7.6.2. /all - Retrieve All Stock
- 2.6.3 7.6.3. /dc – Retrieve Stock for a specific Distribution Centre
- 2.6.4 7.6.4. /product – Retrieve stock for a specific product
- 2.6.5 7.6.5. /adjustment – Retrieve stock adjustments
- 2.6.6 7.6.6. /movements – Retrieve stock movements
- 2.7 7.7. Dispatches – dispatches/v1
- 2.8 7.8. GRN – GRN/v1
- 2.9 7.9. Purchase Orders – purchaseorders/v1
Introduction
This section is split by service. These are all the services available to connect to on the Integration Hub. A full list of services documented in this section can be found below. Each section provides detailed information on the service, such as available field information and system behaviour details.
The services also incorporate version control so that new versions of the API can be created without existing clients having to upgrade immediately to the new version. The hub provides the following services:
Available Services
ID | Service | Latest version | Manual | REST API | FTP |
1 | V1 | x | x | x | |
2 | V4 | x | x | x | |
3 | V4 | x | x | x | |
4 | V3 | x | x | x | |
5 | V3 | x | x | x | |
6 | V1 | x | x | x | |
7 | V3 | x | x | x | |
8 | V4 | x | x | x | |
9 | V4 | x | x | x | |
10 | V3 | x | |||
11 | V1 | x | x | ||
12 | V6 | x | x | ||
13 | V6 | x | x | ||
14 | V4 | x | x | ||
15 | V3 | x | x | ||
16 | V3 | x | x |
7.1. Echo – echo/v1
This service is available in order for clients to test that their API tokens are working and that they can connect to the Integration Hub. Any value in ‘parameter’ is echo’d back to the caller.
HTTP Method | Parameters | Description | XML | JSON | CSV | HTML |
GET | {parameter} | Parameter is echo’d back to the client | Y | Y | Y | Y |
Examples
Call | Echo Test in XML (GET) |
URL | https://hubuat1.supplystream.com/hub/api/echo/v1/hello.xml?token=<token> |
RESULT | <echo>hello</echo> |
Call | Echo Test in HTML (GET) |
URL | https://hubuat1.supplystream.com/hub/api/echo/v1/hello.html?token=<token > |
RESULT | <p>hello</p> |
If you are developing your interfaces to the hub for the first time it is useful to have a test service you can call to check that your code is working.
The echo service in the UAT test environment is setup with a test account so you can check your code is working with echo. The following token should be used:
yc9omovynxl61949xn616inpkqy2db931cgov9
and your base URL should be https://hubuat1.supplystream.com/hub/api/For example, the following call should echo using the json format.
7.2. Products – products/v1
HTTP Method | Parameters | Description | X M L | J S O N | C S V | H T M L | |
POST | /submit | Load product master | Y | Y | N |
| N |
POST | /update | Update product master | Y | Y | N |
| N |
POST | /submit/{guid}/ean/{ean} | Load Product Master EAN | Y | Y | Y |
| Y |
GET | /{product}/status | Get status for product | Y | Y | Y |
| Y |
GET | /{product}/eans | Get EAN for product | Y | Y | Y |
| Y |
7.2.1. /submit – Load Product Master
This call creates new products (WCF 3.1).
Call | Load Product Master in XML format (POST) |
URL | https://hubuat1.supplystream.com/hub/api/products/v1/submit?token=<token > |
SAMPLE BODY | https://hubuat1.supplystream.com/hub/api/products/v1/sample?token=<token > |
BODY | <?xml version="1.0" encoding="UTF-8" standalone="no"?> <Request> <ProductMaster> <HTSCode>HTS Code (Optional)</HTSCode> <ProductDescription>Product Description (Optional)</ProductDescription> <ProductLongDescription>Product Long Description (Optional)</ProductLongDescription> <EAN>EAN (Optional)</EAN> <ProductCode>Product Code </ProductCode> </ProductMaster> <List> <SupplierMapping> <SupplierCode>Supplier Code </SupplierCode> <SupplierDescription>Supplier Description </SupplierDescription> <UOM>UOM </UOM> </SupplierMapping> <SupplierMapping> <SupplierCode>Supplier Code </SupplierCode> <SupplierDescription>Supplier Description </SupplierDescription> <UOM>UOM </UOM> </SupplierMapping> <SupplierMapping> <SupplierCode>Supplier Code </SupplierCode> <SupplierDescription>Supplier Description </SupplierDescription> <UOM>UOM </UOM> </SupplierMapping> </List> <List> <ShipToCompanyMapping> <MappedCode>Mapped Code (Optional)</MappedCode> <BranchCode>Branch Code (Optional)</BranchCode> <CompanyCode>Company Code (Optional)</CompanyCode> </ShipToCompanyMapping> <ShipToCompanyMapping> <MappedCode>Mapped Code (Optional)</MappedCode> <BranchCode>Branch Code (Optional)</BranchCode> <CompanyCode>Company Code (Optional)</CompanyCode> </ShipToCompanyMapping> <ShipToCompanyMapping> <MappedCode>Mapped Code (Optional)</MappedCode> <BranchCode>Branch Code (Optional)</BranchCode> <CompanyCode>Company Code (Optional)</CompanyCode> </ShipToCompanyMapping> |
| </List> <List> <ProductIdentifier> <Name>Name (Optional)</Name> <Value>Value (Optional)</Value> <SortOrder>Sort Order (Optional)</SortOrder> </ProductIdentifier> <ProductIdentifier> <Name>Name (Optional)</Name> <Value>Value (Optional)</Value> <SortOrder>Sort Order (Optional)</SortOrder> </ProductIdentifier> <ProductIdentifier> <Name>Name (Optional)</Name> <Value>Value (Optional)</Value> <SortOrder>Sort Order (Optional)</SortOrder> </ProductIdentifier> </List> </Request> |
RESULT | <?xml version="1.0" encoding="UTF-16"?> <Response> <CallStatus> <Success>true</Success> <Code>0</Code> <Message/> </CallStatus> <GUID>3ab874f5-d59f-4bf0-9859-ee513bd5f1cf</GUID> </Response> |
Call | Load Product Master in JSON format (POST) |
URL | https://hubuat1.supplystream.com/hub/api/products/v1/submit.json?token=< token> |
SAMPLE BODY | https://hubuat1.supplystream.com/hub/api/products/v1/sample.json?token=< token> |
BODY | { "Request": { "List": [ { "SupplierMapping": [ { "SupplierCode": "Supplier Code", "SupplierDescription": "Supplier Description", "UOM": "UOM" }, { "SupplierCode": "Supplier Code", "SupplierDescription": "Supplier Description", "UOM": "UOM" }, { "SupplierCode": "Supplier Code", "SupplierDescription": "Supplier Description", "UOM": "UOM" } ] }, { "ShipToCompanyMapping": [ { "BranchCode": "Branch Code (Optional)", "CompanyCode": "Company Code (Optional)", "MappedCode": "Mapped Code (Optional)" }, { "BranchCode": "Branch Code (Optional)", "CompanyCode": "Company Code (Optional)", "MappedCode": "Mapped Code (Optional)" }, { "BranchCode": "Branch Code (Optional)", "CompanyCode": "Company Code (Optional)", |
| "MappedCode": "Mapped Code (Optional)" } ] }, { "ProductIdentifier": [ { "Name": "Name (Optional)", "SortOrder": "Sort Order (Optional)", "Value": "Value (Optional)" }, { "Name": "Name (Optional)", "SortOrder": "Sort Order (Optional)", "Value": "Value (Optional)" }, { "Name": "Name (Optional)", "SortOrder": "Sort Order (Optional)", "Value": "Value (Optional)" } ] } ], "ProductMaster": { "EAN": "EAN (Optional)", "HTSCode": "HTS Code (Optional)", "ProductCode": "Product Code", "ProductDescription": "Product Description (Optional)", "ProductLongDescription": "Product Long Description (Optional)" } } } |
RESULT | {"Response": { "CallStatus": { "Code": 0, "Message": {}, "Success": true }, "GUID": "3ea9eb61-7f49-4c03-986a-9340da72c6d4" }} |
7.2.2. /update – update product master
This call can be used to update product information for the products you created (WCF 3.17)
Call | Update Product Master in XML format (POST) |
URL | https://hubuat1.supplystream.com/hub/api/products/v1/update?token=<token > |
SAMPLE BODY | https://hubuat1.supplystream.com/hub/api/products/v1/updatesample?token= <token> |
BODY | <?xml version="1.0" encoding="UTF-8" standalone="no"?> <Request> <ProductMaster> <HTSCode>HTS Code (Optional)</HTSCode> <ProductDescription>Product Description (Optional)</ProductDescription> <ProductLongDescription>Product Long Description (Optional)</ProductLongDescription> <EAN>EAN (Optional)</EAN> <ProductCode>Product Code </ProductCode> </ProductMaster> <List> <SupplierMapping> <SupplierCode>Supplier Code (Optional)</SupplierCode> <SupplierDescription>Supplier Description (Optional)</SupplierDescription> <UOM>UOM (Optional)</UOM> </SupplierMapping> <SupplierMapping> <SupplierCode>Supplier Code (Optional)</SupplierCode> |
| <SupplierDescription>Supplier Description (Optional)</SupplierDescription> <UOM>UOM (Optional)</UOM> </SupplierMapping> <SupplierMapping> <SupplierCode>Supplier Code (Optional)</SupplierCode> <SupplierDescription>Supplier Description (Optional)</SupplierDescription> <UOM>UOM (Optional)</UOM> </SupplierMapping> </List> <List> <ShipToCompanyMapping> <MappedCode>Mapped Code (Optional)</MappedCode> <BranchCode>Branch Code (Optional)</BranchCode> <CompanyCode>Company Code (Optional)</CompanyCode> </ShipToCompanyMapping> <ShipToCompanyMapping> <MappedCode>Mapped Code (Optional)</MappedCode> <BranchCode>Branch Code (Optional)</BranchCode> <CompanyCode>Company Code (Optional)</CompanyCode> </ShipToCompanyMapping> <ShipToCompanyMapping> <MappedCode>Mapped Code (Optional)</MappedCode> <BranchCode>Branch Code (Optional)</BranchCode> <CompanyCode>Company Code (Optional)</CompanyCode> </ShipToCompanyMapping> </List> <List> <ProductIdentifier> <Name>Name (Optional)</Name> <Value>Value (Optional)</Value> <SortOrder>Sort Order (Optional)</SortOrder> </ProductIdentifier> <ProductIdentifier> <Name>Name (Optional)</Name> <Value>Value (Optional)</Value> <SortOrder>Sort Order (Optional)</SortOrder> </ProductIdentifier> <ProductIdentifier> <Name>Name (Optional)</Name> <Value>Value (Optional)</Value> <SortOrder>Sort Order (Optional)</SortOrder> </ProductIdentifier> </List> </Request> |
RESULT | <?xml version="1.0" encoding="UTF-16"?> <Response> <CallStatus> <Success>true</Success> <Code>0</Code> <Message/> </CallStatus> <GUID>3ab874f5-d59f-4bf0-9859-ee513bd5f1cf</GUID> </Response> |
Call | Update Product Master in JSON format (POST) |
URL | https://hubuat1.supplystream.com/hub/api/products/v1/update.json?token=< token> |
SAMPLE BODY | https://hubuat1.supplystream.com/hub/api/products/v1/updatesample.json?t oken=<token> |
BODY | { "Request": { "List": [ { "SupplierMapping": [ { "SupplierCode": "Supplier Code (Optional)", "SupplierDescription": "Supplier Description (Optional)", "UOM": "UOM (Optional)" }, |
| { "SupplierCode": "Supplier Code (Optional)", "SupplierDescription": "Supplier Description (Optional)", "UOM": "UOM (Optional)" }, { "SupplierCode": "Supplier Code (Optional)", "SupplierDescription": "Supplier Description (Optional)", "UOM": "UOM (Optional)" } ] }, { "ShipToCompanyMapping": [ { "BranchCode": "Branch Code (Optional)", "CompanyCode": "Company Code (Optional)", "MappedCode": "Mapped Code (Optional)" }, { "BranchCode": "Branch Code (Optional)", "CompanyCode": "Company Code (Optional)", "MappedCode": "Mapped Code (Optional)" }, { "BranchCode": "Branch Code (Optional)", "CompanyCode": "Company Code (Optional)", "MappedCode": "Mapped Code (Optional)" } ] }, { "ProductIdentifier": [ { "Name": "Name (Optional)", "SortOrder": "Sort Order (Optional)", "Value": "Value (Optional)" }, { "Name": "Name (Optional)", "SortOrder": "Sort Order (Optional)", "Value": "Value (Optional)" }, { "Name": "Name (Optional)", "SortOrder": "Sort Order (Optional)", "Value": "Value (Optional)" } ] } ], "ProductMaster": { "EAN": "EAN (Optional)", "HTSCode": "HTS Code (Optional)", "ProductCode": "Product Code", "ProductDescription": "Product Description (Optional)", "ProductLongDescription": "Product Long Description (Optional)" } } } |
RESULT | {"Response": { "CallStatus": { "Code": 0, "Message": {}, "Success": true }, "GUID": "3ea9eb61-7f49-4c03-986a-9340da72c6d4" }} |
7.2.3. /submit/{productCode}/ean/{ean}
This call should be used if you need to update an EAN value based on the System EAN for a product (WCF 3.6)
Call | Load EAN <ean> for product <guid> in JSON format (POST) |
URL | |
RESULT |
|
7.2.4. /status – retrieve product status for a specific product
This call can be used to check the current status of a product. The status can be “In Development” or “In Production”. (WCF 3.4)
Call | Return product status for product 100083 in JSON format (GET) |
URL | https://hubuat1.supplystream.com/hub/api/products/v1/100083/status.json? token=<token> |
RESULT | { "Response": { "CallStatus": { "Code": 0, "Message": {}, "Success": true }, "ProductCode": 100083, "Status": "In Production" } } |
7.2.5. /eans – retrieve EANs for a specific product
This call should only be used if you need to return a list of internal System EAN’s for a product. (WCF 3.5)
Call | Return EAN for product 100083 in JSON format (GET) |
URL | https://hubuat1.supplystream.com/hub/api/products/v1/100083/eans.json?to ken=<token> |
RESULT | { "Response": { "CallStatus": { "Code": 0, "Message": {}, "Success": true }, "List": {"ProductMasterEANLineItem": { "IdentifiersValue": {}, "SystemEANId": "c1595008-2cc9-e211-a0b9-000c29da324d" }}, "ProductCode": 100083 }} |
7.3. Receipt – receipts/v1
HTTP Method | Parameters | Description | X M L | J S O N | C S V | HT M L |
POST | /submit | Load receipts | Y | Y | N | N |
7.3.1. /submit - Load Receipt s
This call creates a new receipt. This will create an advance ship notice of pending deliveries in the DC. (WCF 3.3)
Call | Load Receipts in XML format (POST) |
URL | https://hubuat1.supplystream.com/hub/api/receipts/v1/submit?token=<token > |
SAMPLE BODY | https://hubuat1.supplystream.com/hub/api/receipts/v1/sample?token=<token > |
BODY | <?xml version="1.0" encoding="UTF-8" standalone="no"?> <Request> <Receipt> <Notes>Notes (Optional)</Notes> <ASNNumber>ASN Number </ASNNumber> <WarehouseETA>Warehouse ETA (Optional)</WarehouseETA> <HBReference>HB Reference (Optional)</HBReference> <IsReturn>Is Return (Optional)</IsReturn> <GUID>GUID (Optional)</GUID> </Receipt> <List> |