OrderProcessing
Click here for a complete list of operations.
RegisterDevice
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /ws14/orderprocessing.asmx HTTP/1.1 Host: ws.bloyal.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://bloyal.com/RegisterDevice" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <RegisterDevice xmlns="http://bloyal.com/"> <version>string</version> <registerNumber>string</registerNumber> </RegisterDevice> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <RegisterDeviceResponse xmlns="http://bloyal.com/"> <RegisterDeviceResult> <Status>string</Status> <WebServiceUri>string</WebServiceUri> <ConnectorLogoUri>string</ConnectorLogoUri> <Device> <Model>string</Model> <Title>string</Title> <Channel>WebStore or Kiosk or Club or Phone or POS or Event or Other or OutsideSales or Mobile or SocialNetwork or Wholesale or Samples</Channel> <GiftCardTerminalId>string</GiftCardTerminalId> <CreditCardTerminalId>string</CreditCardTerminalId> <GiftEnabled>boolean</GiftEnabled> <StoreId>int</StoreId> <Store> <Type>PhysicalStore or ExternalWebStore or InternalWebStore or VirtualStore or BackOffice</Type> <Code>string</Code> <Name>string</Name> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <State>string</State> <ZipCode>string</ZipCode> <Country>string</Country> <WebStoreUrl>string</WebStoreUrl> <ReplicationLocationId>int</ReplicationLocationId> <DefaultShippingLocationId>int</DefaultShippingLocationId> <DefaultPickupLocationId>int</DefaultPickupLocationId> <Locations xsi:nil="true" /> <StockOutHandling>Unknown or AcceptSales or AcceptSalesWithWarning or RejectSalesWithWarning or DoNotDisplay</StockOutHandling> <PickupType>Unknown or Standard or ShipToLocation</PickupType> </Store> <Type>string</Type> <Access> <string>string</string> <string>string</string> </Access> <RegisterNumber>string</RegisterNumber> </Device> <Client> <SupportCreditCardTypes>Visa or Discover or MasterCard or AmericanExpress</SupportCreditCardTypes> <OrderCodeDefinitions> <CustomCodeDefinition xsi:nil="true" /> <CustomCodeDefinition xsi:nil="true" /> </OrderCodeDefinitions> <CustomerCodeDefinitions> <CustomCodeDefinition xsi:nil="true" /> <CustomCodeDefinition xsi:nil="true" /> </CustomerCodeDefinitions> <ProductCodeDefinitions> <CustomCodeDefinition xsi:nil="true" /> <CustomCodeDefinition xsi:nil="true" /> </ProductCodeDefinitions> <ClubCodeDefinitions> <CustomCodeDefinition xsi:nil="true" /> <CustomCodeDefinition xsi:nil="true" /> </ClubCodeDefinitions> <CustomerListCodeDefinitions> <CustomCodeDefinition xsi:nil="true" /> <CustomCodeDefinition xsi:nil="true" /> </CustomerListCodeDefinitions> <SubscriberGroupCodeDefinitions> <CustomCodeDefinition xsi:nil="true" /> <CustomCodeDefinition xsi:nil="true" /> </SubscriberGroupCodeDefinitions> <AddressValidationSupport>boolean</AddressValidationSupport> <AddressValidationContactDefault>boolean</AddressValidationContactDefault> <AddressValidationShippingDefault>boolean</AddressValidationShippingDefault> <AgeVerificationSupport>boolean</AgeVerificationSupport> <DefaultCountry>string</DefaultCountry> <CurrencySymbol>string</CurrencySymbol> <CustomerLabels> <ParentAccount>string</ParentAccount> <Referral1>string</Referral1> <Referral2>string</Referral2> <LoyaltyPoints>string</LoyaltyPoints> <LoyaltyDollars>string</LoyaltyDollars> </CustomerLabels> <ProductLabels> <PriceLevelA>string</PriceLevelA> <PriceLevelB>string</PriceLevelB> <PriceLevelC>string</PriceLevelC> <BasePrice>string</BasePrice> <MSRP>string</MSRP> </ProductLabels> <WebServiceUrl>string</WebServiceUrl> <NoDiscountsMasterIsDirector>boolean</NoDiscountsMasterIsDirector> <WebEnabledMasterIsDirector>boolean</WebEnabledMasterIsDirector> <WeightMasterIsDirector>boolean</WeightMasterIsDirector> <CustomerResolutionFields> <string>string</string> <string>string</string> </CustomerResolutionFields> </Client> </RegisterDeviceResult> </RegisterDeviceResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /ws14/orderprocessing.asmx HTTP/1.1 Host: ws.bloyal.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <RegisterDevice xmlns="http://bloyal.com/"> <version>string</version> <registerNumber>string</registerNumber> </RegisterDevice> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <RegisterDeviceResponse xmlns="http://bloyal.com/"> <RegisterDeviceResult> <Status>string</Status> <WebServiceUri>string</WebServiceUri> <ConnectorLogoUri>string</ConnectorLogoUri> <Device> <Model>string</Model> <Title>string</Title> <Channel>WebStore or Kiosk or Club or Phone or POS or Event or Other or OutsideSales or Mobile or SocialNetwork or Wholesale or Samples</Channel> <GiftCardTerminalId>string</GiftCardTerminalId> <CreditCardTerminalId>string</CreditCardTerminalId> <GiftEnabled>boolean</GiftEnabled> <StoreId>int</StoreId> <Store> <Type>PhysicalStore or ExternalWebStore or InternalWebStore or VirtualStore or BackOffice</Type> <Code>string</Code> <Name>string</Name> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <State>string</State> <ZipCode>string</ZipCode> <Country>string</Country> <WebStoreUrl>string</WebStoreUrl> <ReplicationLocationId>int</ReplicationLocationId> <DefaultShippingLocationId>int</DefaultShippingLocationId> <DefaultPickupLocationId>int</DefaultPickupLocationId> <Locations xsi:nil="true" /> <StockOutHandling>Unknown or AcceptSales or AcceptSalesWithWarning or RejectSalesWithWarning or DoNotDisplay</StockOutHandling> <PickupType>Unknown or Standard or ShipToLocation</PickupType> </Store> <Type>string</Type> <Access> <string>string</string> <string>string</string> </Access> <RegisterNumber>string</RegisterNumber> </Device> <Client> <SupportCreditCardTypes>Visa or Discover or MasterCard or AmericanExpress</SupportCreditCardTypes> <OrderCodeDefinitions> <CustomCodeDefinition xsi:nil="true" /> <CustomCodeDefinition xsi:nil="true" /> </OrderCodeDefinitions> <CustomerCodeDefinitions> <CustomCodeDefinition xsi:nil="true" /> <CustomCodeDefinition xsi:nil="true" /> </CustomerCodeDefinitions> <ProductCodeDefinitions> <CustomCodeDefinition xsi:nil="true" /> <CustomCodeDefinition xsi:nil="true" /> </ProductCodeDefinitions> <ClubCodeDefinitions> <CustomCodeDefinition xsi:nil="true" /> <CustomCodeDefinition xsi:nil="true" /> </ClubCodeDefinitions> <CustomerListCodeDefinitions> <CustomCodeDefinition xsi:nil="true" /> <CustomCodeDefinition xsi:nil="true" /> </CustomerListCodeDefinitions> <SubscriberGroupCodeDefinitions> <CustomCodeDefinition xsi:nil="true" /> <CustomCodeDefinition xsi:nil="true" /> </SubscriberGroupCodeDefinitions> <AddressValidationSupport>boolean</AddressValidationSupport> <AddressValidationContactDefault>boolean</AddressValidationContactDefault> <AddressValidationShippingDefault>boolean</AddressValidationShippingDefault> <AgeVerificationSupport>boolean</AgeVerificationSupport> <DefaultCountry>string</DefaultCountry> <CurrencySymbol>string</CurrencySymbol> <CustomerLabels> <ParentAccount>string</ParentAccount> <Referral1>string</Referral1> <Referral2>string</Referral2> <LoyaltyPoints>string</LoyaltyPoints> <LoyaltyDollars>string</LoyaltyDollars> </CustomerLabels> <ProductLabels> <PriceLevelA>string</PriceLevelA> <PriceLevelB>string</PriceLevelB> <PriceLevelC>string</PriceLevelC> <BasePrice>string</BasePrice> <MSRP>string</MSRP> </ProductLabels> <WebServiceUrl>string</WebServiceUrl> <NoDiscountsMasterIsDirector>boolean</NoDiscountsMasterIsDirector> <WebEnabledMasterIsDirector>boolean</WebEnabledMasterIsDirector> <WeightMasterIsDirector>boolean</WeightMasterIsDirector> <CustomerResolutionFields> <string>string</string> <string>string</string> </CustomerResolutionFields> </Client> </RegisterDeviceResult> </RegisterDeviceResponse> </soap12:Body> </soap12:Envelope>