OrderProcessing
Click here for a complete list of operations.
LoadOrder
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/LoadOrder"
<?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>
<LoadOrder xmlns="http://bloyal.com/">
<orderId>int</orderId>
<associatedEntities>None or Properties or Lines or Packages or Payments or ActivityLog or All</associatedEntities>
</LoadOrder>
</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>
<LoadOrderResponse xmlns="http://bloyal.com/">
<LoadOrderResult>
<CalcToken>string</CalcToken>
<Title>string</Title>
<CustomerId>int</CustomerId>
<OrderDate>dateTime</OrderDate>
<StoreCode>string</StoreCode>
<AccountNumber>string</AccountNumber>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CompanyName>string</CompanyName>
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<State>string</State>
<ZipCode>string</ZipCode>
<Country>string</Country>
<Phone1>string</Phone1>
<Phone2>string</Phone2>
<EmailAddress>string</EmailAddress>
<ExternalOrderId>string</ExternalOrderId>
<Comment>string</Comment>
<Deposit>decimal</Deposit>
<Status>Pending or Holding or Problem or Approved or Canceled or Delivery or Closed</Status>
<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>
<Packages>
<OrderPackage>
<Status>Pending or Shipped or Returned</Status>
<PackageNumber>int</PackageNumber>
<Title>string</Title>
<FulfillmentLocationId>int</FulfillmentLocationId>
<ShippingServiceId>int</ShippingServiceId>
<ShippingService xsi:nil="true" />
<ShippingDiscount>decimal</ShippingDiscount>
<ShippingDiscountCode>string</ShippingDiscountCode>
<DiscountReasonCode>string</DiscountReasonCode>
<ShippingCharge>decimal</ShippingCharge>
<ShippingTax>decimal</ShippingTax>
<OverrideShippingCharge>boolean</OverrideShippingCharge>
<ShippingOverride>decimal</ShippingOverride>
<ShipDate>dateTime</ShipDate>
<ShippingAddressId>int</ShippingAddressId>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CompanyName>string</CompanyName>
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<State>string</State>
<ZipCode>string</ZipCode>
<Country>string</Country>
<Phone1>string</Phone1>
<Phone2>string</Phone2>
<MobilePhone>string</MobilePhone>
<FaxNumber>string</FaxNumber>
<EmailAddress>string</EmailAddress>
<BirthDate>dateTime</BirthDate>
<GiftPackage>boolean</GiftPackage>
<GiftComment>string</GiftComment>
<SpecialInstructions>string</SpecialInstructions>
<FulfillmentHouse>string</FulfillmentHouse>
<TrackingNumber>string</TrackingNumber>
<TaxDetails xsi:nil="true" />
<TaxGroupCode>string</TaxGroupCode>
<Type>ShipTo or Pickup or Electronic or GiftCertificate or ShipToLocation</Type>
<CouponCode>string</CouponCode>
<PickedUp>boolean</PickedUp>
</OrderPackage>
<OrderPackage>
<Status>Pending or Shipped or Returned</Status>
<PackageNumber>int</PackageNumber>
<Title>string</Title>
<FulfillmentLocationId>int</FulfillmentLocationId>
<ShippingServiceId>int</ShippingServiceId>
<ShippingService xsi:nil="true" />
<ShippingDiscount>decimal</ShippingDiscount>
<ShippingDiscountCode>string</ShippingDiscountCode>
<DiscountReasonCode>string</DiscountReasonCode>
<ShippingCharge>decimal</ShippingCharge>
<ShippingTax>decimal</ShippingTax>
<OverrideShippingCharge>boolean</OverrideShippingCharge>
<ShippingOverride>decimal</ShippingOverride>
<ShipDate>dateTime</ShipDate>
<ShippingAddressId>int</ShippingAddressId>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CompanyName>string</CompanyName>
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<State>string</State>
<ZipCode>string</ZipCode>
<Country>string</Country>
<Phone1>string</Phone1>
<Phone2>string</Phone2>
<MobilePhone>string</MobilePhone>
<FaxNumber>string</FaxNumber>
<EmailAddress>string</EmailAddress>
<BirthDate>dateTime</BirthDate>
<GiftPackage>boolean</GiftPackage>
<GiftComment>string</GiftComment>
<SpecialInstructions>string</SpecialInstructions>
<FulfillmentHouse>string</FulfillmentHouse>
<TrackingNumber>string</TrackingNumber>
<TaxDetails xsi:nil="true" />
<TaxGroupCode>string</TaxGroupCode>
<Type>ShipTo or Pickup or Electronic or GiftCertificate or ShipToLocation</Type>
<CouponCode>string</CouponCode>
<PickedUp>boolean</PickedUp>
</OrderPackage>
</Packages>
<Lines>
<OrderLine>
<PackageNumber>int</PackageNumber>
<ProductItemType>Standard or NonInventory or Assembly or Kit or GiftCard or GiftCertificate or Coupon or ShippingCharge</ProductItemType>
<ProductFlags>int</ProductFlags>
<ProductId>int</ProductId>
<ProductName>string</ProductName>
<Comment>string</Comment>
<ExternalKey>string</ExternalKey>
<WebAlias>string</WebAlias>
<LookupCode>string</LookupCode>
<BrandCode>string</BrandCode>
<Variant>string</Variant>
<VariantParentId>int</VariantParentId>
<Cost>decimal</Cost>
<LastCost>decimal</LastCost>
<ReplacementCost>decimal</ReplacementCost>
<FullPrice>decimal</FullPrice>
<Price>decimal</Price>
<Quantity>decimal</Quantity>
<Weight>decimal</Weight>
<Tax>decimal</Tax>
<PriceLevel>Override or Base or LevelA or LevelB or LevelC or MSRP or SalePrice</PriceLevel>
<TaxExempt>boolean</TaxExempt>
<TaxDetails xsi:nil="true" />
<DiscountRule xsi:nil="true" />
<ProductDiscount>decimal</ProductDiscount>
<OrderDiscount>decimal</OrderDiscount>
<DiscountOverride>decimal</DiscountOverride>
<ReasonId>int</ReasonId>
<ReasonCode>string</ReasonCode>
<AssemblyId>int</AssemblyId>
<Coupon xsi:nil="true" />
<SerialNumbers xsi:nil="true" />
<Number>string</Number>
<SalesRepCode>string</SalesRepCode>
</OrderLine>
<OrderLine>
<PackageNumber>int</PackageNumber>
<ProductItemType>Standard or NonInventory or Assembly or Kit or GiftCard or GiftCertificate or Coupon or ShippingCharge</ProductItemType>
<ProductFlags>int</ProductFlags>
<ProductId>int</ProductId>
<ProductName>string</ProductName>
<Comment>string</Comment>
<ExternalKey>string</ExternalKey>
<WebAlias>string</WebAlias>
<LookupCode>string</LookupCode>
<BrandCode>string</BrandCode>
<Variant>string</Variant>
<VariantParentId>int</VariantParentId>
<Cost>decimal</Cost>
<LastCost>decimal</LastCost>
<ReplacementCost>decimal</ReplacementCost>
<FullPrice>decimal</FullPrice>
<Price>decimal</Price>
<Quantity>decimal</Quantity>
<Weight>decimal</Weight>
<Tax>decimal</Tax>
<PriceLevel>Override or Base or LevelA or LevelB or LevelC or MSRP or SalePrice</PriceLevel>
<TaxExempt>boolean</TaxExempt>
<TaxDetails xsi:nil="true" />
<DiscountRule xsi:nil="true" />
<ProductDiscount>decimal</ProductDiscount>
<OrderDiscount>decimal</OrderDiscount>
<DiscountOverride>decimal</DiscountOverride>
<ReasonId>int</ReasonId>
<ReasonCode>string</ReasonCode>
<AssemblyId>int</AssemblyId>
<Coupon xsi:nil="true" />
<SerialNumbers xsi:nil="true" />
<Number>string</Number>
<SalesRepCode>string</SalesRepCode>
</OrderLine>
</Lines>
<ActivityLogs>
<ActivityLog>
<Created>dateTime</Created>
<Name>string</Name>
<Message>string</Message>
<Action>string</Action>
<System>string</System>
</ActivityLog>
<ActivityLog>
<Created>dateTime</Created>
<Name>string</Name>
<Message>string</Message>
<Action>string</Action>
<System>string</System>
</ActivityLog>
</ActivityLogs>
<CustomCode1>int</CustomCode1>
<CustomCode2>int</CustomCode2>
<CustomCode3>int</CustomCode3>
<CustomCode4>int</CustomCode4>
<PurchaseDate>dateTime</PurchaseDate>
<BypassShippingCompliance>boolean</BypassShippingCompliance>
<BypassQuantityLimits>boolean</BypassQuantityLimits>
<ReceiptUrl>string</ReceiptUrl>
<Payments>
<OrderPayment>
<OrderId>int</OrderId>
<TenderId>int</TenderId>
<Tender xsi:nil="true" />
<PaymentMethodId>int</PaymentMethodId>
<PaymentMethod xsi:nil="true" />
<Amount>decimal</Amount>
<AmountApproved>decimal</AmountApproved>
<AmountCaptured>decimal</AmountCaptured>
<AmountRefunded>decimal</AmountRefunded>
<Approved>boolean</Approved>
<Captured>boolean</Captured>
<Credited>boolean</Credited>
<Cancelled>boolean</Cancelled>
<CaptureTime>dateTime</CaptureTime>
<CancelTime>dateTime</CancelTime>
</OrderPayment>
<OrderPayment>
<OrderId>int</OrderId>
<TenderId>int</TenderId>
<Tender xsi:nil="true" />
<PaymentMethodId>int</PaymentMethodId>
<PaymentMethod xsi:nil="true" />
<Amount>decimal</Amount>
<AmountApproved>decimal</AmountApproved>
<AmountCaptured>decimal</AmountCaptured>
<AmountRefunded>decimal</AmountRefunded>
<Approved>boolean</Approved>
<Captured>boolean</Captured>
<Credited>boolean</Credited>
<Cancelled>boolean</Cancelled>
<CaptureTime>dateTime</CaptureTime>
<CancelTime>dateTime</CancelTime>
</OrderPayment>
</Payments>
<ComplianceLevel>Normal or IgnoreStreetLevelErrors or IgnoreAddressErrors or IgnoreComplianceErrors or BypassCompliance or ExternallyValidated</ComplianceLevel>
<SourceExternalId>string</SourceExternalId>
</LoadOrderResult>
</LoadOrderResponse>
</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>
<LoadOrder xmlns="http://bloyal.com/">
<orderId>int</orderId>
<associatedEntities>None or Properties or Lines or Packages or Payments or ActivityLog or All</associatedEntities>
</LoadOrder>
</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>
<LoadOrderResponse xmlns="http://bloyal.com/">
<LoadOrderResult>
<CalcToken>string</CalcToken>
<Title>string</Title>
<CustomerId>int</CustomerId>
<OrderDate>dateTime</OrderDate>
<StoreCode>string</StoreCode>
<AccountNumber>string</AccountNumber>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CompanyName>string</CompanyName>
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<State>string</State>
<ZipCode>string</ZipCode>
<Country>string</Country>
<Phone1>string</Phone1>
<Phone2>string</Phone2>
<EmailAddress>string</EmailAddress>
<ExternalOrderId>string</ExternalOrderId>
<Comment>string</Comment>
<Deposit>decimal</Deposit>
<Status>Pending or Holding or Problem or Approved or Canceled or Delivery or Closed</Status>
<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>
<Packages>
<OrderPackage>
<Status>Pending or Shipped or Returned</Status>
<PackageNumber>int</PackageNumber>
<Title>string</Title>
<FulfillmentLocationId>int</FulfillmentLocationId>
<ShippingServiceId>int</ShippingServiceId>
<ShippingService xsi:nil="true" />
<ShippingDiscount>decimal</ShippingDiscount>
<ShippingDiscountCode>string</ShippingDiscountCode>
<DiscountReasonCode>string</DiscountReasonCode>
<ShippingCharge>decimal</ShippingCharge>
<ShippingTax>decimal</ShippingTax>
<OverrideShippingCharge>boolean</OverrideShippingCharge>
<ShippingOverride>decimal</ShippingOverride>
<ShipDate>dateTime</ShipDate>
<ShippingAddressId>int</ShippingAddressId>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CompanyName>string</CompanyName>
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<State>string</State>
<ZipCode>string</ZipCode>
<Country>string</Country>
<Phone1>string</Phone1>
<Phone2>string</Phone2>
<MobilePhone>string</MobilePhone>
<FaxNumber>string</FaxNumber>
<EmailAddress>string</EmailAddress>
<BirthDate>dateTime</BirthDate>
<GiftPackage>boolean</GiftPackage>
<GiftComment>string</GiftComment>
<SpecialInstructions>string</SpecialInstructions>
<FulfillmentHouse>string</FulfillmentHouse>
<TrackingNumber>string</TrackingNumber>
<TaxDetails xsi:nil="true" />
<TaxGroupCode>string</TaxGroupCode>
<Type>ShipTo or Pickup or Electronic or GiftCertificate or ShipToLocation</Type>
<CouponCode>string</CouponCode>
<PickedUp>boolean</PickedUp>
</OrderPackage>
<OrderPackage>
<Status>Pending or Shipped or Returned</Status>
<PackageNumber>int</PackageNumber>
<Title>string</Title>
<FulfillmentLocationId>int</FulfillmentLocationId>
<ShippingServiceId>int</ShippingServiceId>
<ShippingService xsi:nil="true" />
<ShippingDiscount>decimal</ShippingDiscount>
<ShippingDiscountCode>string</ShippingDiscountCode>
<DiscountReasonCode>string</DiscountReasonCode>
<ShippingCharge>decimal</ShippingCharge>
<ShippingTax>decimal</ShippingTax>
<OverrideShippingCharge>boolean</OverrideShippingCharge>
<ShippingOverride>decimal</ShippingOverride>
<ShipDate>dateTime</ShipDate>
<ShippingAddressId>int</ShippingAddressId>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CompanyName>string</CompanyName>
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<State>string</State>
<ZipCode>string</ZipCode>
<Country>string</Country>
<Phone1>string</Phone1>
<Phone2>string</Phone2>
<MobilePhone>string</MobilePhone>
<FaxNumber>string</FaxNumber>
<EmailAddress>string</EmailAddress>
<BirthDate>dateTime</BirthDate>
<GiftPackage>boolean</GiftPackage>
<GiftComment>string</GiftComment>
<SpecialInstructions>string</SpecialInstructions>
<FulfillmentHouse>string</FulfillmentHouse>
<TrackingNumber>string</TrackingNumber>
<TaxDetails xsi:nil="true" />
<TaxGroupCode>string</TaxGroupCode>
<Type>ShipTo or Pickup or Electronic or GiftCertificate or ShipToLocation</Type>
<CouponCode>string</CouponCode>
<PickedUp>boolean</PickedUp>
</OrderPackage>
</Packages>
<Lines>
<OrderLine>
<PackageNumber>int</PackageNumber>
<ProductItemType>Standard or NonInventory or Assembly or Kit or GiftCard or GiftCertificate or Coupon or ShippingCharge</ProductItemType>
<ProductFlags>int</ProductFlags>
<ProductId>int</ProductId>
<ProductName>string</ProductName>
<Comment>string</Comment>
<ExternalKey>string</ExternalKey>
<WebAlias>string</WebAlias>
<LookupCode>string</LookupCode>
<BrandCode>string</BrandCode>
<Variant>string</Variant>
<VariantParentId>int</VariantParentId>
<Cost>decimal</Cost>
<LastCost>decimal</LastCost>
<ReplacementCost>decimal</ReplacementCost>
<FullPrice>decimal</FullPrice>
<Price>decimal</Price>
<Quantity>decimal</Quantity>
<Weight>decimal</Weight>
<Tax>decimal</Tax>
<PriceLevel>Override or Base or LevelA or LevelB or LevelC or MSRP or SalePrice</PriceLevel>
<TaxExempt>boolean</TaxExempt>
<TaxDetails xsi:nil="true" />
<DiscountRule xsi:nil="true" />
<ProductDiscount>decimal</ProductDiscount>
<OrderDiscount>decimal</OrderDiscount>
<DiscountOverride>decimal</DiscountOverride>
<ReasonId>int</ReasonId>
<ReasonCode>string</ReasonCode>
<AssemblyId>int</AssemblyId>
<Coupon xsi:nil="true" />
<SerialNumbers xsi:nil="true" />
<Number>string</Number>
<SalesRepCode>string</SalesRepCode>
</OrderLine>
<OrderLine>
<PackageNumber>int</PackageNumber>
<ProductItemType>Standard or NonInventory or Assembly or Kit or GiftCard or GiftCertificate or Coupon or ShippingCharge</ProductItemType>
<ProductFlags>int</ProductFlags>
<ProductId>int</ProductId>
<ProductName>string</ProductName>
<Comment>string</Comment>
<ExternalKey>string</ExternalKey>
<WebAlias>string</WebAlias>
<LookupCode>string</LookupCode>
<BrandCode>string</BrandCode>
<Variant>string</Variant>
<VariantParentId>int</VariantParentId>
<Cost>decimal</Cost>
<LastCost>decimal</LastCost>
<ReplacementCost>decimal</ReplacementCost>
<FullPrice>decimal</FullPrice>
<Price>decimal</Price>
<Quantity>decimal</Quantity>
<Weight>decimal</Weight>
<Tax>decimal</Tax>
<PriceLevel>Override or Base or LevelA or LevelB or LevelC or MSRP or SalePrice</PriceLevel>
<TaxExempt>boolean</TaxExempt>
<TaxDetails xsi:nil="true" />
<DiscountRule xsi:nil="true" />
<ProductDiscount>decimal</ProductDiscount>
<OrderDiscount>decimal</OrderDiscount>
<DiscountOverride>decimal</DiscountOverride>
<ReasonId>int</ReasonId>
<ReasonCode>string</ReasonCode>
<AssemblyId>int</AssemblyId>
<Coupon xsi:nil="true" />
<SerialNumbers xsi:nil="true" />
<Number>string</Number>
<SalesRepCode>string</SalesRepCode>
</OrderLine>
</Lines>
<ActivityLogs>
<ActivityLog>
<Created>dateTime</Created>
<Name>string</Name>
<Message>string</Message>
<Action>string</Action>
<System>string</System>
</ActivityLog>
<ActivityLog>
<Created>dateTime</Created>
<Name>string</Name>
<Message>string</Message>
<Action>string</Action>
<System>string</System>
</ActivityLog>
</ActivityLogs>
<CustomCode1>int</CustomCode1>
<CustomCode2>int</CustomCode2>
<CustomCode3>int</CustomCode3>
<CustomCode4>int</CustomCode4>
<PurchaseDate>dateTime</PurchaseDate>
<BypassShippingCompliance>boolean</BypassShippingCompliance>
<BypassQuantityLimits>boolean</BypassQuantityLimits>
<ReceiptUrl>string</ReceiptUrl>
<Payments>
<OrderPayment>
<OrderId>int</OrderId>
<TenderId>int</TenderId>
<Tender xsi:nil="true" />
<PaymentMethodId>int</PaymentMethodId>
<PaymentMethod xsi:nil="true" />
<Amount>decimal</Amount>
<AmountApproved>decimal</AmountApproved>
<AmountCaptured>decimal</AmountCaptured>
<AmountRefunded>decimal</AmountRefunded>
<Approved>boolean</Approved>
<Captured>boolean</Captured>
<Credited>boolean</Credited>
<Cancelled>boolean</Cancelled>
<CaptureTime>dateTime</CaptureTime>
<CancelTime>dateTime</CancelTime>
</OrderPayment>
<OrderPayment>
<OrderId>int</OrderId>
<TenderId>int</TenderId>
<Tender xsi:nil="true" />
<PaymentMethodId>int</PaymentMethodId>
<PaymentMethod xsi:nil="true" />
<Amount>decimal</Amount>
<AmountApproved>decimal</AmountApproved>
<AmountCaptured>decimal</AmountCaptured>
<AmountRefunded>decimal</AmountRefunded>
<Approved>boolean</Approved>
<Captured>boolean</Captured>
<Credited>boolean</Credited>
<Cancelled>boolean</Cancelled>
<CaptureTime>dateTime</CaptureTime>
<CancelTime>dateTime</CancelTime>
</OrderPayment>
</Payments>
<ComplianceLevel>Normal or IgnoreStreetLevelErrors or IgnoreAddressErrors or IgnoreComplianceErrors or BypassCompliance or ExternallyValidated</ComplianceLevel>
<SourceExternalId>string</SourceExternalId>
</LoadOrderResult>
</LoadOrderResponse>
</soap12:Body>
</soap12:Envelope>