SalesOrderService Web Service

SalesOrderService

Click here for a complete list of operations.

CheckComplianceOfAndCommitSalesOrder

Checks the compliance of the specified salesorder and commits it to the system.

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 /Services/1.2/SalesOrderService.asmx HTTP/1.1
Host: ws.shipcompliant.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.shipcompliant.com/CheckComplianceOfAndCommitSalesOrder"

<?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>
    <CheckComplianceOfAndCommitSalesOrder xmlns="http://ws.shipcompliant.com/">
      <Request>
        <AddressOption>
          <IgnoreStreetLevelErrors>boolean</IgnoreStreetLevelErrors>
          <RejectIfAddressSuggested>boolean</RejectIfAddressSuggested>
        </AddressOption>
        <CommitOption>Null or AllShipments or CompliantShipments</CommitOption>
        <IncludeSalesTaxRates>boolean</IncludeSalesTaxRates>
        <PersistOption>Null or OverrideExisting</PersistOption>
        <SalesOrder>
          <BillTo>
            <City>string</City>
            <Company>string</Company>
            <Country>string</Country>
            <County>string</County>
            <DateOfBirth>dateTime</DateOfBirth>
            <Email>string</Email>
            <Fax>string</Fax>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <Phone>string</Phone>
            <State>string</State>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <Zip1>string</Zip1>
            <Zip2>string</Zip2>
          </BillTo>
          <CashierKey>string</CashierKey>
          <CustomerKey>string</CustomerKey>
          <Discounts>
            <SalesOrderDiscount xsi:nil="true" />
            <SalesOrderDiscount xsi:nil="true" />
          </Discounts>
          <ExternalCustomerKey>string</ExternalCustomerKey>
          <ExternalOfferKeys>
            <string>string</string>
            <string>string</string>
          </ExternalOfferKeys>
          <ExternalSalesOrderKey>string</ExternalSalesOrderKey>
          <FulfillmentType>Null or Club or Daily</FulfillmentType>
          <OrderType>Null or Club or Fax or InPerson or Internet or Mail or Phone</OrderType>
          <Payments>
            <Payment xsi:nil="true" />
            <Payment xsi:nil="true" />
          </Payments>
          <PurchaseDate>dateTime</PurchaseDate>
          <ReferenceNumber>string</ReferenceNumber>
          <RefundedOrderReference>string</RefundedOrderReference>
          <RegisterID>string</RegisterID>
          <SalesAssociateKey>string</SalesAssociateKey>
          <SalesOrderKey>string</SalesOrderKey>
          <SalesTaxCollected>decimal</SalesTaxCollected>
          <SettlementBatchNumber>string</SettlementBatchNumber>
          <Shipments>
            <Shipment xsi:nil="true" />
            <Shipment xsi:nil="true" />
          </Shipments>
          <Tags>
            <Tag xsi:nil="true" />
            <Tag xsi:nil="true" />
          </Tags>
        </SalesOrder>
      </Request>
    </CheckComplianceOfAndCommitSalesOrder>
  </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>
    <CheckComplianceOfAndCommitSalesOrderResponse xmlns="http://ws.shipcompliant.com/">
      <CheckComplianceOfAndCommitSalesOrderResult>
        <Errors>
          <Error>
            <Code>string</Code>
            <Data xsi:nil="true" />
            <Key>string</Key>
            <Message>string</Message>
            <Target>Null or Address or Age or Batch or Brand or Distributor or Product or SalesOrder or Shipment or Tax or SSO or License or HoldLocation</Target>
            <Type>Authentication or Server or Validation</Type>
          </Error>
          <Error>
            <Code>string</Code>
            <Data xsi:nil="true" />
            <Key>string</Key>
            <Message>string</Message>
            <Target>Null or Address or Age or Batch or Brand or Distributor or Product or SalesOrder or Shipment or Tax or SSO or License or HoldLocation</Target>
            <Type>Authentication or Server or Validation</Type>
          </Error>
        </Errors>
        <ResponseStatus>Failure or Success</ResponseStatus>
        <SalesOrder>
          <IsCompliant>boolean</IsCompliant>
          <Key>string</Key>
          <SalesTaxRates>
            <RecommendedSalesTaxDue>decimal</RecommendedSalesTaxDue>
            <ShipmentSalesTaxRates xsi:nil="true" />
          </SalesTaxRates>
          <Shipments>
            <ShipmentComplianceResponse xsi:nil="true" />
            <ShipmentComplianceResponse xsi:nil="true" />
          </Shipments>
        </SalesOrder>
      </CheckComplianceOfAndCommitSalesOrderResult>
    </CheckComplianceOfAndCommitSalesOrderResponse>
  </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 /Services/1.2/SalesOrderService.asmx HTTP/1.1
Host: ws.shipcompliant.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>
    <CheckComplianceOfAndCommitSalesOrder xmlns="http://ws.shipcompliant.com/">
      <Request>
        <AddressOption>
          <IgnoreStreetLevelErrors>boolean</IgnoreStreetLevelErrors>
          <RejectIfAddressSuggested>boolean</RejectIfAddressSuggested>
        </AddressOption>
        <CommitOption>Null or AllShipments or CompliantShipments</CommitOption>
        <IncludeSalesTaxRates>boolean</IncludeSalesTaxRates>
        <PersistOption>Null or OverrideExisting</PersistOption>
        <SalesOrder>
          <BillTo>
            <City>string</City>
            <Company>string</Company>
            <Country>string</Country>
            <County>string</County>
            <DateOfBirth>dateTime</DateOfBirth>
            <Email>string</Email>
            <Fax>string</Fax>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <Phone>string</Phone>
            <State>string</State>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <Zip1>string</Zip1>
            <Zip2>string</Zip2>
          </BillTo>
          <CashierKey>string</CashierKey>
          <CustomerKey>string</CustomerKey>
          <Discounts>
            <SalesOrderDiscount xsi:nil="true" />
            <SalesOrderDiscount xsi:nil="true" />
          </Discounts>
          <ExternalCustomerKey>string</ExternalCustomerKey>
          <ExternalOfferKeys>
            <string>string</string>
            <string>string</string>
          </ExternalOfferKeys>
          <ExternalSalesOrderKey>string</ExternalSalesOrderKey>
          <FulfillmentType>Null or Club or Daily</FulfillmentType>
          <OrderType>Null or Club or Fax or InPerson or Internet or Mail or Phone</OrderType>
          <Payments>
            <Payment xsi:nil="true" />
            <Payment xsi:nil="true" />
          </Payments>
          <PurchaseDate>dateTime</PurchaseDate>
          <ReferenceNumber>string</ReferenceNumber>
          <RefundedOrderReference>string</RefundedOrderReference>
          <RegisterID>string</RegisterID>
          <SalesAssociateKey>string</SalesAssociateKey>
          <SalesOrderKey>string</SalesOrderKey>
          <SalesTaxCollected>decimal</SalesTaxCollected>
          <SettlementBatchNumber>string</SettlementBatchNumber>
          <Shipments>
            <Shipment xsi:nil="true" />
            <Shipment xsi:nil="true" />
          </Shipments>
          <Tags>
            <Tag xsi:nil="true" />
            <Tag xsi:nil="true" />
          </Tags>
        </SalesOrder>
      </Request>
    </CheckComplianceOfAndCommitSalesOrder>
  </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>
    <CheckComplianceOfAndCommitSalesOrderResponse xmlns="http://ws.shipcompliant.com/">
      <CheckComplianceOfAndCommitSalesOrderResult>
        <Errors>
          <Error>
            <Code>string</Code>
            <Data xsi:nil="true" />
            <Key>string</Key>
            <Message>string</Message>
            <Target>Null or Address or Age or Batch or Brand or Distributor or Product or SalesOrder or Shipment or Tax or SSO or License or HoldLocation</Target>
            <Type>Authentication or Server or Validation</Type>
          </Error>
          <Error>
            <Code>string</Code>
            <Data xsi:nil="true" />
            <Key>string</Key>
            <Message>string</Message>
            <Target>Null or Address or Age or Batch or Brand or Distributor or Product or SalesOrder or Shipment or Tax or SSO or License or HoldLocation</Target>
            <Type>Authentication or Server or Validation</Type>
          </Error>
        </Errors>
        <ResponseStatus>Failure or Success</ResponseStatus>
        <SalesOrder>
          <IsCompliant>boolean</IsCompliant>
          <Key>string</Key>
          <SalesTaxRates>
            <RecommendedSalesTaxDue>decimal</RecommendedSalesTaxDue>
            <ShipmentSalesTaxRates xsi:nil="true" />
          </SalesTaxRates>
          <Shipments>
            <ShipmentComplianceResponse xsi:nil="true" />
            <ShipmentComplianceResponse xsi:nil="true" />
          </Shipments>
        </SalesOrder>
      </CheckComplianceOfAndCommitSalesOrderResult>
    </CheckComplianceOfAndCommitSalesOrderResponse>
  </soap12:Body>
</soap12:Envelope>