s1 API Host

<back to all web services

MagentoOrdersRequest

The following routes are available for this service:
POST, OPTIONS/api/magento-ordersGet a list orders by Magento ordernumber ordered by order date (latest first)Only possible if the user is authenticated
Parameters:
NameParameterData TypeRequiredDescription
MagentoOrderNumberquerystringYesMagentoOrderNumber

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/MagentoOrdersRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: application/xml
Content-Length: length

<MagentoOrdersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Orders">
  <MagentoOrderNumber>String</MagentoOrderNumber>
</MagentoOrdersRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MagentoOrdersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Orders">
  <CanBeCancelled>false</CanBeCancelled>
  <DebtorId>String</DebtorId>
  <DeliveryAddress>String</DeliveryAddress>
  <DeliveryCity>String</DeliveryCity>
  <DeliveryCountry>String</DeliveryCountry>
  <DeliveryEmailAddress>String</DeliveryEmailAddress>
  <DeliveryName>String</DeliveryName>
  <DeliveryPhoneNumber>String</DeliveryPhoneNumber>
  <DeliveryZipCode>String</DeliveryZipCode>
  <ExternalSystemId>String</ExternalSystemId>
  <HadErrors>false</HadErrors>
  <InvoiceAddress>String</InvoiceAddress>
  <InvoiceCity>String</InvoiceCity>
  <InvoiceCountry>String</InvoiceCountry>
  <InvoiceName>String</InvoiceName>
  <InvoiceZipCode>String</InvoiceZipCode>
  <IsAllPalletOrders>false</IsAllPalletOrders>
  <IsAlreadyCancelled>false</IsAlreadyCancelled>
  <MagentoOrderNumber>String</MagentoOrderNumber>
  <MagentoOrders i:nil="true" />
  <Reasons xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <ReasonsMatrix i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <Transporters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <UrgentMessages xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.UrgentMessages" i:nil="true" />
  <Uuid>String</Uuid>
</MagentoOrdersResponse>