OrderProcessing

Click here for a complete list of operations.

SaveClub

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/SaveClub"

<?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>
    <SaveClub xmlns="http://bloyal.com/">
      <club>
        <Code>string</Code>
        <Name>string</Name>
        <Description>string</Description>
        <WebDescription>string</WebDescription>
        <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>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </Locations>
          <StockOutHandling>Unknown or AcceptSales or AcceptSalesWithWarning or RejectSalesWithWarning or DoNotDisplay</StockOutHandling>
          <PickupType>Unknown or Standard or ShipToLocation</PickupType>
        </Store>
        <SignupAllowed>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupAllowed>
        <SignupNotify>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupNotify>
        <CodeDefinitions>
          <CustomCodeDefinition>
            <Label>string</Label>
            <Type>Seq or Map</Type>
            <DisplayPreference>Vertical or Horizontal or Grid</DisplayPreference>
            <Required>boolean</Required>
            <Index>int</Index>
            <Slot>int</Slot>
            <Items xsi:nil="true" />
          </CustomCodeDefinition>
          <CustomCodeDefinition>
            <Label>string</Label>
            <Type>Seq or Map</Type>
            <DisplayPreference>Vertical or Horizontal or Grid</DisplayPreference>
            <Required>boolean</Required>
            <Index>int</Index>
            <Slot>int</Slot>
            <Items xsi:nil="true" />
          </CustomCodeDefinition>
        </CodeDefinitions>
        <ActiveMembers>int</ActiveMembers>
        <Members>
          <ClubMembership>
            <ClubId>int</ClubId>
            <Club xsi:nil="true" />
            <Status>Active or Inactive or Closed</Status>
            <PaymentMethodId>int</PaymentMethodId>
            <PaymentMethod xsi:nil="true" />
            <ShippingServiceId>int</ShippingServiceId>
            <ShippingAddress xsi:nil="true" />
            <SponsorId>int</SponsorId>
            <Sponsor xsi:nil="true" />
            <ShippingAddressId>int</ShippingAddressId>
            <ReferralId>int</ReferralId>
            <Referral xsi:nil="true" />
            <InventoryLocationId>int</InventoryLocationId>
            <InventoryLocation xsi:nil="true" />
            <ApplyLoyalty>boolean</ApplyLoyalty>
            <Comment>string</Comment>
            <ProductOption>Default or Replace or Append</ProductOption>
            <OrderLines xsi:nil="true" />
            <ReferenceNumber>string</ReferenceNumber>
            <StartDate>dateTime</StartDate>
            <ActiveDate>dateTime</ActiveDate>
            <ExpireDate>dateTime</ExpireDate>
            <CloseDate>dateTime</CloseDate>
            <SignupSource>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupSource>
            <BillingDay>int</BillingDay>
            <BillingStartDate>dateTime</BillingStartDate>
          </ClubMembership>
          <ClubMembership>
            <ClubId>int</ClubId>
            <Club xsi:nil="true" />
            <Status>Active or Inactive or Closed</Status>
            <PaymentMethodId>int</PaymentMethodId>
            <PaymentMethod xsi:nil="true" />
            <ShippingServiceId>int</ShippingServiceId>
            <ShippingAddress xsi:nil="true" />
            <SponsorId>int</SponsorId>
            <Sponsor xsi:nil="true" />
            <ShippingAddressId>int</ShippingAddressId>
            <ReferralId>int</ReferralId>
            <Referral xsi:nil="true" />
            <InventoryLocationId>int</InventoryLocationId>
            <InventoryLocation xsi:nil="true" />
            <ApplyLoyalty>boolean</ApplyLoyalty>
            <Comment>string</Comment>
            <ProductOption>Default or Replace or Append</ProductOption>
            <OrderLines xsi:nil="true" />
            <ReferenceNumber>string</ReferenceNumber>
            <StartDate>dateTime</StartDate>
            <ActiveDate>dateTime</ActiveDate>
            <ExpireDate>dateTime</ExpireDate>
            <CloseDate>dateTime</CloseDate>
            <SignupSource>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupSource>
            <BillingDay>int</BillingDay>
            <BillingStartDate>dateTime</BillingStartDate>
          </ClubMembership>
        </Members>
      </club>
      <queueExceptions>boolean</queueExceptions>
      <createNeededEntities>boolean</createNeededEntities>
    </SaveClub>
  </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>
    <SaveClubResponse xmlns="http://bloyal.com/">
      <SaveClubResult>
        <Code>string</Code>
        <Name>string</Name>
        <Description>string</Description>
        <WebDescription>string</WebDescription>
        <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>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </Locations>
          <StockOutHandling>Unknown or AcceptSales or AcceptSalesWithWarning or RejectSalesWithWarning or DoNotDisplay</StockOutHandling>
          <PickupType>Unknown or Standard or ShipToLocation</PickupType>
        </Store>
        <SignupAllowed>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupAllowed>
        <SignupNotify>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupNotify>
        <CodeDefinitions>
          <CustomCodeDefinition>
            <Label>string</Label>
            <Type>Seq or Map</Type>
            <DisplayPreference>Vertical or Horizontal or Grid</DisplayPreference>
            <Required>boolean</Required>
            <Index>int</Index>
            <Slot>int</Slot>
            <Items xsi:nil="true" />
          </CustomCodeDefinition>
          <CustomCodeDefinition>
            <Label>string</Label>
            <Type>Seq or Map</Type>
            <DisplayPreference>Vertical or Horizontal or Grid</DisplayPreference>
            <Required>boolean</Required>
            <Index>int</Index>
            <Slot>int</Slot>
            <Items xsi:nil="true" />
          </CustomCodeDefinition>
        </CodeDefinitions>
        <ActiveMembers>int</ActiveMembers>
        <Members>
          <ClubMembership>
            <ClubId>int</ClubId>
            <Club xsi:nil="true" />
            <Status>Active or Inactive or Closed</Status>
            <PaymentMethodId>int</PaymentMethodId>
            <PaymentMethod xsi:nil="true" />
            <ShippingServiceId>int</ShippingServiceId>
            <ShippingAddress xsi:nil="true" />
            <SponsorId>int</SponsorId>
            <Sponsor xsi:nil="true" />
            <ShippingAddressId>int</ShippingAddressId>
            <ReferralId>int</ReferralId>
            <Referral xsi:nil="true" />
            <InventoryLocationId>int</InventoryLocationId>
            <InventoryLocation xsi:nil="true" />
            <ApplyLoyalty>boolean</ApplyLoyalty>
            <Comment>string</Comment>
            <ProductOption>Default or Replace or Append</ProductOption>
            <OrderLines xsi:nil="true" />
            <ReferenceNumber>string</ReferenceNumber>
            <StartDate>dateTime</StartDate>
            <ActiveDate>dateTime</ActiveDate>
            <ExpireDate>dateTime</ExpireDate>
            <CloseDate>dateTime</CloseDate>
            <SignupSource>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupSource>
            <BillingDay>int</BillingDay>
            <BillingStartDate>dateTime</BillingStartDate>
          </ClubMembership>
          <ClubMembership>
            <ClubId>int</ClubId>
            <Club xsi:nil="true" />
            <Status>Active or Inactive or Closed</Status>
            <PaymentMethodId>int</PaymentMethodId>
            <PaymentMethod xsi:nil="true" />
            <ShippingServiceId>int</ShippingServiceId>
            <ShippingAddress xsi:nil="true" />
            <SponsorId>int</SponsorId>
            <Sponsor xsi:nil="true" />
            <ShippingAddressId>int</ShippingAddressId>
            <ReferralId>int</ReferralId>
            <Referral xsi:nil="true" />
            <InventoryLocationId>int</InventoryLocationId>
            <InventoryLocation xsi:nil="true" />
            <ApplyLoyalty>boolean</ApplyLoyalty>
            <Comment>string</Comment>
            <ProductOption>Default or Replace or Append</ProductOption>
            <OrderLines xsi:nil="true" />
            <ReferenceNumber>string</ReferenceNumber>
            <StartDate>dateTime</StartDate>
            <ActiveDate>dateTime</ActiveDate>
            <ExpireDate>dateTime</ExpireDate>
            <CloseDate>dateTime</CloseDate>
            <SignupSource>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupSource>
            <BillingDay>int</BillingDay>
            <BillingStartDate>dateTime</BillingStartDate>
          </ClubMembership>
        </Members>
      </SaveClubResult>
      <problems>
        <ProblemReport>
          <Number>int</Number>
          <Code>string</Code>
          <Message>string</Message>
        </ProblemReport>
        <ProblemReport>
          <Number>int</Number>
          <Code>string</Code>
          <Message>string</Message>
        </ProblemReport>
      </problems>
    </SaveClubResponse>
  </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>
    <SaveClub xmlns="http://bloyal.com/">
      <club>
        <Code>string</Code>
        <Name>string</Name>
        <Description>string</Description>
        <WebDescription>string</WebDescription>
        <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>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </Locations>
          <StockOutHandling>Unknown or AcceptSales or AcceptSalesWithWarning or RejectSalesWithWarning or DoNotDisplay</StockOutHandling>
          <PickupType>Unknown or Standard or ShipToLocation</PickupType>
        </Store>
        <SignupAllowed>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupAllowed>
        <SignupNotify>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupNotify>
        <CodeDefinitions>
          <CustomCodeDefinition>
            <Label>string</Label>
            <Type>Seq or Map</Type>
            <DisplayPreference>Vertical or Horizontal or Grid</DisplayPreference>
            <Required>boolean</Required>
            <Index>int</Index>
            <Slot>int</Slot>
            <Items xsi:nil="true" />
          </CustomCodeDefinition>
          <CustomCodeDefinition>
            <Label>string</Label>
            <Type>Seq or Map</Type>
            <DisplayPreference>Vertical or Horizontal or Grid</DisplayPreference>
            <Required>boolean</Required>
            <Index>int</Index>
            <Slot>int</Slot>
            <Items xsi:nil="true" />
          </CustomCodeDefinition>
        </CodeDefinitions>
        <ActiveMembers>int</ActiveMembers>
        <Members>
          <ClubMembership>
            <ClubId>int</ClubId>
            <Club xsi:nil="true" />
            <Status>Active or Inactive or Closed</Status>
            <PaymentMethodId>int</PaymentMethodId>
            <PaymentMethod xsi:nil="true" />
            <ShippingServiceId>int</ShippingServiceId>
            <ShippingAddress xsi:nil="true" />
            <SponsorId>int</SponsorId>
            <Sponsor xsi:nil="true" />
            <ShippingAddressId>int</ShippingAddressId>
            <ReferralId>int</ReferralId>
            <Referral xsi:nil="true" />
            <InventoryLocationId>int</InventoryLocationId>
            <InventoryLocation xsi:nil="true" />
            <ApplyLoyalty>boolean</ApplyLoyalty>
            <Comment>string</Comment>
            <ProductOption>Default or Replace or Append</ProductOption>
            <OrderLines xsi:nil="true" />
            <ReferenceNumber>string</ReferenceNumber>
            <StartDate>dateTime</StartDate>
            <ActiveDate>dateTime</ActiveDate>
            <ExpireDate>dateTime</ExpireDate>
            <CloseDate>dateTime</CloseDate>
            <SignupSource>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupSource>
            <BillingDay>int</BillingDay>
            <BillingStartDate>dateTime</BillingStartDate>
          </ClubMembership>
          <ClubMembership>
            <ClubId>int</ClubId>
            <Club xsi:nil="true" />
            <Status>Active or Inactive or Closed</Status>
            <PaymentMethodId>int</PaymentMethodId>
            <PaymentMethod xsi:nil="true" />
            <ShippingServiceId>int</ShippingServiceId>
            <ShippingAddress xsi:nil="true" />
            <SponsorId>int</SponsorId>
            <Sponsor xsi:nil="true" />
            <ShippingAddressId>int</ShippingAddressId>
            <ReferralId>int</ReferralId>
            <Referral xsi:nil="true" />
            <InventoryLocationId>int</InventoryLocationId>
            <InventoryLocation xsi:nil="true" />
            <ApplyLoyalty>boolean</ApplyLoyalty>
            <Comment>string</Comment>
            <ProductOption>Default or Replace or Append</ProductOption>
            <OrderLines xsi:nil="true" />
            <ReferenceNumber>string</ReferenceNumber>
            <StartDate>dateTime</StartDate>
            <ActiveDate>dateTime</ActiveDate>
            <ExpireDate>dateTime</ExpireDate>
            <CloseDate>dateTime</CloseDate>
            <SignupSource>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupSource>
            <BillingDay>int</BillingDay>
            <BillingStartDate>dateTime</BillingStartDate>
          </ClubMembership>
        </Members>
      </club>
      <queueExceptions>boolean</queueExceptions>
      <createNeededEntities>boolean</createNeededEntities>
    </SaveClub>
  </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>
    <SaveClubResponse xmlns="http://bloyal.com/">
      <SaveClubResult>
        <Code>string</Code>
        <Name>string</Name>
        <Description>string</Description>
        <WebDescription>string</WebDescription>
        <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>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </Locations>
          <StockOutHandling>Unknown or AcceptSales or AcceptSalesWithWarning or RejectSalesWithWarning or DoNotDisplay</StockOutHandling>
          <PickupType>Unknown or Standard or ShipToLocation</PickupType>
        </Store>
        <SignupAllowed>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupAllowed>
        <SignupNotify>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupNotify>
        <CodeDefinitions>
          <CustomCodeDefinition>
            <Label>string</Label>
            <Type>Seq or Map</Type>
            <DisplayPreference>Vertical or Horizontal or Grid</DisplayPreference>
            <Required>boolean</Required>
            <Index>int</Index>
            <Slot>int</Slot>
            <Items xsi:nil="true" />
          </CustomCodeDefinition>
          <CustomCodeDefinition>
            <Label>string</Label>
            <Type>Seq or Map</Type>
            <DisplayPreference>Vertical or Horizontal or Grid</DisplayPreference>
            <Required>boolean</Required>
            <Index>int</Index>
            <Slot>int</Slot>
            <Items xsi:nil="true" />
          </CustomCodeDefinition>
        </CodeDefinitions>
        <ActiveMembers>int</ActiveMembers>
        <Members>
          <ClubMembership>
            <ClubId>int</ClubId>
            <Club xsi:nil="true" />
            <Status>Active or Inactive or Closed</Status>
            <PaymentMethodId>int</PaymentMethodId>
            <PaymentMethod xsi:nil="true" />
            <ShippingServiceId>int</ShippingServiceId>
            <ShippingAddress xsi:nil="true" />
            <SponsorId>int</SponsorId>
            <Sponsor xsi:nil="true" />
            <ShippingAddressId>int</ShippingAddressId>
            <ReferralId>int</ReferralId>
            <Referral xsi:nil="true" />
            <InventoryLocationId>int</InventoryLocationId>
            <InventoryLocation xsi:nil="true" />
            <ApplyLoyalty>boolean</ApplyLoyalty>
            <Comment>string</Comment>
            <ProductOption>Default or Replace or Append</ProductOption>
            <OrderLines xsi:nil="true" />
            <ReferenceNumber>string</ReferenceNumber>
            <StartDate>dateTime</StartDate>
            <ActiveDate>dateTime</ActiveDate>
            <ExpireDate>dateTime</ExpireDate>
            <CloseDate>dateTime</CloseDate>
            <SignupSource>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupSource>
            <BillingDay>int</BillingDay>
            <BillingStartDate>dateTime</BillingStartDate>
          </ClubMembership>
          <ClubMembership>
            <ClubId>int</ClubId>
            <Club xsi:nil="true" />
            <Status>Active or Inactive or Closed</Status>
            <PaymentMethodId>int</PaymentMethodId>
            <PaymentMethod xsi:nil="true" />
            <ShippingServiceId>int</ShippingServiceId>
            <ShippingAddress xsi:nil="true" />
            <SponsorId>int</SponsorId>
            <Sponsor xsi:nil="true" />
            <ShippingAddressId>int</ShippingAddressId>
            <ReferralId>int</ReferralId>
            <Referral xsi:nil="true" />
            <InventoryLocationId>int</InventoryLocationId>
            <InventoryLocation xsi:nil="true" />
            <ApplyLoyalty>boolean</ApplyLoyalty>
            <Comment>string</Comment>
            <ProductOption>Default or Replace or Append</ProductOption>
            <OrderLines xsi:nil="true" />
            <ReferenceNumber>string</ReferenceNumber>
            <StartDate>dateTime</StartDate>
            <ActiveDate>dateTime</ActiveDate>
            <ExpireDate>dateTime</ExpireDate>
            <CloseDate>dateTime</CloseDate>
            <SignupSource>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupSource>
            <BillingDay>int</BillingDay>
            <BillingStartDate>dateTime</BillingStartDate>
          </ClubMembership>
        </Members>
      </SaveClubResult>
      <problems>
        <ProblemReport>
          <Number>int</Number>
          <Code>string</Code>
          <Message>string</Message>
        </ProblemReport>
        <ProblemReport>
          <Number>int</Number>
          <Code>string</Code>
          <Message>string</Message>
        </ProblemReport>
      </problems>
    </SaveClubResponse>
  </soap12:Body>
</soap12:Envelope>