OrderService Web Service

OrderService

Click here for a complete list of operations.

GetOrderByPoNumber

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 /public/orderservice.asmx HTTP/1.1
Host: test-api.mypropago.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.mypropago.com/Public/OrderService/GetOrderByPoNumber"

<?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>
    <GetOrderByPoNumber xmlns="https://api.mypropago.com/Public/OrderService">
      <credentials>
        <CustomerName>string</CustomerName>
        <ApiKey>string</ApiKey>
      </credentials>
      <purchaseOrderNumber>string</purchaseOrderNumber>
    </GetOrderByPoNumber>
  </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>
    <GetOrderByPoNumberResponse xmlns="https://api.mypropago.com/Public/OrderService">
      <GetOrderByPoNumberResult>
        <ReturnCode>Undefined or Success or OrderRetrievedSuccessfully or ShipmentCreatedSuccessfuly or InvalidLoginNameKeyCombination or UnAuthorizedAccess or InvalidOrderNumber or InvalidCarrierName or ShipmentHasAlreadyBeenSubmittedForThisOrder or UnexpectedErrorOnServer or ServiceTypeNotEnabled or OrderProcessIncomplete or OrderPlacementError or NoShipmentsFoundForOrder or SkuCreationError or SkuNotFound or SearchError or CompanyCredentialsRequired or InvalidShipmentQuantity or InvalidOrderLineId or ShipmentError or ShipmentNotFound or InvalidOrderOperation or PaymentProcessingError or NoShipmentData or NoData or PriceListNotFound or InvalidInventoryQuantity or SeeDataForDetails or InvalidOrderLineStatus or OrderCannotShip or Error</ReturnCode>
        <Data>
          <OrderUser>
            <Email>string</Email>
            <Username>string</Username>
            <ExternalId>string</ExternalId>
          </OrderUser>
          <OrderNumber>string</OrderNumber>
          <OrderTag>string</OrderTag>
          <PoNumber>string</PoNumber>
          <Comments>string</Comments>
          <CompanyName>string</CompanyName>
          <CompanyGuid>string</CompanyGuid>
          <Status>string</Status>
          <EmailAddress>string</EmailAddress>
          <ShippingAndHandling>double</ShippingAndHandling>
          <Tax>double</Tax>
          <Discount>decimal</Discount>
          <OrderDate>dateTime</OrderDate>
          <DesiredShipDate>dateTime</DesiredShipDate>
          <Carrier>string</Carrier>
          <ShippingAddress>
            <Company>string</Company>
            <Name>string</Name>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <City>string</City>
            <State>string</State>
            <Country>string</Country>
            <TaxId>string</TaxId>
            <CountryName>string</CountryName>
            <ZipCode>string</ZipCode>
            <PhoneNumber>string</PhoneNumber>
            <IsResidential>boolean</IsResidential>
          </ShippingAddress>
          <BillingAddress>
            <Company>string</Company>
            <Name>string</Name>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <City>string</City>
            <State>string</State>
            <Country>string</Country>
            <TaxId>string</TaxId>
            <ZipCode>string</ZipCode>
            <PhoneNumber>string</PhoneNumber>
            <IsResidential>boolean</IsResidential>
          </BillingAddress>
          <Lines>
            <OrderLine xsi:nil="true" />
            <OrderLine xsi:nil="true" />
          </Lines>
          <OrderField1>string</OrderField1>
          <OrderField2>string</OrderField2>
          <OrderField3>string</OrderField3>
          <OrderField4>string</OrderField4>
          <OrderField5>string</OrderField5>
          <CompanyExternalId1>string</CompanyExternalId1>
          <CompanyExternalId2>string</CompanyExternalId2>
          <CurrencyCode>string</CurrencyCode>
          <IsResidential>boolean</IsResidential>
          <Expedited>boolean</Expedited>
          <IsSignatureRequired>boolean</IsSignatureRequired>
          <CustomFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomFields>
        </Data>
        <Message>string</Message>
        <ErrorGuid>string</ErrorGuid>
      </GetOrderByPoNumberResult>
    </GetOrderByPoNumberResponse>
  </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 /public/orderservice.asmx HTTP/1.1
Host: test-api.mypropago.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>
    <GetOrderByPoNumber xmlns="https://api.mypropago.com/Public/OrderService">
      <credentials>
        <CustomerName>string</CustomerName>
        <ApiKey>string</ApiKey>
      </credentials>
      <purchaseOrderNumber>string</purchaseOrderNumber>
    </GetOrderByPoNumber>
  </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>
    <GetOrderByPoNumberResponse xmlns="https://api.mypropago.com/Public/OrderService">
      <GetOrderByPoNumberResult>
        <ReturnCode>Undefined or Success or OrderRetrievedSuccessfully or ShipmentCreatedSuccessfuly or InvalidLoginNameKeyCombination or UnAuthorizedAccess or InvalidOrderNumber or InvalidCarrierName or ShipmentHasAlreadyBeenSubmittedForThisOrder or UnexpectedErrorOnServer or ServiceTypeNotEnabled or OrderProcessIncomplete or OrderPlacementError or NoShipmentsFoundForOrder or SkuCreationError or SkuNotFound or SearchError or CompanyCredentialsRequired or InvalidShipmentQuantity or InvalidOrderLineId or ShipmentError or ShipmentNotFound or InvalidOrderOperation or PaymentProcessingError or NoShipmentData or NoData or PriceListNotFound or InvalidInventoryQuantity or SeeDataForDetails or InvalidOrderLineStatus or OrderCannotShip or Error</ReturnCode>
        <Data>
          <OrderUser>
            <Email>string</Email>
            <Username>string</Username>
            <ExternalId>string</ExternalId>
          </OrderUser>
          <OrderNumber>string</OrderNumber>
          <OrderTag>string</OrderTag>
          <PoNumber>string</PoNumber>
          <Comments>string</Comments>
          <CompanyName>string</CompanyName>
          <CompanyGuid>string</CompanyGuid>
          <Status>string</Status>
          <EmailAddress>string</EmailAddress>
          <ShippingAndHandling>double</ShippingAndHandling>
          <Tax>double</Tax>
          <Discount>decimal</Discount>
          <OrderDate>dateTime</OrderDate>
          <DesiredShipDate>dateTime</DesiredShipDate>
          <Carrier>string</Carrier>
          <ShippingAddress>
            <Company>string</Company>
            <Name>string</Name>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <City>string</City>
            <State>string</State>
            <Country>string</Country>
            <TaxId>string</TaxId>
            <CountryName>string</CountryName>
            <ZipCode>string</ZipCode>
            <PhoneNumber>string</PhoneNumber>
            <IsResidential>boolean</IsResidential>
          </ShippingAddress>
          <BillingAddress>
            <Company>string</Company>
            <Name>string</Name>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <City>string</City>
            <State>string</State>
            <Country>string</Country>
            <TaxId>string</TaxId>
            <ZipCode>string</ZipCode>
            <PhoneNumber>string</PhoneNumber>
            <IsResidential>boolean</IsResidential>
          </BillingAddress>
          <Lines>
            <OrderLine xsi:nil="true" />
            <OrderLine xsi:nil="true" />
          </Lines>
          <OrderField1>string</OrderField1>
          <OrderField2>string</OrderField2>
          <OrderField3>string</OrderField3>
          <OrderField4>string</OrderField4>
          <OrderField5>string</OrderField5>
          <CompanyExternalId1>string</CompanyExternalId1>
          <CompanyExternalId2>string</CompanyExternalId2>
          <CurrencyCode>string</CurrencyCode>
          <IsResidential>boolean</IsResidential>
          <Expedited>boolean</Expedited>
          <IsSignatureRequired>boolean</IsSignatureRequired>
          <CustomFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomFields>
        </Data>
        <Message>string</Message>
        <ErrorGuid>string</ErrorGuid>
      </GetOrderByPoNumberResult>
    </GetOrderByPoNumberResponse>
  </soap12:Body>
</soap12:Envelope>