OrderProcessing
Click here for a complete list of operations.
GetShippingPricesByLocation
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/GetShippingPricesByLocation"
<?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>
<GetShippingPricesByLocation xmlns="http://bloyal.com/">
<customerId>int</customerId>
<packages>
<OrderPackage>
<Status>Pending or Shipped or Returned</Status>
<PackageNumber>int</PackageNumber>
<Title>string</Title>
<FulfillmentLocationId>int</FulfillmentLocationId>
<ShippingServiceId>int</ShippingServiceId>
<ShippingService>
<Name>string</Name>
<Code>string</Code>
<ShippingCode>string</ShippingCode>
<ShippingCarrierId>int</ShippingCarrierId>
<ShippingCarrier xsi:nil="true" />
</ShippingService>
<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>
<TaxDetail xsi:nil="true" />
<TaxDetail xsi:nil="true" />
</TaxDetails>
<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>
<Name>string</Name>
<Code>string</Code>
<ShippingCode>string</ShippingCode>
<ShippingCarrierId>int</ShippingCarrierId>
<ShippingCarrier xsi:nil="true" />
</ShippingService>
<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>
<TaxDetail xsi:nil="true" />
<TaxDetail xsi:nil="true" />
</TaxDetails>
<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>
<TaxDetail xsi:nil="true" />
<TaxDetail xsi:nil="true" />
</TaxDetails>
<DiscountRule>
<Name>string</Name>
<Code>string</Code>
<Priority>int</Priority>
<Scope>Undefined or AllCustomers or LoyaltyProgram or DiscountCoupon</Scope>
<Status>Undefined or Active or Inactive</Status>
<ReasonId>int</ReasonId>
<Reason xsi:nil="true" />
<Type>Undefined or SingleOrderDiscount or PurchaseHistoryDiscount or LoyaltyAccrualRule</Type>
<TriggerType>Undefined or Amount or Weight or Points or Quantity</TriggerType>
<TriggerTarget>Undefined or SingleOrder or SameProduct or AnyProduct or Points</TriggerTarget>
<PointTrigger>int</PointTrigger>
<AmountTrigger>decimal</AmountTrigger>
<QuantityTrigger>decimal</QuantityTrigger>
</DiscountRule>
<ProductDiscount>decimal</ProductDiscount>
<OrderDiscount>decimal</OrderDiscount>
<DiscountOverride>decimal</DiscountOverride>
<ReasonId>int</ReasonId>
<ReasonCode>string</ReasonCode>
<AssemblyId>int</AssemblyId>
<Coupon>
<Name>string</Name>
<Code>string</Code>
<Active>boolean</Active>
<StartDate>dateTime</StartDate>
<EndDate>dateTime</EndDate>
<Description>string</Description>
<Type>None or Standard or Awarded</Type>
<PrimaryDiscount xsi:nil="true" />
</Coupon>
<SerialNumbers>
<SerialNumber xsi:nil="true" />
<SerialNumber xsi:nil="true" />
</SerialNumbers>
<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>
<TaxDetail xsi:nil="true" />
<TaxDetail xsi:nil="true" />
</TaxDetails>
<DiscountRule>
<Name>string</Name>
<Code>string</Code>
<Priority>int</Priority>
<Scope>Undefined or AllCustomers or LoyaltyProgram or DiscountCoupon</Scope>
<Status>Undefined or Active or Inactive</Status>
<ReasonId>int</ReasonId>
<Reason xsi:nil="true" />
<Type>Undefined or SingleOrderDiscount or PurchaseHistoryDiscount or LoyaltyAccrualRule</Type>
<TriggerType>Undefined or Amount or Weight or Points or Quantity</TriggerType>
<TriggerTarget>Undefined or SingleOrder or SameProduct or AnyProduct or Points</TriggerTarget>
<PointTrigger>int</PointTrigger>
<AmountTrigger>decimal</AmountTrigger>
<QuantityTrigger>decimal</QuantityTrigger>
</DiscountRule>
<ProductDiscount>decimal</ProductDiscount>
<OrderDiscount>decimal</OrderDiscount>
<DiscountOverride>decimal</DiscountOverride>
<ReasonId>int</ReasonId>
<ReasonCode>string</ReasonCode>
<AssemblyId>int</AssemblyId>
<Coupon>
<Name>string</Name>
<Code>string</Code>
<Active>boolean</Active>
<StartDate>dateTime</StartDate>
<EndDate>dateTime</EndDate>
<Description>string</Description>
<Type>None or Standard or Awarded</Type>
<PrimaryDiscount xsi:nil="true" />
</Coupon>
<SerialNumbers>
<SerialNumber xsi:nil="true" />
<SerialNumber xsi:nil="true" />
</SerialNumbers>
<Number>string</Number>
<SalesRepCode>string</SalesRepCode>
</OrderLine>
</lines>
<webOrder>boolean</webOrder>
<shipToLocation>boolean</shipToLocation>
</GetShippingPricesByLocation>
</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>
<GetShippingPricesByLocationResponse xmlns="http://bloyal.com/">
<GetShippingPricesByLocationResult>
<ShippingOptions>
<PackageNumber>int</PackageNumber>
<ShippingPrices>
<ShippingPrice xsi:nil="true" />
<ShippingPrice xsi:nil="true" />
</ShippingPrices>
</ShippingOptions>
<ShippingOptions>
<PackageNumber>int</PackageNumber>
<ShippingPrices>
<ShippingPrice xsi:nil="true" />
<ShippingPrice xsi:nil="true" />
</ShippingPrices>
</ShippingOptions>
</GetShippingPricesByLocationResult>
</GetShippingPricesByLocationResponse>
</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>
<GetShippingPricesByLocation xmlns="http://bloyal.com/">
<customerId>int</customerId>
<packages>
<OrderPackage>
<Status>Pending or Shipped or Returned</Status>
<PackageNumber>int</PackageNumber>
<Title>string</Title>
<FulfillmentLocationId>int</FulfillmentLocationId>
<ShippingServiceId>int</ShippingServiceId>
<ShippingService>
<Name>string</Name>
<Code>string</Code>
<ShippingCode>string</ShippingCode>
<ShippingCarrierId>int</ShippingCarrierId>
<ShippingCarrier xsi:nil="true" />
</ShippingService>
<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>
<TaxDetail xsi:nil="true" />
<TaxDetail xsi:nil="true" />
</TaxDetails>
<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>
<Name>string</Name>
<Code>string</Code>
<ShippingCode>string</ShippingCode>
<ShippingCarrierId>int</ShippingCarrierId>
<ShippingCarrier xsi:nil="true" />
</ShippingService>
<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>
<TaxDetail xsi:nil="true" />
<TaxDetail xsi:nil="true" />
</TaxDetails>
<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>
<TaxDetail xsi:nil="true" />
<TaxDetail xsi:nil="true" />
</TaxDetails>
<DiscountRule>
<Name>string</Name>
<Code>string</Code>
<Priority>int</Priority>
<Scope>Undefined or AllCustomers or LoyaltyProgram or DiscountCoupon</Scope>
<Status>Undefined or Active or Inactive</Status>
<ReasonId>int</ReasonId>
<Reason xsi:nil="true" />
<Type>Undefined or SingleOrderDiscount or PurchaseHistoryDiscount or LoyaltyAccrualRule</Type>
<TriggerType>Undefined or Amount or Weight or Points or Quantity</TriggerType>
<TriggerTarget>Undefined or SingleOrder or SameProduct or AnyProduct or Points</TriggerTarget>
<PointTrigger>int</PointTrigger>
<AmountTrigger>decimal</AmountTrigger>
<QuantityTrigger>decimal</QuantityTrigger>
</DiscountRule>
<ProductDiscount>decimal</ProductDiscount>
<OrderDiscount>decimal</OrderDiscount>
<DiscountOverride>decimal</DiscountOverride>
<ReasonId>int</ReasonId>
<ReasonCode>string</ReasonCode>
<AssemblyId>int</AssemblyId>
<Coupon>
<Name>string</Name>
<Code>string</Code>
<Active>boolean</Active>
<StartDate>dateTime</StartDate>
<EndDate>dateTime</EndDate>
<Description>string</Description>
<Type>None or Standard or Awarded</Type>
<PrimaryDiscount xsi:nil="true" />
</Coupon>
<SerialNumbers>
<SerialNumber xsi:nil="true" />
<SerialNumber xsi:nil="true" />
</SerialNumbers>
<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>
<TaxDetail xsi:nil="true" />
<TaxDetail xsi:nil="true" />
</TaxDetails>
<DiscountRule>
<Name>string</Name>
<Code>string</Code>
<Priority>int</Priority>
<Scope>Undefined or AllCustomers or LoyaltyProgram or DiscountCoupon</Scope>
<Status>Undefined or Active or Inactive</Status>
<ReasonId>int</ReasonId>
<Reason xsi:nil="true" />
<Type>Undefined or SingleOrderDiscount or PurchaseHistoryDiscount or LoyaltyAccrualRule</Type>
<TriggerType>Undefined or Amount or Weight or Points or Quantity</TriggerType>
<TriggerTarget>Undefined or SingleOrder or SameProduct or AnyProduct or Points</TriggerTarget>
<PointTrigger>int</PointTrigger>
<AmountTrigger>decimal</AmountTrigger>
<QuantityTrigger>decimal</QuantityTrigger>
</DiscountRule>
<ProductDiscount>decimal</ProductDiscount>
<OrderDiscount>decimal</OrderDiscount>
<DiscountOverride>decimal</DiscountOverride>
<ReasonId>int</ReasonId>
<ReasonCode>string</ReasonCode>
<AssemblyId>int</AssemblyId>
<Coupon>
<Name>string</Name>
<Code>string</Code>
<Active>boolean</Active>
<StartDate>dateTime</StartDate>
<EndDate>dateTime</EndDate>
<Description>string</Description>
<Type>None or Standard or Awarded</Type>
<PrimaryDiscount xsi:nil="true" />
</Coupon>
<SerialNumbers>
<SerialNumber xsi:nil="true" />
<SerialNumber xsi:nil="true" />
</SerialNumbers>
<Number>string</Number>
<SalesRepCode>string</SalesRepCode>
</OrderLine>
</lines>
<webOrder>boolean</webOrder>
<shipToLocation>boolean</shipToLocation>
</GetShippingPricesByLocation>
</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>
<GetShippingPricesByLocationResponse xmlns="http://bloyal.com/">
<GetShippingPricesByLocationResult>
<ShippingOptions>
<PackageNumber>int</PackageNumber>
<ShippingPrices>
<ShippingPrice xsi:nil="true" />
<ShippingPrice xsi:nil="true" />
</ShippingPrices>
</ShippingOptions>
<ShippingOptions>
<PackageNumber>int</PackageNumber>
<ShippingPrices>
<ShippingPrice xsi:nil="true" />
<ShippingPrice xsi:nil="true" />
</ShippingPrices>
</ShippingOptions>
</GetShippingPricesByLocationResult>
</GetShippingPricesByLocationResponse>
</soap12:Body>
</soap12:Envelope>