SalesOrderService Web Service

SalesOrderService

Click here for a complete list of operations.

CommitSalesOrder

Commits the specified salesorder.

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

<?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>
    <CommitSalesOrder xmlns="http://ws.shipcompliant.com/">
      <Request>
        <CommitOption>Null or AllShipments or CompliantShipments</CommitOption>
        <ExternalSalesOrderKey>string</ExternalSalesOrderKey>
        <Payments>
          <Payment>
            <Amount>decimal</Amount>
            <SubType>string</SubType>
            <TransactionID>string</TransactionID>
            <Type>string</Type>
          </Payment>
          <Payment>
            <Amount>decimal</Amount>
            <SubType>string</SubType>
            <TransactionID>string</TransactionID>
            <Type>string</Type>
          </Payment>
        </Payments>
        <SalesTaxCollected>decimal</SalesTaxCollected>
        <SalesOrderKey>string</SalesOrderKey>
      </Request>
    </CommitSalesOrder>
  </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>
    <CommitSalesOrderResponse xmlns="http://ws.shipcompliant.com/">
      <CommitSalesOrderResult>
        <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>
        <Shipments>
          <ShipmentCommitResponse>
            <Key>string</Key>
            <IsCommitted>boolean</IsCommitted>
          </ShipmentCommitResponse>
          <ShipmentCommitResponse>
            <Key>string</Key>
            <IsCommitted>boolean</IsCommitted>
          </ShipmentCommitResponse>
        </Shipments>
      </CommitSalesOrderResult>
    </CommitSalesOrderResponse>
  </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>
    <CommitSalesOrder xmlns="http://ws.shipcompliant.com/">
      <Request>
        <CommitOption>Null or AllShipments or CompliantShipments</CommitOption>
        <ExternalSalesOrderKey>string</ExternalSalesOrderKey>
        <Payments>
          <Payment>
            <Amount>decimal</Amount>
            <SubType>string</SubType>
            <TransactionID>string</TransactionID>
            <Type>string</Type>
          </Payment>
          <Payment>
            <Amount>decimal</Amount>
            <SubType>string</SubType>
            <TransactionID>string</TransactionID>
            <Type>string</Type>
          </Payment>
        </Payments>
        <SalesTaxCollected>decimal</SalesTaxCollected>
        <SalesOrderKey>string</SalesOrderKey>
      </Request>
    </CommitSalesOrder>
  </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>
    <CommitSalesOrderResponse xmlns="http://ws.shipcompliant.com/">
      <CommitSalesOrderResult>
        <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>
        <Shipments>
          <ShipmentCommitResponse>
            <Key>string</Key>
            <IsCommitted>boolean</IsCommitted>
          </ShipmentCommitResponse>
          <ShipmentCommitResponse>
            <Key>string</Key>
            <IsCommitted>boolean</IsCommitted>
          </ShipmentCommitResponse>
        </Shipments>
      </CommitSalesOrderResult>
    </CommitSalesOrderResponse>
  </soap12:Body>
</soap12:Envelope>