API Load Web Sales Orders

HTTP
Method

/<service>/<version>/<parameters>

POST

/salesorders/v4/websubmit

Environment

Request URL

UAT

https://ihubuat.supplystream.com:8081/api/salesorders/v4/websubmit?api_key=<api_Key>

Live

https://ihub.supplystream.com:8081/api/salesorders/v4/websubmit?api_key=<api_Key>

Header

Requirement

JSON

XML

Content-Type

Required

Content-Type: application/json

Content-Type: application/xml

Accept

Optional. Returns Content-Type format if undefined

Accept: application/json

Accept: application/xml

XML Format

Body

<Request>
<WebSalesOrder>
<SalesInvoiceNumber>string</SalesInvoiceNumber>
<DocumentIdentifier>string</DocumentIdentifier>
<NIFNumber>string</NIFNumber>
<ShippingVAT>1.1</ShippingVAT>
<ShippingExVAT>1.1</ShippingExVAT>
<CustomsValueTotal>1.1</CustomsValueTotal>
<DiscountPriceTotal>1.1</DiscountPriceTotal>
<GiftWrap>true</GiftWrap>
<GiftMessage>string</GiftMessage>
<ShippingTerm>string</ShippingTerm>
<ShippingTermLocation>string</ShippingTermLocation>
<GiftMessageFrom>string</GiftMessageFrom>
<GiftMessageTo>string</GiftMessageTo>
<ShippingTotal>1.1</ShippingTotal>
<TaxTotal>1.1</TaxTotal>
<SubTotal>1.1</SubTotal>
<OrderType>string</OrderType>
<CurrencyCode>string</CurrencyCode>
<CarrierCustomerAccountNo>string</CarrierCustomerAccountNo>
<CourierName>string</CourierName>
<CourierService>string</CourierService>
<DeliveryAddressLocationType>string</DeliveryAddressLocationType>
<DoNotPushToDC>true</DoNotPushToDC>
<GUID>string</GUID>
<LocationType>string</LocationType>
<Notes>string</Notes>
<NotificationMethod>string</NotificationMethod>
<OnHold>true</OnHold>
<SalesOrderDate>1970-01-01T00:00:00.001Z</SalesOrderDate>
<SalesOrderNumber>string</SalesOrderNumber>
<SalesOrderReference>string</SalesOrderReference>
<ScheduledShipDate>1970-01-01T00:00:00.001Z</ScheduledShipDate>
<ShipmentTerms>string</ShipmentTerms>
<SpecialInstructions>string</SpecialInstructions>
<UltimateDestination>string</UltimateDestination>
</WebSalesOrder>
<SalesOrderHeader>
<DCCode>string</DCCode>
</SalesOrderHeader>
<DeliveryDetails>
<City>string</City>
<ContactCode>string</ContactCode>
<CountryCode>string</CountryCode>
<County>string</County>
<EmailAddress>string</EmailAddress>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Line1>string</Line1>
<Line2>string</Line2>
<Line3>string</Line3>
<Line4>string</Line4>
<PhoneNumber>string</PhoneNumber>
<PostcodeZip>string</PostcodeZip>
<Title>string</Title>
</DeliveryDetails>
<BillingDetails>
<City>string</City>
<ContactCode>string</ContactCode>
<CountryCode>string</CountryCode>
<County>string</County>
<EmailAddress>string</EmailAddress>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Line1>string</Line1>
<Line2>string</Line2>
<Line3>string</Line3>
<Line4>string</Line4>
<PhoneNumber>string</PhoneNumber>
<PostcodeZip>string</PostcodeZip>
<Title>string</Title>
</BillingDetails>
<ForwardingAgent>
<City>string</City>
<CompanyCode>string</CompanyCode>
<CompanyDescription>string</CompanyDescription>
<ContactCode>string</ContactCode>
<CountryCode>string</CountryCode>
<County>string</County>
<EmailAddress>string</EmailAddress>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Line1>string</Line1>
<Line2>string</Line2>
<Line3>string</Line3>
<Line4>string</Line4>
<PhoneNumber>string</PhoneNumber>
<PostcodeZip>string</PostcodeZip>
<Title>string</Title>
</ForwardingAgent>
<List>
<SalesOrderLineItem>
<UnitDiscountPrice>1.1</UnitDiscountPrice>
<OrderLineMessage>string</OrderLineMessage>
<SecondaryCurrencyCode>string</SecondaryCurrencyCode>
<SecondaryUnitPrice>1.1</SecondaryUnitPrice>
<SecondaryVAT>1.1</SecondaryVAT>
<ASNNumber>string</ASNNumber>
<CustomsValue>1.1</CustomsValue>
<Channel>string</Channel>
<CountryCode>string</CountryCode>
<CurrencyCode>string</CurrencyCode>
<EAN>string</EAN>
<ExternalDocumentNo>string</ExternalDocumentNo>
<GUID>string</GUID>
<LineNumber>1</LineNumber>
<LotNo>string</LotNo>
<ProductCode>string</ProductCode>
<Quantity>1</Quantity>
<UnitPrice>1.1</UnitPrice>
<VAT>1.1</VAT>
</SalesOrderLineItem>
</List>
</Request>

Example success Response Body

<Response>
<CallStatus>
<Success>true</Success>
<Code>0</Code>
<Message></Message>
</CallStatus>
<GUID>40b60548-2690-46f0-bcf6-7ba0c8ce92fa</GUID>
</Response>

Example failure Response Body

<Response>
<CallStatus>
<Success>false</Success>
<Code>100</Code>
<Message>Error. Invalid Mapping - DC</Message>
</CallStatus>
<GUID />
</Response>

JSON Format

Body

{
"WebSalesOrder": {
"SalesInvoiceNumber": "string",
"DocumentIdentifier": "string",
"NIFNumber": "string",
"ShippingVAT": 0,
"ShippingExVAT": 0,
"CustomsValueTotal": 0,
"DiscountPriceTotal": 0,
"GiftWrap": true,
"GiftMessage": "string",
"ShippingTerm": "string",
"ShippingTermLocation": "string",
"GiftMessageFrom": "string",
"GiftMessageTo": "string",
"ShippingTotal": 0,
"TaxTotal": 0,
"SubTotal": 0,
"OrderType": "string",
"CurrencyCode": "string",
"CarrierCustomerAccountNo": "string",
"CourierName": "string",
"CourierService": "string",
"DeliveryAddressLocationType": "string",
"DoNotPushToDC": true,
"GUID": "string",
"LocationType": "string",
"Notes": "string",
"NotificationMethod": "string",
"OnHold": true,
"SalesOrderDate": "2017-10-13T10:58:59.638Z",
"SalesOrderNumber": "string",
"SalesOrderReference": "string",
"ScheduledShipDate": "2017-10-13T10:58:59.638Z",
"ShipmentTerms": "string",
"SpecialInstructions": "string",
"UltimateDestination": "string"
},
"SalesOrderHeader": {
"DCCode": "string"
},
"DeliveryDetails": {
"City": "string",
"ContactCode": "string",
"CountryCode": "string",
"County": "string",
"EmailAddress": "string",
"FirstName": "string",
"LastName": "string",
"Line1": "string",
"Line2": "string",
"Line3": "string",
"Line4": "string",
"PhoneNumber": "string",
"PostcodeZip": "string",
"Title": "string"
},
"BillingDetails": {
"City": "string",
"ContactCode": "string",
"CountryCode": "string",
"County": "string",
"EmailAddress": "string",
"FirstName": "string",
"LastName": "string",
"Line1": "string",
"Line2": "string",
"Line3": "string",
"Line4": "string",
"PhoneNumber": "string",
"PostcodeZip": "string",
"Title": "string"
},
"ForwardingAgent": {
"City": "string",
"CompanyCode": "string",
"CompanyDescription": "string",
"ContactCode": "string",
"CountryCode": "string",
"County": "string",
"EmailAddress": "string",
"FirstName": "string",
"LastName": "string",
"Line1": "string",
"Line2": "string",
"Line3": "string",
"Line4": "string",
"PhoneNumber": "string",
"PostcodeZip": "string",
"Title": "string"
},
"List": {
"SalesOrderLineItem": [
{
"UnitDiscountPrice": 0,
"OrderLineMessage": "string",
"SecondaryCurrencyCode": "string",
"SecondaryUnitPrice": 0,
"SecondaryVAT": 0,
"ASNNumber": "string",
"CustomsValue": 0,
"Channel": "string",
"CountryCode": "string",
"CurrencyCode": "string",
"EAN": "string",
"ExternalDocumentNo": "string",
"GUID": "string",
"LineNumber": 0,
"LotNo": "string",
"ProductCode": "string",
"Quantity": 0,
"UnitPrice": 0,
"VAT": 0
}
]
}
}

Example success Response Body

{
"CallStatus": {
"Success": true,
"Code": 0,
"Message": ""
},
"GUID": "c75d6d3b-fa49-496f-9031-ea51b4d05af2"
}

Example failure Response Body

{
"CallStatus": {
"Success": false,
"Code": 100,
"Message": "Error. Invalid Mapping - DC"
},
"GUID": null
}