API Load Web Sales Orders
HTTP | /<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 |
API call formatting
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> Â Â <CourierShopID>string</CourierShopID> Â Â <PurchaseOrderNumber>string</PurchaseOrderNumber> Â Â <GroupReference>string</GroupReference> Â Â <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> Â Â <DeliveryContactIDNumber>string</DeliveryContactIDNumber> Â Â <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> Â <RetailCompliance> Â Â <Gs1Prefix>string</Gs1Prefix> Â Â <MarkForDcCode>string</MarkForDcCode> Â Â <MarkForDcName>string</MarkForDcName> Â Â <MarkForDcDept>string</MarkForDcDept> Â Â <MarkForDcLine1>string</MarkForDcLine1> Â Â <MarkForDcLine2>string</MarkForDcLine2> Â Â <MarkForDcLine3>string</MarkForDcLine3> Â Â <MarkForDcLine4>string</MarkForDcLine4> Â Â <MarkForDcCity>string</MarkForDcCity> Â Â <MarkForDcCountyState>string</MarkForDcCountyState> Â Â <MarkForDcPostCodeZip>string</MarkForDcPostCodeZip> Â Â <MarkForDcCountryCode>string</MarkForDcCountryCode> Â Â <PoDate>1970-01-01T00:00:00.001Z</PoDate> Â Â <ShipByDate>1970-01-01T00:00:00.001Z</ShipByDate> Â Â <ShipAfterDate>1970-01-01T00:00:00.001Z</ShipAfterDate> Â Â <ArriveByDate>1970-01-01T00:00:00.001Z</ArriveByDate> Â Â <CancelByDate>1970-01-01T00:00:00.001Z</CancelByDate> Â Â <SiteId>string</SiteId> Â Â <StoreId>string</StoreId> Â Â <StoreName>string</StoreName> Â Â <ShipToDcCode>string</ShipToDcCode> Â Â <ShipToDcDeptNo>string</ShipToDcDeptNo> Â </RetailCompliance> Â <List> Â Â <SalesOrderLineItem> Â Â Â <UnitDiscountPrice>1.1</UnitDiscountPrice> Â Â Â <OrderLineMessage>string</OrderLineMessage> Â Â Â <SecondaryCurrencyCode>string</SecondaryCurrencyCode> Â Â Â <SecondaryUnitPrice>1.1</SecondaryUnitPrice> Â Â Â <SecondaryVAT>1.1</SecondaryVAT> Â Â Â <StyleCode>string</StyleCode> Â Â Â <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> Â <TaxItems> Â Â <TaxItem> Â Â Â <Type>string</Type> Â Â Â <Value>string</Value> Â Â </TaxItem> Â </TaxItems> </Request> |
Example success Response Body | <Response> |
Example failure Response Body | <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", Â Â "CourierShopID": "string", Â Â "PurchaseOrderNumber": "string", Â Â "GroupReference": "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": "2024-03-13T15:45:33.494Z", Â Â "SalesOrderNumber": "string", Â Â "SalesOrderReference": "string", Â Â "ScheduledShipDate": "2024-03-13T15:45:33.494Z", Â Â "ShipmentTerms": "string", Â Â "SpecialInstructions": "string", Â Â "UltimateDestination": "string" Â }, Â "SalesOrderHeader": { Â Â "DCCode": "string" Â }, Â "DeliveryDetails": { Â Â "DeliveryContactIDNumber": "string", Â Â "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" Â }, Â "RetailCompliance": { Â Â "Gs1Prefix": "string", Â Â "MarkForDcCode": "string", Â Â "MarkForDcName": "string", Â Â "MarkForDcDept": "string", Â Â "MarkForDcLine1": "string", Â Â "MarkForDcLine2": "string", Â Â "MarkForDcLine3": "string", Â Â "MarkForDcLine4": "string", Â Â "MarkForDcCity": "string", Â Â "MarkForDcCountyState": "string", Â Â "MarkForDcPostCodeZip": "string", Â Â "MarkForDcCountryCode": "string", Â Â "PoDate": "2024-03-13T15:45:33.494Z", Â Â "ShipByDate": "2024-03-13T15:45:33.494Z", Â Â "ShipAfterDate": "2024-03-13T15:45:33.494Z", Â Â "ArriveByDate": "2024-03-13T15:45:33.494Z", Â Â "CancelByDate": "2024-03-13T15:45:33.494Z", Â Â "SiteId": "string", Â Â "StoreId": "string", Â Â "StoreName": "string", Â Â "ShipToDcCode": "string", Â Â "ShipToDcDeptNo": "string" Â }, Â "List": { Â Â "SalesOrderLineItem": [ Â Â Â { Â Â Â Â "UnitDiscountPrice": 0, Â Â Â Â "OrderLineMessage": "string", Â Â Â Â "SecondaryCurrencyCode": "string", Â Â Â Â "SecondaryUnitPrice": 0, Â Â Â Â "SecondaryVAT": 0, Â Â Â Â "StyleCode": "string", Â Â Â Â "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 Â Â Â } Â Â ] Â }, Â "TaxItems": [ Â Â { Â Â Â "Type": "string", Â Â Â "Value": "string" Â Â } Â ] } |
Example success Response Body | { |
Example failure Response Body | { |