OrderService

Click here for a complete list of operations.

SearchOrders

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

<?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>
    <SearchOrders xmlns="https://api.mypropago.com/Public/OrderService">
      <credentials>
        <CustomerName>string</CustomerName>
        <ApiKey>string</ApiKey>
      </credentials>
      <searchFilter>
        <Skip>int</Skip>
        <Take>int</Take>
        <OrderNumber>string</OrderNumber>
        <OrderSubmittedStartDate>dateTime</OrderSubmittedStartDate>
        <OrderSubmittedEndDate>dateTime</OrderSubmittedEndDate>
        <Custom01>string</Custom01>
        <Custom02>string</Custom02>
        <Custom03>string</Custom03>
        <Custom04>string</Custom04>
        <Custom05>string</Custom05>
        <OrderTag>string</OrderTag>
        <PoNumber>string</PoNumber>
        <CompanyExternalId1>string</CompanyExternalId1>
        <CompanyExternalId2>string</CompanyExternalId2>
        <Status>Processing or Processed or Canceled or All or Saved or Pending or Released or Firmed or Closed or PendingApproval</Status>
        <ExplicitStatus>
          <SearchOrderStatus>Processing or Processed or Canceled or All or Saved or Pending or Released or Firmed or Closed or PendingApproval</SearchOrderStatus>
          <SearchOrderStatus>Processing or Processed or Canceled or All or Saved or Pending or Released or Firmed or Closed or PendingApproval</SearchOrderStatus>
        </ExplicitStatus>
        <IsTransmitted>boolean</IsTransmitted>
        <CompanyId>int</CompanyId>
      </searchFilter>
    </SearchOrders>
  </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>
    <SearchOrdersResponse xmlns="https://api.mypropago.com/Public/OrderService">
      <SearchOrdersResult>
        <TotalRecords>int</TotalRecords>
        <Skip>int</Skip>
        <Take>int</Take>
      </SearchOrdersResult>
    </SearchOrdersResponse>
  </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>
    <SearchOrders xmlns="https://api.mypropago.com/Public/OrderService">
      <credentials>
        <CustomerName>string</CustomerName>
        <ApiKey>string</ApiKey>
      </credentials>
      <searchFilter>
        <Skip>int</Skip>
        <Take>int</Take>
        <OrderNumber>string</OrderNumber>
        <OrderSubmittedStartDate>dateTime</OrderSubmittedStartDate>
        <OrderSubmittedEndDate>dateTime</OrderSubmittedEndDate>
        <Custom01>string</Custom01>
        <Custom02>string</Custom02>
        <Custom03>string</Custom03>
        <Custom04>string</Custom04>
        <Custom05>string</Custom05>
        <OrderTag>string</OrderTag>
        <PoNumber>string</PoNumber>
        <CompanyExternalId1>string</CompanyExternalId1>
        <CompanyExternalId2>string</CompanyExternalId2>
        <Status>Processing or Processed or Canceled or All or Saved or Pending or Released or Firmed or Closed or PendingApproval</Status>
        <ExplicitStatus>
          <SearchOrderStatus>Processing or Processed or Canceled or All or Saved or Pending or Released or Firmed or Closed or PendingApproval</SearchOrderStatus>
          <SearchOrderStatus>Processing or Processed or Canceled or All or Saved or Pending or Released or Firmed or Closed or PendingApproval</SearchOrderStatus>
        </ExplicitStatus>
        <IsTransmitted>boolean</IsTransmitted>
        <CompanyId>int</CompanyId>
      </searchFilter>
    </SearchOrders>
  </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>
    <SearchOrdersResponse xmlns="https://api.mypropago.com/Public/OrderService">
      <SearchOrdersResult>
        <TotalRecords>int</TotalRecords>
        <Skip>int</Skip>
        <Take>int</Take>
      </SearchOrdersResult>
    </SearchOrdersResponse>
  </soap12:Body>
</soap12:Envelope>