OrderService

Click here for a complete list of operations.

SubmitOrder

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

<?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>
    <SubmitOrder xmlns="https://api.mypropago.com/Public/OrderService">
      <credentials>
        <CustomerName>string</CustomerName>
        <ApiKey>string</ApiKey>
      </credentials>
      <order>
        <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>
            <LineId>string</LineId>
            <VendorId>int</VendorId>
            <LineNumber>int</LineNumber>
            <Price>decimal</Price>
            <Status>ApprovalPending or AwaitingPrepress or Assembly or Backordered or Bindery or Canceled or Closed or HandBindery or InPrintingQueue or OutOnProofApproval or PartialShip or Plating or Prepress or Print or ProofApprovalDenied or Released or Staging or Warehouse or ReadyForPrint or Batched or WarehouseStaging or Saved</Status>
            <EstimatedShipDate>dateTime</EstimatedShipDate>
            <Sku>string</Sku>
            <PrintFileUrl>string</PrintFileUrl>
            <ListFilUrl>string</ListFilUrl>
            <Quantity>int</Quantity>
            <FileUrl>string</FileUrl>
            <Thumbnail>string</Thumbnail>
            <UnitPrice>double</UnitPrice>
            <Part xsi:nil="true" />
            <Custom01>string</Custom01>
            <Custom02>string</Custom02>
            <Custom03>string</Custom03>
            <FulfillCharge>decimal</FulfillCharge>
            <DirectMailService>string</DirectMailService>
            <RevenueCost>decimal</RevenueCost>
            <FlatFee>decimal</FlatFee>
            <FlatFeeLabel>string</FlatFeeLabel>
            <SalesTax>decimal</SalesTax>
            <ProducingPartner>string</ProducingPartner>
            <EDeliveryUrl>string</EDeliveryUrl>
          </OrderLine>
          <OrderLine>
            <LineId>string</LineId>
            <VendorId>int</VendorId>
            <LineNumber>int</LineNumber>
            <Price>decimal</Price>
            <Status>ApprovalPending or AwaitingPrepress or Assembly or Backordered or Bindery or Canceled or Closed or HandBindery or InPrintingQueue or OutOnProofApproval or PartialShip or Plating or Prepress or Print or ProofApprovalDenied or Released or Staging or Warehouse or ReadyForPrint or Batched or WarehouseStaging or Saved</Status>
            <EstimatedShipDate>dateTime</EstimatedShipDate>
            <Sku>string</Sku>
            <PrintFileUrl>string</PrintFileUrl>
            <ListFilUrl>string</ListFilUrl>
            <Quantity>int</Quantity>
            <FileUrl>string</FileUrl>
            <Thumbnail>string</Thumbnail>
            <UnitPrice>double</UnitPrice>
            <Part xsi:nil="true" />
            <Custom01>string</Custom01>
            <Custom02>string</Custom02>
            <Custom03>string</Custom03>
            <FulfillCharge>decimal</FulfillCharge>
            <DirectMailService>string</DirectMailService>
            <RevenueCost>decimal</RevenueCost>
            <FlatFee>decimal</FlatFee>
            <FlatFeeLabel>string</FlatFeeLabel>
            <SalesTax>decimal</SalesTax>
            <ProducingPartner>string</ProducingPartner>
            <EDeliveryUrl>string</EDeliveryUrl>
          </OrderLine>
        </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>
            <Key>string</Key>
            <Value>string</Value>
          </CustomField>
          <CustomField>
            <Key>string</Key>
            <Value>string</Value>
          </CustomField>
        </CustomFields>
      </order>
    </SubmitOrder>
  </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>
    <SubmitOrderResponse xmlns="https://api.mypropago.com/Public/OrderService">
      <SubmitOrderResult>
        <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>string</Data>
        <Message>string</Message>
        <ErrorGuid>string</ErrorGuid>
      </SubmitOrderResult>
    </SubmitOrderResponse>
  </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>
    <SubmitOrder xmlns="https://api.mypropago.com/Public/OrderService">
      <credentials>
        <CustomerName>string</CustomerName>
        <ApiKey>string</ApiKey>
      </credentials>
      <order>
        <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>
            <LineId>string</LineId>
            <VendorId>int</VendorId>
            <LineNumber>int</LineNumber>
            <Price>decimal</Price>
            <Status>ApprovalPending or AwaitingPrepress or Assembly or Backordered or Bindery or Canceled or Closed or HandBindery or InPrintingQueue or OutOnProofApproval or PartialShip or Plating or Prepress or Print or ProofApprovalDenied or Released or Staging or Warehouse or ReadyForPrint or Batched or WarehouseStaging or Saved</Status>
            <EstimatedShipDate>dateTime</EstimatedShipDate>
            <Sku>string</Sku>
            <PrintFileUrl>string</PrintFileUrl>
            <ListFilUrl>string</ListFilUrl>
            <Quantity>int</Quantity>
            <FileUrl>string</FileUrl>
            <Thumbnail>string</Thumbnail>
            <UnitPrice>double</UnitPrice>
            <Part xsi:nil="true" />
            <Custom01>string</Custom01>
            <Custom02>string</Custom02>
            <Custom03>string</Custom03>
            <FulfillCharge>decimal</FulfillCharge>
            <DirectMailService>string</DirectMailService>
            <RevenueCost>decimal</RevenueCost>
            <FlatFee>decimal</FlatFee>
            <FlatFeeLabel>string</FlatFeeLabel>
            <SalesTax>decimal</SalesTax>
            <ProducingPartner>string</ProducingPartner>
            <EDeliveryUrl>string</EDeliveryUrl>
          </OrderLine>
          <OrderLine>
            <LineId>string</LineId>
            <VendorId>int</VendorId>
            <LineNumber>int</LineNumber>
            <Price>decimal</Price>
            <Status>ApprovalPending or AwaitingPrepress or Assembly or Backordered or Bindery or Canceled or Closed or HandBindery or InPrintingQueue or OutOnProofApproval or PartialShip or Plating or Prepress or Print or ProofApprovalDenied or Released or Staging or Warehouse or ReadyForPrint or Batched or WarehouseStaging or Saved</Status>
            <EstimatedShipDate>dateTime</EstimatedShipDate>
            <Sku>string</Sku>
            <PrintFileUrl>string</PrintFileUrl>
            <ListFilUrl>string</ListFilUrl>
            <Quantity>int</Quantity>
            <FileUrl>string</FileUrl>
            <Thumbnail>string</Thumbnail>
            <UnitPrice>double</UnitPrice>
            <Part xsi:nil="true" />
            <Custom01>string</Custom01>
            <Custom02>string</Custom02>
            <Custom03>string</Custom03>
            <FulfillCharge>decimal</FulfillCharge>
            <DirectMailService>string</DirectMailService>
            <RevenueCost>decimal</RevenueCost>
            <FlatFee>decimal</FlatFee>
            <FlatFeeLabel>string</FlatFeeLabel>
            <SalesTax>decimal</SalesTax>
            <ProducingPartner>string</ProducingPartner>
            <EDeliveryUrl>string</EDeliveryUrl>
          </OrderLine>
        </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>
            <Key>string</Key>
            <Value>string</Value>
          </CustomField>
          <CustomField>
            <Key>string</Key>
            <Value>string</Value>
          </CustomField>
        </CustomFields>
      </order>
    </SubmitOrder>
  </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>
    <SubmitOrderResponse xmlns="https://api.mypropago.com/Public/OrderService">
      <SubmitOrderResult>
        <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>string</Data>
        <Message>string</Message>
        <ErrorGuid>string</ErrorGuid>
      </SubmitOrderResult>
    </SubmitOrderResponse>
  </soap12:Body>
</soap12:Envelope>