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 | { |