Services

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

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.

https://hubuat1.supplystream.com/hub/api/echo/v1/hello.json?token=yc9omovynxl61949x n616inpkqy2db931cgov9

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	https://hubuat1.supplystream.com/hub/api/products/v1/submit/3ab874f5d59f-4bf0-9859-ee513bd5f1cf/ean/ABCDEF.json?token=<token>
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

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> <ReceiptLineItem> <LineNumber>Line Number </LineNumber> <SupplierCompanyCode>Supplier Company Code </SupplierCompanyCode> <Quantity>Quantity </Quantity> <GUID>GUID (Optional)</GUID> <EAN>EAN (Optional)</EAN> <ProductCode>Product Code (Optional)</ProductCode> </ReceiptLineItem> <ReceiptLineItem> <LineNumber>Line Number </LineNumber> <SupplierCompanyCode>Supplier Company Code </SupplierCompanyCode> <Quantity>Quantity </Quantity> <GUID>GUID (Optional)</GUID> <EAN>EAN (Optional)</EAN> <ProductCode>Product Code (Optional)</ProductCode> </ReceiptLineItem> <ReceiptLineItem> <LineNumber>Line Number </LineNumber> <SupplierCompanyCode>Supplier Company Code </SupplierCompanyCode> <Quantity>Quantity </Quantity> <GUID>GUID (Optional)</GUID> <EAN>EAN (Optional)</EAN> <ProductCode>Product Code (Optional)</ProductCode> </ReceiptLineItem> </List> <ReceiptHeader>
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 Receipts in JSON format (POST)
URL	https://hubuat1.supplystream.com/hub/api/receipts/v1/submit.json?token=< token>
SAMPLE BODY	https://hubuat1.supplystream.com/hub/api/receipts/v1/sample.json?token=< token>
BODY	{ "Request": { "List": { "ReceiptLineItem": [ { "EAN": "EAN (Optional)", "GUID": "GUID (Optional)", "LineNumber": "Line Number", "ProductCode": "Product Code (Optional)", "Quantity": "Quantity", "SupplierCompanyCode": "Supplier Company Code" }, { "EAN": "EAN (Optional)", "GUID": "GUID (Optional)", "LineNumber": "Line Number", "ProductCode": "Product Code (Optional)", "Quantity": "Quantity", "SupplierCompanyCode": "Supplier Company Code" }, { "EAN": "EAN (Optional)", "GUID": "GUID (Optional)", "LineNumber": "Line Number", "ProductCode": "Product Code (Optional)", "Quantity": "Quantity", "SupplierCompanyCode": "Supplier Company Code" } ] }, "Receipt": { "ASNNumber": "ASN Number", "GUID": "GUID (Optional)", "HBReference": "HB Reference (Optional)", "IsReturn": "Is Return (Optional)", "Notes": "Notes (Optional)", "WarehouseETA": "Warehouse ETA (Optional)" }, "ReceiptHeader": { "DCCode": "DC Code (Optional)" } } }
RESULT	{"Response": { "CallStatus": { "Code": 0, "Message": {}, "Success": true }, "GUID": "3ea9eb61-7f49-4c03-986a-9340da72c6d4" }}

7.4. Company – companies/v1

HTTP

Method

Parameters

Description

X

M

L

J

S

O

N

C

S

V

HT

M

L

POST

/submit

Load company information

Y

N

7.4.1. /submit – Load Companies

This call can be used to create a new company. This includes new suppliers and ship to companies. The Company Type field is used to specify the type of company you are creating. (WCF 3.10)

Call	Load Companies in XML format (POST)
URL	https://hubuat1.supplystream.com/hub/api/companies/v1/submit?token=<toke n>
SAMPLE BODY	https://hubuat1.supplystream.com/hub/api/companies/v1/sample?token=<toke n>
BODY	<?xml version="1.0" encoding="UTF-8" standalone="no"?> <Request> <Company> <BranchCode>Branch Code (Optional)</BranchCode> <CompanyCategory>Company Category (Optional)</CompanyCategory> <CompanyCode>Company Code </CompanyCode> <CompanyDescription>Company Description </CompanyDescription> <CompanyType>Company Type </CompanyType> <Notes>Notes (Optional)</Notes> <SpecialInstructions>Special Instructions (Optional)</SpecialInstructions> </Company> <List> <Address> <AddressLine1>Address Line 1 </AddressLine1> <AddressLine2>Address Line 2 (Optional)</AddressLine2> <AddressLine3>Address Line 3 (Optional)</AddressLine3> <AddressLine4>Address Line 4 (Optional)</AddressLine4> <City>City </City> <County>County (Optional)</County> <PostcodeZip>Postcode Zip </PostcodeZip> <CountryCode>Country Code </CountryCode> <AddressType>Address Type </AddressType> <AddressLocationType>Address Location Type (Optional)</AddressLocationType> </Address> <Address> <AddressLine1>Address Line 1 </AddressLine1> <AddressLine2>Address Line 2 (Optional)</AddressLine2> <AddressLine3>Address Line 3 (Optional)</AddressLine3> <AddressLine4>Address Line 4 (Optional)</AddressLine4> <City>City </City> <County>County (Optional)</County> <PostcodeZip>Postcode Zip </PostcodeZip> <CountryCode>Country Code </CountryCode> <AddressType>Address Type </AddressType> <AddressLocationType>Address Location Type (Optional)</AddressLocationType> </Address> <Address> <AddressLine1>Address Line 1 </AddressLine1> <AddressLine2>Address Line 2 (Optional)</AddressLine2> <AddressLine3>Address Line 3 (Optional)</AddressLine3> <AddressLine4>Address Line 4 (Optional)</AddressLine4> <City>City </City> <County>County (Optional)</County>
	<PostcodeZip>Postcode Zip </PostcodeZip> <CountryCode>Country Code </CountryCode> <AddressType>Address Type </AddressType> <AddressLocationType>Address Location Type (Optional)</AddressLocationType> </Address> </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 Companies in JSON format (POST)
URL	https://hubuat1.supplystream.com/hub/api/companies/v1/submit.json?token= <token>
SAMPLE BODY	https://hubuat1.supplystream.com/hub/api/companies/v1/sample.json?token= <token>
BODY	{ "Request": { "Company": { "BranchCode": "Branch Code (Optional)", "CompanyCategory": "Company Category (Optional)", "CompanyCode": "Company Code", "CompanyDescription": "Company Description", "CompanyType": "Company Type", "Notes": "Notes (Optional)", "SpecialInstructions": "Special Instructions (Optional)" }, "List": { "Address": [ { "AddressLine1": "Address Line 1", "AddressLine2": "Address Line 2 (Optional)", "AddressLine3": "Address Line 3 (Optional)", "AddressLine4": "Address Line 4 (Optional)", "AddressLocationType": "Address Location Type (Optional)", "AddressType": "Address Type", "City": "City", "CountryCode": "Country Code", "County": "County (Optional)", "PostcodeZip": "Postcode Zip" }, { "AddressLine1": "Address Line 1", "AddressLine2": "Address Line 2 (Optional)", "AddressLine3": "Address Line 3 (Optional)", "AddressLine4": "Address Line 4 (Optional)", "AddressLocationType": "Address Location Type (Optional)", "AddressType": "Address Type", "City": "City", "CountryCode": "Country Code", "County": "County (Optional)", "PostcodeZip": "Postcode Zip" }, { "AddressLine1": "Address Line 1", "AddressLine2": "Address Line 2 (Optional)", "AddressLine3": "Address Line 3 (Optional)", "AddressLine4": "Address Line 4 (Optional)", "AddressLocationType": "Address Location Type (Optional)", "AddressType": "Address Type", "City": "City", "CountryCode": "Country Code", "County": "County (Optional)", "PostcodeZip": "Postcode Zip"
	} ] } } }
RESULT	{"Response": { "CallStatus": { "Code": 0, "Message": {}, "Success": true }, "GUID": "3ea9eb61-7f49-4c03-986a-9340da72c6d4" }}

7.5. Sales Order – salesorders/v1

This service is for submitting and managing Sales Orders.

HTTP Method	Parameters	Description	X M L	J S O N	C S V	HT M L
POST	/submit	Submits an order	Y	Y	N	N
POST	/websubmit	Submits a web order	Y	Y	N	N
POST	/{guid}/cancel/reasoncode/{reason}	Sales Order cancel for reasoncode [{eason}	Y	Y	N	N
POST	/{SONum}/releasefromhold	Release sales order from hold {SONum} from hold	Y	Y	N	N
POST	/{SONum}/cancelfromhold	Cancel from hold for sales order {SONum}	Y	Y	N	N
GET	/{guid}/status	Returns status of order with {guid}	Y	Y	Y	Y
GET	/{guid}/tracking	Returns tracking information of order with id {guid}	Y	Y	Y	Y

7.5.1. /submit - Submit order

This call can be called to create new sales orders. The products within the order must have sufficient available stock for the order to be created if “PushToDC” is set to true. (WCF 3.18)

Call	Submit Sales Order using XML (POST) Note: Orders submitted through this method must related to customers already setup in the system.
URL	https://hubuat1.supplystream.com/hub/api/salesorders/v1/submit?token=<to ken> or https://hubuat1.supplystream.com/hub/api/salesorders/v1/submit.xml?token =<token>
SAMPLE BODY	https://hubuat1.supplystream.com/hub/api/salesorders/v1/sample.xml?token =<token>
BODY	<?xml version="1.0" encoding="UTF-8"?><Request> <SalesOrder> <SalesOrderNumber>Sales Order Number </SalesOrderNumber> <SalesOrderReference>Sales Order Reference (Optional)</SalesOrderReference> <SalesOrderDate>Sales Order Date </SalesOrderDate> <GUID>GUID (Optional)</GUID> <UltimateDestination>Ultimate Destination (Optional)</UltimateDestination> <ScheduledShipDate>Scheduled Ship Date (Optional)</ScheduledShipDate> <ShipmentTerms>Shipment Terms (Optional)</ShipmentTerms> <DoNotPushToDC>Do Not Push To DC (Optional)</DoNotPushToDC> <CourierName>Courier Name (Optional)</CourierName> <CourierService>Courier Service (Optional)</CourierService> <NotificationMethod>Notification Method (Optional)</NotificationMethod> <Notes>Notes (Optional)</Notes>

<SpecialInstructions>Special Instructions

(Optional)</SpecialInstructions>

</SalesOrder>

<CompanyCode>Company Code </CompanyCode>

<BranchCode>Branch Code (Optional)</BranchCode>

<CompanyDescription>Company Description </CompanyDescription>

<CompanyCategory>Company Category (Optional)</CompanyCategory>

<LookupDeliveryAddress>Lookup Delivery Address

(Optional)</LookupDeliveryAddress>

</ShipToCompany>

<FirstName>First Name (Optional)</FirstName>

<LastName>Last Name (Optional)</LastName>

<Title>Title (Optional)</Title>

<ContactCode>Contact Code (Optional)</ContactCode>

<Line2>Line 2 (Optional)</Line2>

<Line3>Line 3 (Optional)</Line3>

<Line4>Line 4 (Optional)</Line4>

<County>County (Optional)</County>

<PostcodeZip>Postcode Zip </PostcodeZip>

<CountryCode>Country Code </CountryCode>

<PhoneNumber>Phone Number (Optional)</PhoneNumber>

<EmailAddress>Email Address (Optional)</EmailAddress>

</DeliveryDetails>

<FirstName>First Name (Optional)</FirstName>

<LastName>Last Name (Optional)</LastName>

<Title>Title (Optional)</Title>

<ContactCode>Contact Code (Optional)</ContactCode>

<Line1>Line 1 (Optional)</Line1>

<Line2>Line 2 (Optional)</Line2>

<Line3>Line 3 (Optional)</Line3>

<Line4>Line 4 (Optional)</Line4>

<City>City (Optional)</City>

<County>County (Optional)</County>

<PostcodeZip>Postcode Zip (Optional)</PostcodeZip>

<CountryCode>Country Code (Optional)</CountryCode>

<PhoneNumber>Phone Number (Optional)</PhoneNumber>

<EmailAddress>Email Address (Optional)</EmailAddress>

</BillingDetails>

<CompanyCode>Company Code (Optional)</CompanyCode>

<CompanyDescription>Company Description (Optional)</CompanyDescription>

<FirstName>First Name (Optional)</FirstName>

<LastName>Last Name (Optional)</LastName>

<Title>Title (Optional)</Title>

<ContactCode>Contact Code (Optional)</ContactCode>

<Line1>Line 1 (Optional)</Line1>

<Line2>Line 2 (Optional)</Line2>

<Line3>Line 3 (Optional)</Line3>

<Line4>Line 4 (Optional)</Line4>

<City>City (Optional)</City>

<County>County (Optional)</County>

<PostcodeZip>Postcode Zip (Optional)</PostcodeZip>

<CountryCode>Country Code (Optional)</CountryCode>

<PhoneNumber>Phone Number (Optional)</PhoneNumber>

<EmailAddress>Email Address (Optional)</EmailAddress>

</ForwardingAgent>

<DCCode>DC Code (Optional)</DCCode>

</SalesOrderHeader>

<List>

<LineNumber>Line Number </LineNumber>

<GUID>GUID (Optional)</GUID>

<ProductCode>Product Code (Optional)</ProductCode>

<EAN>EAN (Optional)</EAN>

<Quantity>Quantity </Quantity>

<UnitPrice>Unit Price (Optional)</UnitPrice>

<VAT>VAT (Optional)</VAT>

<ExternalDocumentNo>External Document No

(Optional)</ExternalDocumentNo>

<CurrencyCode>Currency Code (Optional)</CurrencyCode>

<CountryCode>Country Code (Optional)</CountryCode>

</SalesOrderLineItem>

<LineNumber>Line Number </LineNumber>

<GUID>GUID (Optional)</GUID>

<ProductCode>Product Code (Optional)</ProductCode>

<EAN>EAN (Optional)</EAN>

<Quantity>Quantity </Quantity>

<UnitPrice>Unit Price (Optional)</UnitPrice>

<VAT>VAT (Optional)</VAT>

<ExternalDocumentNo>External Document No

(Optional)</ExternalDocumentNo>

<CurrencyCode>Currency Code (Optional)</CurrencyCode>

<CountryCode>Country Code (Optional)</CountryCode>

</SalesOrderLineItem>

<LineNumber>Line Number </LineNumber>

<GUID>GUID (Optional)</GUID>

<ProductCode>Product Code (Optional)</ProductCode>

<EAN>EAN (Optional)</EAN>

<Quantity>Quantity </Quantity>

<UnitPrice>Unit Price (Optional)</UnitPrice>

<VAT>VAT (Optional)</VAT>

<ExternalDocumentNo>External Document No

(Optional)</ExternalDocumentNo>

<CurrencyCode>Currency Code (Optional)</CurrencyCode>

<CountryCode>Country Code (Optional)</CountryCode>

</SalesOrderLineItem>

</List>

</Request>

RESULT

<?xml version="1.0" encoding="UTF-16"?>

</CallStatus>

Call	Submit Sales Order using JSON (POST) Note: Orders submitted through this method must related to customers already setup in the system.
URL	https://hubuat1.supplystream.com/hub/api/salesorders/v1/submit.json?toke n=<token>
SAMPLE BODY	https://hubuat1.supplystream.com/hub/api/salesorders/v1/sample.json?toke n=<token>
BODY	{"Request": { "BillingDetails": { "City": "City (Optional)", "ContactCode": "Contact Code (Optional)", "CountryCode": "Country Code (Optional)", "County": "County (Optional)", "EmailAddress": "Email Address (Optional)", "FirstName": "First Name (Optional)", "LastName": "Last Name (Optional)", "Line1": "Line 1 (Optional)", "Line2": "Line 2 (Optional)", "Line3": "Line 3 (Optional)", "Line4": "Line 4 (Optional)", "PhoneNumber": "Phone Number (Optional)", "PostcodeZip": "Postcode Zip (Optional)", "Title": "Title (Optional)" }, "DeliveryDetails": { "City": "City", "ContactCode": "Contact Code (Optional)", "CountryCode": "Country Code", "County": "County (Optional)", "EmailAddress": "Email Address (Optional)",

"FirstName": "First Name (Optional)",

"LastName": "Last Name (Optional)",

"Line1": "Line 1",

"Line2": "Line 2 (Optional)",

"Line3": "Line 3 (Optional)",

"Line4": "Line 4 (Optional)",

"PhoneNumber": "Phone Number (Optional)",

"PostcodeZip": "Postcode Zip",

"Title": "Title (Optional)"

},

"ForwardingAgent": {

"City": "City (Optional)",

"CompanyCode": "Company Code (Optional)",

"CompanyDescription": "Company Description (Optional)",

"ContactCode": "Contact Code (Optional)",

"CountryCode": "Country Code (Optional)",

"County": "County (Optional)",

"EmailAddress": "Email Address (Optional)",

"FirstName": "First Name (Optional)",

"LastName": "Last Name (Optional)",

"Line1": "Line 1 (Optional)",

"Line2": "Line 2 (Optional)",

"Line3": "Line 3 (Optional)",

"Line4": "Line 4 (Optional)",

"PhoneNumber": "Phone Number (Optional)",

"PostcodeZip": "Postcode Zip (Optional)",

"Title": "Title (Optional)"

},

"List": {"SalesOrderLineItem": [

{

"CountryCode": "Country Code (Optional)",

"CurrencyCode": "Currency Code (Optional)",

"EAN": "EAN (Optional)",

"ExternalDocumentNo": "External Document No (Optional)",

"GUID": "GUID (Optional)",

"LineNumber": "Line Number",

"ProductCode": "Product Code (Optional)",

"Quantity": "Quantity",

"UnitPrice": "Unit Price (Optional)",

"VAT": "VAT (Optional)"

},

{

"CountryCode": "Country Code (Optional)",

"CurrencyCode": "Currency Code (Optional)",

"EAN": "EAN (Optional)",

"ExternalDocumentNo": "External Document No (Optional)",

"GUID": "GUID (Optional)",

"LineNumber": "Line Number",

"ProductCode": "Product Code (Optional)",

"Quantity": "Quantity",

"UnitPrice": "Unit Price (Optional)",

"VAT": "VAT (Optional)"

},

{

"CountryCode": "Country Code (Optional)",

"CurrencyCode": "Currency Code (Optional)",

"EAN": "EAN (Optional)",

"ExternalDocumentNo": "External Document No (Optional)",

"GUID": "GUID (Optional)",

"LineNumber": "Line Number",

"ProductCode": "Product Code (Optional)",

"Quantity": "Quantity",

"UnitPrice": "Unit Price (Optional)",

"VAT": "VAT (Optional)"

}

]},

"SalesOrder": {

"CourierName": "Courier Name (Optional)",

"CourierService": "Courier Service (Optional)",

"DoNotPushToDC": "Do Not Push To DC (Optional)",

"GUID": "GUID (Optional)",

"Notes": "Notes (Optional)",

"NotificationMethod": "Notification Method (Optional)",

"SalesOrderDate": "Sales Order Date",

"SalesOrderNumber": "Sales Order Number",

"SalesOrderReference": "Sales Order Reference (Optional)",

"ScheduledShipDate": "Scheduled Ship Date (Optional)",

"ShipmentTerms": "Shipment Terms (Optional)",

"SpecialInstructions": "Special Instructions (Optional)",

"UltimateDestination": "Ultimate Destination (Optional)" },

"SalesOrderHeader": {"DCCode": "DC Code (Optional)"},

"ShipToCompany": {

"BranchCode": "Branch Code (Optional)",

"CompanyCategory": "Company Category (Optional)",

"CompanyCode": "Company Code",

"CompanyDescription": "Company Description",

"LookupDeliveryAddress": "Lookup Delivery Address (Optional)"

} }}

RESULT

{"Response": {

"CallStatus": {

"Code": 0,

"Message": {},

"Success": true

},

"GUID": "3ea9eb61-7f49-4c03-986a-9340da72c6d4" }}

7.5.2. /websubmit – Submit Web Order

This call can be called to create new Web sales orders. The products within the order must have sufficient available stock for the order to be created. (WCF 3.18)

Call	Submit Web Sales Order using XML (POST)
URL	https://hubuat1.supplystream.com/hub/api/salesorders/v1/websubmit?token= <token> or https://hubuat1.supplystream.com/hub/api/salesorders/v1/websubmit.xml?to ken=<token>
SAMPLE BODY	https://hubuat1.supplystream.com/hub/api/salesorders/v1/websample.xml?to ken=<token>
BODY	<Request> <WebSalesOrder> <Notes>Notes (Optional)</Notes> <SpecialInstructions>Special Instructions (Optional)</SpecialInstructions> <ScheduledShipDate>Scheduled Ship Date (Optional)</ScheduledShipDate> <ShipmentTerms>Shipment Terms (Optional)</ShipmentTerms> <DoNotPushToDC>Do Not Push To DC (Optional)</DoNotPushToDC> <SalesOrderNumber>Sales Order Number </SalesOrderNumber> <SalesOrderReference>Sales Order Reference (Optional)</SalesOrderReference> <UltimateDestination>Ultimate Destination (Optional)</UltimateDestination> <CourierName>Courier Name (Optional)</CourierName> <CourierService>Courier Service (Optional)</CourierService> <NotificationMethod>Notification Method (Optional)</NotificationMethod> <GUID>GUID (Optional)</GUID> <SalesOrderDate>Sales Order Date (Optional)</SalesOrderDate> </WebSalesOrder> <DeliveryDetails> <ContactCode>Contact Code (Optional)</ContactCode> <Title>Title (Optional)</Title> <FirstName>First Name (Optional)</FirstName> <LastName>Last Name (Optional)</LastName> <City>City </City> <County>County (Optional)</County> <Line1>Line 1 </Line1> <Line2>Line 2 (Optional)</Line2> <Line3>Line 3 (Optional)</Line3> <Line4>Line 4 (Optional)</Line4> <PostcodeZip>Postcode Zip </PostcodeZip> <CountryCode>Country Code </CountryCode> <PhoneNumber>Phone Number (Optional)</PhoneNumber>
	<EmailAddress>Email Address (Optional)</EmailAddress> </DeliveryDetails> <BillingDetails> <ContactCode>Contact Code (Optional)</ContactCode> <Title>Title (Optional)</Title> <FirstName>First Name (Optional)</FirstName> <LastName>Last Name (Optional)</LastName> <City>City (Optional)</City> <County>County (Optional)</County> <Line2>Line 2 (Optional)</Line2> <Line4>Line 4 (Optional)</Line4> <Line1>Line 1 (Optional)</Line1> <Line3>Line 3 (Optional)</Line3> <PostcodeZip>Postcode Zip (Optional)</PostcodeZip> <CountryCode>Country Code (Optional)</CountryCode> <PhoneNumber>Phone Number (Optional)</PhoneNumber> <EmailAddress>Email Address (Optional)</EmailAddress> </BillingDetails> <ForwardingAgent> <CompanyCode>Company Code (Optional)</CompanyCode> <CompanyDescription>Company Description (Optional)</CompanyDescription> <ContactCode>Contact Code (Optional)</ContactCode> <Title>Title (Optional)</Title> <FirstName>First Name (Optional)</FirstName> <LastName>Last Name (Optional)</LastName> <City>City (Optional)</City> <County>County (Optional)</County> <Line2>Line 2 (Optional)</Line2> <Line4>Line 4 (Optional)</Line4> <Line1>Line 1 (Optional)</Line1> <Line3>Line 3 (Optional)</Line3> <PostcodeZip>Postcode Zip (Optional)</PostcodeZip> <CountryCode>Country Code (Optional)</CountryCode> <PhoneNumber>Phone Number (Optional)</PhoneNumber> <EmailAddress>Email Address (Optional)</EmailAddress> </ForwardingAgent> <SalesOrderHeader> <DCCode>DC Code (Optional)</DCCode> </SalesOrderHeader> <List> <SalesOrderLineItem> <LineNumber>Line Number </LineNumber> <Quantity>Quantity </Quantity> <ExternalDocumentNo>External Document No(Optional)</ExternalDocumentNo> <UnitPrice>Unit Price (Optional)</UnitPrice> <VAT>VAT (Optional)</VAT> <GUID>GUID (Optional)</GUID> <ProductCode>Product Code (Optional)</ProductCode> <EAN>EAN (Optional)</EAN> <CurrencyCode>Currency Code (Optional)</CurrencyCode> <CountryCode>Country Code (Optional)</CountryCode> </SalesOrderLineItem> <SalesOrderLineItem> -- Repeat SalesOrderLineItem as many times as needed </SalesOrderLineItem> </List> </Request>
RESULT	<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <CallStatus> <Success>true</Success> <Code>0</Code> <Message/> </CallStatus> </Response>

Call	Submit Web Sales Order using JSON (POST)
URL	https://hubuat1.supplystream.com/hub/api/salesorders/v1/websubmit.json?t oken=<token>
SAMPLE	https://hubuat1.supplystream.com/hub/api/salesorders/v1/websample.json?t

BODY	oken=<token>
BODY	{"Request": { "BillingDetails": { "City": "City (Optional)", "ContactCode": "Contact Code (Optional)", "CountryCode": "Country Code (Optional)", "County": "County (Optional)", "EmailAddress": "Email Address (Optional)", "FirstName": "First Name (Optional)", "LastName": "Last Name (Optional)", "Line1": "Line 1 (Optional)", "Line2": "Line 2 (Optional)", "Line3": "Line 3 (Optional)", "Line4": "Line 4 (Optional)", "PhoneNumber": "Phone Number (Optional)", "PostcodeZip": "Postcode Zip (Optional)", "Title": "Title (Optional)" }, "DeliveryDetails": { "City": "City", "ContactCode": "Contact Code (Optional)", "CountryCode": "Country Code", "County": "County (Optional)", "EmailAddress": "Email Address (Optional)", "FirstName": "First Name (Optional)", "LastName": "Last Name (Optional)", "Line1": "Line 1", "Line2": "Line 2 (Optional)", "Line3": "Line 3 (Optional)", "Line4": "Line 4 (Optional)", "PhoneNumber": "Phone Number (Optional)", "PostcodeZip": "Postcode Zip", "Title": "Title (Optional)" }, "ForwardingAgent": { "City": "City (Optional)", "CompanyCode": "Company Code (Optional)", "CompanyDescription": "Company Description (Optional)", "ContactCode": "Contact Code (Optional)", "CountryCode": "Country Code (Optional)", "County": "County (Optional)", "EmailAddress": "Email Address (Optional)", "FirstName": "First Name (Optional)", "LastName": "Last Name (Optional)", "Line1": "Line 1 (Optional)", "Line2": "Line 2 (Optional)", "Line3": "Line 3 (Optional)", "Line4": "Line 4 (Optional)", "PhoneNumber": "Phone Number (Optional)", "PostcodeZip": "Postcode Zip (Optional)", "Title": "Title (Optional)" }, "List": {"SalesOrderLineItem": [ { "CountryCode": "Country Code (Optional)", "CurrencyCode": "Currency Code (Optional)", "EAN": "EAN (Optional)", "ExternalDocumentNo": "External Document No (Optional)", "GUID": "GUID (Optional)", "LineNumber": "Line Number", "ProductCode": "Product Code (Optional)", "Quantity": "Quantity", "UnitPrice": "Unit Price (Optional)", "VAT": "VAT (Optional)" }, { "CountryCode": "Country Code (Optional)", "CurrencyCode": "Currency Code (Optional)", "EAN": "EAN (Optional)", "ExternalDocumentNo": "External Document No (Optional)", "GUID": "GUID (Optional)", "LineNumber": "Line Number", "ProductCode": "Product Code (Optional)", "Quantity": "Quantity", "UnitPrice": "Unit Price (Optional)",
	"VAT": "VAT (Optional)" }, { "CountryCode": "Country Code (Optional)", "CurrencyCode": "Currency Code (Optional)", "EAN": "EAN (Optional)", "ExternalDocumentNo": "External Document No (Optional)", "GUID": "GUID (Optional)", "LineNumber": "Line Number", "ProductCode": "Product Code (Optional)", "Quantity": "Quantity", "UnitPrice": "Unit Price (Optional)", "VAT": "VAT (Optional)" } ]}, "SalesOrderHeader": {"DCCode": "DC Code (Optional)"}, "WebSalesOrder": { "CourierName": "Courier Name (Optional)", "CourierService": "Courier Service (Optional)", "DoNotPushToDC": "Do Not Push To DC (Optional)", "GUID": "GUID (Optional)", "Notes": "Notes (Optional)", "NotificationMethod": "Notification Method (Optional)", "SalesOrderDate": "Sales Order Date (Optional)", "SalesOrderNumber": "Sales Order Number", "SalesOrderReference": "Sales Order Reference (Optional)", "ScheduledShipDate": "Scheduled Ship Date (Optional)", "ShipmentTerms": "Shipment Terms (Optional)", "SpecialInstructions": "Special Instructions (Optional)", "UltimateDestination": "Ultimate Destination (Optional)" } }}
RESULT	{"Response": { "CallStatus": { "Code": 0, "Message": {}, "Success": true }, "GUID": "2bb64d28-ff38-49bf-a055-1372d83739cf" }}

7.5.3. /cancel/reasoncode – Cancel a sales order with a reason code

This call can be used to cancel an order. Please note once an order has a status of “To Dispatch” it cannot be cancelled (WCF 3.12).

Call

Cancel the Sales Order with Reason Code (POST)

Note: The GUID generated by the Integration Hub (or provided using the GUID parameter) is used to identify the order.

URL

https://hubuat1.supplystream.com/hub/api/salesorders/v1/<guid>/ cancel/reasoncode/001.json?&token=<token>

Available Reason Codes:

001 - Customer Request
002 - Order Delayed
003 - Duplicate
004 - Item not available
005 - Cannot ship to address
006 - Other

RESULT

7.5.4. /releasefromhold – Release the Sales Order from Hold

This method can be used to release an order from hold when the fraud check was successful (WCF 2.1).

Call	Release the Sales Order from Hold (POST)
URL	https://hubuat1.supplystream.com/hub/api/salesorders/v1/<salesOrderNumbe r>/ releasefromhold.json?&token=<token>
RESULT

7.5.5. /cancelfromhold

This call can be used to cancel an order when the fraud check fails (WCF 2.2).

Call	Cancel the Sales Order from Hold (POST)
URL	https://hubuat1.supplystream.com/hub/api/salesorders/v1/< salesOrderNumber>/ cancelfromhold.json?&token=<token>
RESULT

7.5.6. /status – Check status of order

This call can be used to check the current status of the sales order. The status can be: To Be Picked, Being Picked, Pick Complete, To Dispatch, Dispatched, and Cancelled (WCF 3.7).

Call

Check the status of an order (GET)

Note: The GUID generated by the Integration Hub (or provided using the GUID parameter) is used to identify the order.

URL

https://hubuat1.supplystream.com/hub/api/salesorders/v1/<guid>/status.js on?&token=<token>

RESULT

</CallStatus>

<Status>To Be Picked</Status>

The available statuses are:

To Be Picked
Being Picked
Pick Complete
To Dispatch
Dispatched
Cancelled

7.5.7. /tracking – Check tracking details of a sales order

This call can be used to get the courier and tracking number for a sales order (WCF 3.8).

Call

Check the tracking status of an order (GET)

Note: The GUID generated by the Integration Hub (or provided using the GUID parameter) is used to identify the order.

URL

https://hubuat1.supplystream.com/hub/api/salesorders/v1/<guid>/tracking.

json?&token=<token>

RESULT

{"Response": {

"CallStatus": {

"Code": 0,

"Message": {},

"Success": true

},

"Courier": "DHL",

"GUID": "468DF821564618DD7113734544443021",

"TrackingNumber": "12345699000838L" }}

7.6. Stock – stock/v1

This service is to check that stock quantities in the system.

HTTP Method	Parameters	Description	X M L	J S O N	C S V	HT M L
POST	/submit/adjustments	Loads stock adjustments	Y	Y	N	N
GET	/all	Returns all product stock levels in all DC’s	Y	Y	Y	Y
GET	/product/{product} or /product/{product}?cod e={code}&location={loc ation}	Returns stock levels for the product with code {product} These services also accept the following optional query parameters: code – type of product code supplied: productcode (the default) ean If identified using EAN location – By default all location types are returned. This can be restricted by setting this to one of: o Web+Stock o Available+Stock o Cross+Dock	Y	Y	Y	Y
GET	/dc/{dc}	Returns stock levels for the DC with code {dc}	Y	Y	Y	Y
GET	/dc/{dc}/product/{prod uct} or /dc/{dc}/product/{prod uct}?code={code}&locat ion={location}	Returns stock levels for the product with code {product} in DC with code {dc} code – type of product code supplied: productcode (the default) ean If identified using EAN location – By default all location types are returned. This can be restricted by setting this to one of: o Web+Stock o Available+Stock o Cross+Dock	Y	Y	Y	Y
GET	/adjustments/{fromDate }/{toDate}?dc={dc}	Get stock adjustments for range {fromDate} to {toDate} Note: The parameters {fromDate} and {toDate} are timestamps and must be supplied in ISO 8601 format. e.g. 2013-10-31T00:00:00 Optionally the DC can be specified if more than one DC exists	Y	Y	Y	Y
GET	/movements/{fromDate}/ {toDate}?dc={dc}	Returns stock adjustments for range {fromDate} to {toDate} Optionally the DC can be specified if more than one DC exists	Y	Y	Y	Y

7.6.1. /submit/adjustment – Load Stock Adjustments

This call can be used to create stock adjustments for Cartons within the DC (WCF

4.1)

Call	Submit Stock Adjustment using XML (POST)
URL	https://hubuat1.supplystream.com/hub/api/stock/v1/submit/adjustment?toke n=<token>
SAMPLE BODY	https://hubuat1.supplystream.com/hub/api/stock/v1/adjustmentsample?token =<token>
BODY	<?xml version="1.0" encoding="UTF-8" standalone="no"?> <Request> <StockAdjustment> <StockAdjustmentType>Stock Adjustment Type </StockAdjustmentType> <StockAdjustmentId>Stock Adjustment Id (Optional)</StockAdjustmentId> <GUID>GUID (Optional)</GUID> </StockAdjustment> <List> <StockAdjustmentLineItem> <LineNumber>Line Number </LineNumber> <Quantity>Quantity </Quantity> <CartonNumber>Carton Number </CartonNumber> <ReasonCode>Reason Code (Optional)</ReasonCode> <GUID>GUID (Optional)</GUID> </StockAdjustmentLineItem> <StockAdjustmentLineItem> <LineNumber>Line Number </LineNumber> <Quantity>Quantity </Quantity> <CartonNumber>Carton Number </CartonNumber> <ReasonCode>Reason Code (Optional)</ReasonCode> <GUID>GUID (Optional)</GUID> </StockAdjustmentLineItem> <StockAdjustmentLineItem> <LineNumber>Line Number </LineNumber> <Quantity>Quantity </Quantity> <CartonNumber>Carton Number </CartonNumber> <ReasonCode>Reason Code (Optional)</ReasonCode> <GUID>GUID (Optional)</GUID> </StockAdjustmentLineItem> </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	Submit Stock Adjustment using JSON (POST)
URL	https://hubuat1.supplystream.com/hub/api/stock/v1/submit/adjustment.json ?token=<token>
SAMPLE BODY	https://hubuat1.supplystream.com/hub/api/stock/v1/adjustmentsample.json? token=<token>
BODY	{ "Request": { "List": { "StockAdjustmentLineItem": [ { "CartonNumber": "Carton Number", "GUID": "GUID (Optional)", "LineNumber": "Line Number", "Quantity": "Quantity", "ReasonCode": "Reason Code (Optional)" },
	{ "CartonNumber": "Carton Number", "GUID": "GUID (Optional)", "LineNumber": "Line Number", "Quantity": "Quantity", "ReasonCode": "Reason Code (Optional)" }, { "CartonNumber": "Carton Number", "GUID": "GUID (Optional)", "LineNumber": "Line Number", "Quantity": "Quantity", "ReasonCode": "Reason Code (Optional)" } ] }, "StockAdjustment": { "GUID": "GUID (Optional)", "StockAdjustmentId": "Stock Adjustment Id (Optional)", "StockAdjustmentType": "Stock Adjustment Type" } } }
RESULT	{"Response": { "CallStatus": { "Code": 0, "Message": {}, "Success": true }, "GUID": "2bb64d28-ff38-49bf-a055-1372d83739cf" }}

7.6.2. /all - Retrieve All Stock

This call can be used to check all your products and how much stock is available for each product (WCF 3.11).

Call	Return all stock in html format (GET)
URL	https://hubuat1.supplystream.com/hub/api/stock/v1/all.html?token=<token>
RESULT

Call	Return all stock in XML format (GET)
URL	https://hubuat1.supplystream.com/hub/api/stock/v1/all?token=<token> or https://hubuat1.supplystream.com/hub/api/stock/v1/all.xml?token=<token>
RESULT

Call	Return all stock in JSON format (GET)
URL	https://hubuat1.supplystream.com/hub/api/stock/v1/all.json?token=<token>
RESULT

Call	Return all stock in CSV format (GET)
URL	https://hubuat1.supplystream.com/hub/api/stock/v1/all.csv?token=<token>
RESULT

7.6.3. /dc – Retrieve Stock for a specific Distribution Centre

This call can be used to check all your products and how much stock is available for each product per DC. (WCF 3.15)

Call

Return stock for DC CRLAN001 in JSON format (GET)

This call can be used to check all your products and how much stock is available for each product per DC.

URL

https://hubuat1.supplystream.com/hub/api/stock/v1/dc/CRLAN001.json?token =<token>

RESULT

7.6.4. /product – Retrieve stock for a specific product

This method can be used to check the available stock for a product. You can pass in a single product or a collection of products. (WCF 3.9)

Call	Return stock for product 100083 in JSON format (GET)
URL	https://hubuat1.supplystream.com/hub/api/stock/v1/product/100083.json?to ken=<token>
RESULT

Call	Return stock for EAN 1234567890123 where in JSON format (GET)
URL	https://hubuat1.supplystream.com/hub/api/stock/v1/product/1234567890123. json?code=ean&token=<token>
RESULT	{ "Response": { "CallStatus": { "Code": 0, "Message": {}, "Success": true }, "List": { "StockQuantityLineItem": { "DCCode": {},
	"EAN": 1234567890123, "FreeQuantity": 0, "LocationType": "Available Stock", "ProductCode": {} } } } }

Call

Return stock for EAN 1234567890123 and LocationType “Available Stock” where in JSON format (GET)

URL

https://hubuat1.supplystream.com/hub/api/stock/v1/product/1234567890123. json?location=Available+Stock&token=<token>

Location:

Web+Stock
Available+Stock
Cross+Dock

RESULT

{

"Response": {

"CallStatus": {

"Code": 0,

"Message": {},

"Success": true

},

"List": {

"StockQuantityLineItem": {

"DCCode": {},

"EAN": 1234567890123,

"FreeQuantity": 0,

"LocationType": "Available Stock",

"ProductCode": {}

}

} }

7.6.5. /adjustment – Retrieve stock adjustments

This call can be used to export stock adjustment information based on a date range. The type of adjustment (Increase or Decrease) will be returned as well as all the line items with the product code and quantity adjusted (WCF 5.5)

Call

Return stock adjustments for time range 1^st October to 2013to 10th October 2013 in XML format (GET)

URL

https://hubuat1.supplystream.com/hub/api/stock/v1/adjustment/2013-1001T00:00:00Z/2013-10-10T00:00:00Z.xml?token=<token>

RESULT

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Success>false</Success>

<Message>No results found for search criteria</Message>

</CallStatus>

</Response>

Call

Return stock adjustments for time range 1^st October to 2013to 10th October 2013 where the Data Centre is “DCCL01 in XML format (GET)

URL

https://hubuat1.supplystream.com/hub/api/stock/v1/adjustment/2013-1001T00:00:00Z/2013-10-10T00:00:00Z.xml?dc=DCCL01&token=<token>

RESULT

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Success>false</Success>

<Message>No results found for search criteria</Message>

</CallStatus>

</Response>

7.6.6. /movements – Retrieve stock movements

This call can be used to export stock movement information based on a date range (WCF 5.6)

Call

Return stock movements for time range 1^st October to 2013to 10th October 2013 in JSON format (GET)

URL

https://hubuat1.supplystream.com/hub/api/stock/v1/movement/2013-1001T00:00:00Z/2013-10-10T00:00:00Z.json?token=<token>

RESULT

{

"status": {

"message": "No results found for search criteria",

"code": 100,

"success": false

} }

Call

Return stock movements for time range 1^st October to 2013to 10th October 2013 where the Data Centre is “DCCL01 in JSON format (GET)

URL

https://hubuat1.supplystream.com/hub/api/stock/v1/movement/2013-1001T00:00:00Z/2013-10-10T00:00:00Z.json?dc=DCCL01&token=<token>

RESULT

{

"status": {

"message": "No results found for search criteria",

"code": 100,

"success": false

} }

7.7. Dispatches – dispatches/v1

This service is to check order dispatches.

HTTP

Method

Parameters

Description

X

M

L

J

S

O

N

C

S

V

H

T

M

L

GET

/{id}

Returns details of a dispatched order with supplied id

Y

GET

/status/{from}/{to}

Returns dispatch status for all orders within the given range.

This service also accepts the following query parameters:

dc – This identifies the specific DC to query
status – Specific dispatch status that you are interested in. This parameter can be repeated multiple times to check for multiple statuses. Valid values are:

o To+Be+Picked o Being+Picked o Pick+Complete o To+Dispatch o Dispatched o Cancelled

The parameters {from} and {to} are timestamps and must be supplied in ISO 8601 format e.g. 2013-10-31T00:00:00Z

Y

7.7.1. Dispatches- Retrieve specific sales order id

This call can be used to export dispatch information relating to the sales order you created. The current dispatch status, courier name, courier reference, being picked date, to be packed date, to dispatch date and dispatch date will be returned as well as all the line items with the dispatch quantity. (WCF 5.2)

Call	Retrieve details of a Dispatched Sales Order (GET) Note: The GUID generated by the Integration Hub (or provided using the GUID parameter) is used to identify the order.
URL	https://hubuat1.supplystream.com/hub/api/dispatches/v1/<guid>.json?&toke n=<token>
RESULT	{"Response": { "BeingPickedDate": "2013-07-10T12:44:26+01:00", "CallStatus": { "Code": 0, "Message": {}, "Success": true }, "CourierName": "DPD", "CourierRef": "15501999000838L", "CurrentStatus": "Dispatched", "DispatchDate": "2013-07-10T13:07:18+01:00", "GUID": "468DF821564618DD7113734544443021", "List": {"DispatchLineItem": { "DispatchQuantity": 1,
	"GUID": "468DF821564618DD7113734544443022", "LineItemNumber": 1 }}, "ToBePackedDate": "2013-07-10T12:45:27+01:00", "ToDispatchDate": "2013-07-10T12:56:00+01:00" }}

7.7.2. Dispatches - Retrieve status of order between dates, DC and dispatch statuses

This call can be used to export dispatch status changes based on a date range. If the Dispatch status was changed between the start and end dates it will be returned. If statuses are provided then it will only return the dispatch if that status change occurred between the start and end dates specified (WCF 5.4).

Call

Retrieve Dispatch Status changed for time range 1^st October to 2013to 10th October 2013 in XML format (GET)

URL

https://hubuat1.supplystream.com/hub/api/dispatches/v1/status/2013-10-

01T00:00:00Z/2013-10-10T00:00:00Z.html?token=<token>

RESULT

Call	Retrieve Changed Dispatch Status for time range 1^st October to 2013to 10th October 2013 in XML format where Order has been ‘Dispatched’ (GET)
URL	https://hubuat1.supplystream.com/hub/api/dispatches/v1/status/2013-1001T00:00:00Z/2013-10-10T00:00:00Z.xml?status=Dispatched&token=<token> or include a DC if more than one DC associated https://hubuat1.supplystream.com/hub/api/dispatches/v1/status/2013-10- 01T00:00:00Z/2013-10- 10T00:00:00Z.xml?dc=CRLAN001&status=Dispatched&token=<token>
RESULT	<Response> <CallStatus> <Success>true</Success> <Code>0</Code> <Message/> </CallStatus> <List> <DispatchLineItem> <GUID>688ba235-d6be-48bf-b583-8c035edcb8e5</GUID> <DCCode>DCCL01</DCCode> </DispatchLineItem> <DispatchLineItem> <GUID>4d57d16f-3273-408b-90b2-1f4222141471</GUID> <DCCode>DCCL01</DCCode> </DispatchLineItem> <DispatchLineItem> <GUID>872a6c63-5263-42dd-a671-eb82421afd3a</GUID> <DCCode>DCCL01</DCCode> </DispatchLineItem> </List>
	</Response>

Call

Retrieve Changed Dispatch Status for time range 1^st October to

2013to 10th October 2013 in JSON format where Order has been ‘Dispatched’ or ‘Being Picked’ (GET)

URL

https://hubuat1.supplystream.com/hub/api/dispatches/v1/status/2013-1001T00:00:00Z/2013-10-

10T00:00:00Z.json?status=Dispatched&status=Being+Picked&token=<token> or include a DC if more than one DC associated

https://hubuat1.supplystream.com/hub/api/dispatches/v1/status/2013-10-

01T00:00:00Z/2013-10-

10T00:00:00Z.json?dc=CRLAN001&status=Dispatched&status=Being+Picked&toke n=<token>

RESULT

{"Response": {

"CallStatus": {

"Code": 0,

"Message": {},

"Success": true

},

"List": {"DispatchLineItem": [

{

"DCCode": "DCCL01",

"GUID": "9eb9662e-79b5-43c9-af2c-4068237a2bc7"

},

{

"DCCode": "DCCL01",

"GUID": "929eb178-8844-4c10-bd7b-139083d750e2"

},

{

"DCCode": "DCCL01",

"GUID": "77e60e4c-95ea-4842-b245-5ce147bc411a"

},

{

"DCCode": "DCCL01",

"GUID": "15b55632-b2f4-42b0-b840-5b29d48a4ef2"

},

{

"DCCode": "DCCL01",

"GUID": "a2523663-dfe2-45f9-8383-b04c64246445"

},

{

"DCCode": "DCCL01",

"GUID": "f269cbf9-b2c8-4b6c-85e4-1e21eb833a47"

} ]} }}

7.8. GRN – GRN/v1

HTTP

Method

Parameters

Description

X

M

L

J

S

O

N

C

S

V

HT

M

L

GET

/{guid}

Get GRN details

Y

GET

/{fromDate}/{toDate}? dc={dc}&type={type}

Get GRNs for date range

The parameters {startDate} and {endDate} are timestamps and must be supplied in ISO 8601 format

e.g. 2013-10-31T00:00:00Z option: {dc} if more than one DC option: {type} type = All / Standard / Return

Y

7.8.1. Retrieve GRN details

This call can be used to export GRN information relating to the receipt you created. The current GRN status, arrived date, receiving start date and confirmed date will be returned as well as all the line items with the GRN quantity (WCF 5.1).

Call

Retrieve GRN details in JSON format (GET)

URL

https://hubuat1.supplystream.com/hub/api/grns/v1/730483d1-de0e-440aa6f8-1885d84eec35.json?token=<token>

RESULT

{"Response": {

"CallStatus": {

"Code": 0,

"Message": {},

"Success": true

},

"List": {"GRNResponseItem": {

"ArrivalTimestamp": "2013-08-07T11:04:00Z",

"ConfirmedTimestamp": "2013-08-16T09:28:57Z",

"CurrentStatus": "Confirmed",

"DCCode": {},

"GRNQuantity": 10,

"GRNType": {},

"GUID": "fa262243-019e-46e9-aa1a-5c7e56b4655c",

"HBRef": {},

"InternalId": {},

"LineInternalId": {},

"LineItemGUID": "9f112a6f-7a41-4d90-890c-05aa68d3079f",

"LineItemNumber": 1,

"ProductCode": {},

"ReceivingStartTimestamp": "2013-08-16T09:23:38Z"

}} }}

7.8.2. Retrieve GRN for specific date range, DC and optional Type

This call can be used to export GRN information based on a date range. The current GRN status, arrived date, receiving start date and confirmed date will be returned as well as all the line items with the GRN quantity. (WCF 5.3)

Call

Retrieve GRNs from 1st October 2013 to 1st November 2013 in JSON format (GET)

URL

https://hubuat1.supplystream.com/hub/api/grns/v1/2013-1001T00:00:00Z/2013-11-01T00:00:00Z.json?token=<token>

RESULT

{"Response": {

"CallStatus": {

"Code": 0,

"Message": {},

"Success": true

},

"List": {"GRNResponseItem": {

"ArrivalTimestamp": "2013-10-25T16:09:55Z",

"ConfirmedTimestamp": "2013-10-25T16:15:59Z",

"CurrentStatus": "Confirmed",

"DCCode": "DCCL01",

"GRNQuantity": 10,

"GRNType": "STANDARD",

"GUID": "730483d1-de0e-440a-a6f8-1885d84eec35",

"HBRef": 12345,

"InternalId": "13FA3CD2-863D-E311-A770-000C29DA324D",

"LineInternalId": "17FA3CD2-863D-E311-A770-000C29DA324D",

"LineItemGUID": "86b81421-33be-469f-a048-3b27291d2bb4",

"LineItemNumber": 1,

"ProductCode": 100083,

"ReceivingStartTimestamp": "2013-10-25T16:11:30Z"

}} }}

Call

Retrieve GRNs from 1st October 2013 to 1st November 2013 in JSON format (GET)

URL

https://hubuat1.supplystream.com/hub/api/grns/v1/2013-10-

01T00:00:00Z/2013-11-01T00:00:00Z.json?dc=CRLAN001&type=Standard& token=<token>

Optionally the DC and/or the type can be specified.

Available types are All / Standard / Return

RESULT

{"Response": {

"CallStatus": {

"Code": 0,

"Message": {},

"Success": true

},

"List": {"GRNResponseItem": {

"ArrivalTimestamp": "2013-10-25T16:09:55Z",

"ConfirmedTimestamp": "2013-10-25T16:15:59Z",

"CurrentStatus": "Confirmed",

"DCCode": "DCCL01",

"GRNQuantity": 10,

"GRNType": "STANDARD",

"GUID": "730483d1-de0e-440a-a6f8-1885d84eec35",

"HBRef": 12345,

"InternalId": "13FA3CD2-863D-E311-A770-000C29DA324D",

"LineInternalId": "17FA3CD2-863D-E311-A770-000C29DA324D",

"LineItemGUID": "86b81421-33be-469f-a048-3b27291d2bb4",

"LineItemNumber": 1,

"ProductCode": 100083,

"ReceivingStartTimestamp": "2013-10-25T16:11:30Z"

}} }}

7.9. Purchase Orders – purchaseorders/v1

HTTP

Method

Parameters

Description

X

M

L

J

S

O

N

C

S

V

HT

M

L

POST

/submit

Load purchase orders

Y

N

7.9.1. Load Purchase Order

This call creates a new purchase order. (WCF 3.16)

Call	Load Purchase Orders in XML format (POST)
URL	https://hubuat1.supplystream.com/hub/api/purchaseorders/v1/submit?token= <token>
SAMPLE BODY	https://hubuat1.supplystream.com/hub/api/purchaseorders/v1/sample?token= <token>
BODY	<?xml version="1.0" encoding="UTF-8" standalone="no"?> <Request> <PurchaseOrder> <ExDate>Ex Date </ExDate> <Notes>Notes (Optional)</Notes> <SpecialInstructions>Special Instructions (Optional)</SpecialInstructions> <PaymentTerms>Payment Terms (Optional)</PaymentTerms> <ROSDate>ROS Date (Optional)</ROSDate> <ShippingTerms>Shipping Terms (Optional)</ShippingTerms> <Mode>Mode (Optional)</Mode> <PurchaseOrderNumber>Purchase Order Number </PurchaseOrderNumber> <PurchaseOrderDate>Purchase Order Date (Optional)</PurchaseOrderDate> <GUID>GUID (Optional)</GUID> </PurchaseOrder> <Supplier> <CompanyCode>Company Code </CompanyCode> <CompanyDescription>Company Description (Optional)</CompanyDescription> <ContactCode>Contact Code (Optional)</ContactCode> <FirstName>First Name (Optional)</FirstName> <LastName>Last Name (Optional)</LastName> <Title>Title (Optional)</Title> <City>City (Optional)</City> <County>County (Optional)</County> <Line2>Line 2 (Optional)</Line2> <Line3>Line 3 (Optional)</Line3> <Line1>Line 1 (Optional)</Line1> <PostcodeZip>Postcode Zip (Optional)</PostcodeZip> <Line4>Line 4 (Optional)</Line4> <PhoneNumber>Phone Number (Optional)</PhoneNumber> <EmailAddress>Email Address (Optional)</EmailAddress> </Supplier> <ShipToCompany> <BranchCode>Branch Code (Optional)</BranchCode> <CompanyCategory>Company Category (Optional)</CompanyCategory> <CompanyCode>Company Code </CompanyCode> <CompanyDescription>Company Description (Optional)</CompanyDescription> <ContactCode>Contact Code (Optional)</ContactCode> <FirstName>First Name (Optional)</FirstName> <LastName>Last Name (Optional)</LastName> <Title>Title (Optional)</Title> <City>City (Optional)</City> <County>County (Optional)</County> <Line2>Line 2 (Optional)</Line2> <Line3>Line 3 (Optional)</Line3> <Line1>Line 1 (Optional)</Line1> <PostcodeZip>Postcode Zip (Optional)</PostcodeZip> <Line4>Line 4 (Optional)</Line4> <PhoneNumber>Phone Number (Optional)</PhoneNumber> <EmailAddress>Email Address (Optional)</EmailAddress> </ShipToCompany>
	<LocalAgent> <CompanyCode>Company Code (Optional)</CompanyCode> <CompanyDescription>Company Description (Optional)</CompanyDescription> </LocalAgent> <Currency> <CurrencyCode>Currency Code (Optional)</CurrencyCode> </Currency> <List> <PurchaseOrderLineItem> <LineNumber>Line Number </LineNumber> <ExDate>Ex Date (Optional)</ExDate> <ROSDate>ROS Date (Optional)</ROSDate> <Quantity>Quantity </Quantity> <Mode>Mode (Optional)</Mode> <GUID>GUID (Optional)</GUID> <EAN>EAN (Optional)</EAN> <ProductCode>Product Code (Optional)</ProductCode> <CompanyCode>Company Code (Optional)</CompanyCode> <CompanyDescription>Company Description (Optional)</CompanyDescription> </PurchaseOrderLineItem> <PurchaseOrderLineItem> <LineNumber>Line Number </LineNumber> <ExDate>Ex Date (Optional)</ExDate> <ROSDate>ROS Date (Optional)</ROSDate> <Quantity>Quantity </Quantity> <Mode>Mode (Optional)</Mode> <GUID>GUID (Optional)</GUID> <EAN>EAN (Optional)</EAN> <ProductCode>Product Code (Optional)</ProductCode> <CompanyCode>Company Code (Optional)</CompanyCode> <CompanyDescription>Company Description (Optional)</CompanyDescription> </PurchaseOrderLineItem> <PurchaseOrderLineItem> <LineNumber>Line Number </LineNumber> <ExDate>Ex Date (Optional)</ExDate> <ROSDate>ROS Date (Optional)</ROSDate> <Quantity>Quantity </Quantity> <Mode>Mode (Optional)</Mode> <GUID>GUID (Optional)</GUID> <EAN>EAN (Optional)</EAN> <ProductCode>Product Code (Optional)</ProductCode> <CompanyCode>Company Code (Optional)</CompanyCode> <CompanyDescription>Company Description (Optional)</CompanyDescription> </PurchaseOrderLineItem> </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 Purchase Orders in JSON format (POST)
URL	https://hubuat1.supplystream.com/hub/api/purchaseorders/v1/submit.json?t oken=<token>
SAMPLE BODY	https://hubuat1.supplystream.com/hub/api/purchaseorders/v1/sample.json?t oken=<token>
BODY	{ "Request": { "Currency": { "CurrencyCode": "Currency Code (Optional)" }, "List": { "PurchaseOrderLineItem": [

{

"CompanyCode": "Company Code (Optional)",

"CompanyDescription": "Company Description (Optional)",

"EAN": "EAN (Optional)",

"ExDate": "Ex Date (Optional)",

"GUID": "GUID (Optional)",

"LineNumber": "Line Number",

"Mode": "Mode (Optional)",

"ProductCode": "Product Code (Optional)",

"Quantity": "Quantity",

"ROSDate": "ROS Date (Optional)"

},

{

"CompanyCode": "Company Code (Optional)",

"CompanyDescription": "Company Description (Optional)",

"EAN": "EAN (Optional)",

"ExDate": "Ex Date (Optional)",

"GUID": "GUID (Optional)",

"LineNumber": "Line Number",

"Mode": "Mode (Optional)",

"ProductCode": "Product Code (Optional)",

"Quantity": "Quantity",

"ROSDate": "ROS Date (Optional)"

},

{

"CompanyCode": "Company Code (Optional)",

"CompanyDescription": "Company Description (Optional)",

"EAN": "EAN (Optional)",

"ExDate": "Ex Date (Optional)",

"GUID": "GUID (Optional)",

"LineNumber": "Line Number",

"Mode": "Mode (Optional)",

"ProductCode": "Product Code (Optional)",

"Quantity": "Quantity",

"ROSDate": "ROS Date (Optional)"

}

]

},

"LocalAgent": {

"CompanyCode": "Company Code (Optional)",

"CompanyDescription": "Company Description (Optional)" },

"PurchaseOrder": {

"ExDate": "Ex Date",

"GUID": "GUID (Optional)",

"Mode": "Mode (Optional)",

"Notes": "Notes (Optional)",

"PaymentTerms": "Payment Terms (Optional)",

"PurchaseOrderDate": "Purchase Order Date (Optional)",

"PurchaseOrderNumber": "Purchase Order Number",

"ROSDate": "ROS Date (Optional)",

"ShippingTerms": "Shipping Terms (Optional)",

"SpecialInstructions": "Special Instructions (Optional)" },

"ShipToCompany": {

"BranchCode": "Branch Code (Optional)",

"City": "City (Optional)",

"CompanyCategory": "Company Category (Optional)",

"CompanyCode": "Company Code",

"CompanyDescription": "Company Description (Optional)",

"ContactCode": "Contact Code (Optional)",

"County": "County (Optional)",

"EmailAddress": "Email Address (Optional)",

"FirstName": "First Name (Optional)",

"LastName": "Last Name (Optional)",

"Line1": "Line 1 (Optional)",

"Line2": "Line 2 (Optional)",

"Line3": "Line 3 (Optional)",

"Line4": "Line 4 (Optional)",

"PhoneNumber": "Phone Number (Optional)",

"PostcodeZip": "Postcode Zip (Optional)",

"Title": "Title (Optional)"

},

"Supplier": {

"City": "City (Optional)",

"CompanyCode": "Company Code",

"CompanyDescription": "Company Description (Optional)",

"ContactCode": "Contact Code (Optional)",

"County": "County (Optional)",

"EmailAddress": "Email Address (Optional)",

"FirstName": "First Name (Optional)",

"LastName": "Last Name (Optional)",

"Line1": "Line 1 (Optional)",

"Line2": "Line 2 (Optional)",

"Line3": "Line 3 (Optional)",

"Line4": "Line 4 (Optional)",

"PhoneNumber": "Phone Number (Optional)",

"PostcodeZip": "Postcode Zip (Optional)",

"Title": "Title (Optional)"

}

} }

RESULT

{"Response": {

"CallStatus": {

"Code": 0,

"Message": {},

"Success": true

},

"GUID": "3ea9eb61-7f49-4c03-986a-9340da72c6d4"

}}