API - GetOrder

Overview

Endpoint URL https://www.yournetosite.com.au/do/WS/NetoAPI
Method POST
XML Headers
NETOAPI_ACTION GetOrder
NETOAPI_USERNAME Your Neto Username (generate this in your Neto control panel)
NETOAPI_KEY Your Neto API Secure Key (generate this in your Neto control panel)
JSON Headers
NETOAPI_ACTION GetOrder
NETOAPI_USERNAME Your Neto Username (generate this in your Neto control panel)
NETOAPI_KEY Your Neto API Secure Key (generate this in your Neto control panel)
Accept application/json
Description Use this call to get order/invoice data. A successful call to GetOrder returns the data requested.
XSD Schema GetOrder XSD   |   GetOrder Response XSD

GetOrder Post

You must specify at least one filter and one OutputSelector in your GetOrder request. These will determine the results returned.

XML POST

<?xml version="1.0" encoding="utf-8"?>
<GetOrder>
  <Filter>
    <OrderID>(String)</OrderID>
    <Username>(String)</Username>
    <SKU>(String)</SKU>
    <Supplier>(String)</Supplier>
    <OrderStatus>New</OrderStatus>
    <OrderStatus>New Backorder</OrderStatus>
    <OrderStatus>Backorder Approved</OrderStatus>
    <OrderStatus>Pick</OrderStatus>
    <OrderStatus>Pack</OrderStatus>
    <OrderStatus>Pending Pickup</OrderStatus>
    <OrderStatus>Pending Dispatch</OrderStatus>
    <OrderStatus>Dispatched</OrderStatus>
    <OrderStatus>Cancelled</OrderStatus>
    <OrderStatus>Uncommitted</OrderStatus>
    <OrderStatus>On Hold</OrderStatus>
    <OrderType>sales</OrderType>
    <OrderType>dropshipping</OrderType>
    <OnHoldType>On Hold</OnHoldType>
    <OnHoldType>Layby</OnHoldType>
    <CompleteStatus>Approved</CompleteStatus>
    <CompleteStatus>Incomplete</CompleteStatus>
    <PaymentStatus>FullyPaid</PaymentStatus>
    <PaymentStatus>PartialPaid</PaymentStatus>
    <PaymentStatus>Pending</PaymentStatus>
    <ExportStatus>Pending</ExportStatus>
    <ExportStatus>Exported</ExportStatus>
    <WarehouseID>(Integer)</WarehouseID>
    <ExportedToWMS>(Boolean)</ExportedToWMS>
    <ShippingMethod>(String)</ShippingMethod>
    <SalesChannel>(String)</SalesChannel>
    <DatePaidFrom>(DateTime)</DatePaidFrom>
    <DatePaidTo>(DateTime)</DatePaidTo>
    <DateRequiredFrom>(DateTime)</DateRequiredFrom>
    <DateRequiredTo>(DateTime)</DateRequiredTo>
    <DateInvoicedFrom>(DateTime)</DateInvoicedFrom>
    <DateInvoicedTo>(DateTime)</DateInvoicedTo>
    <DatePlacedFrom>(DateTime)</DatePlacedFrom>
    <DatePlacedTo>(DateTime)</DatePlacedTo>
    <DateUpdatedFrom>(DateTime)</DateUpdatedFrom>
    <DateUpdatedTo>(DateTime)</DateUpdatedTo>
    <DateCompletedFrom>(DateTime)</DateCompletedFrom>
    <DateCompletedTo>(DateTime)</DateCompletedTo>
    <WarehouseQuantityUpdatedFrom>(DateTime)</WarehouseQuantityUpdatedFrom>
    <WarehouseQuantityUpdatedTo>(DateTime)</WarehouseQuantityUpdatedTo>
    <SplitKitComponents>(Boolean)</SplitKitComponents>
    <Page>(Integer)</Page>
    <Limit>(Integer)</Limit>
    <OutputSelector>ID</OutputSelector>
    <OutputSelector>ShippingOption</OutputSelector>
    <OutputSelector>DeliveryInstruction</OutputSelector>
    <OutputSelector>RelatedOrderID</OutputSelector>
    <OutputSelector>Username</OutputSelector>
    <OutputSelector>Email</OutputSelector>
    <OutputSelector>ShipAddress</OutputSelector>
    <OutputSelector>BillAddress</OutputSelector>
    <OutputSelector>PurchaseOrderNumber</OutputSelector>
    <OutputSelector>SalesPerson</OutputSelector>
    <OutputSelector>CustomerRef1</OutputSelector>
    <OutputSelector>CustomerRef2</OutputSelector>
    <OutputSelector>CustomerRef3</OutputSelector>
    <OutputSelector>CustomerRef4</OutputSelector>
    <OutputSelector>CustomerRef5</OutputSelector>
    <OutputSelector>CustomerRef6</OutputSelector>
    <OutputSelector>CustomerRef7</OutputSelector>
    <OutputSelector>CustomerRef8</OutputSelector>
    <OutputSelector>CustomerRef9</OutputSelector>
    <OutputSelector>CustomerRef10</OutputSelector>
    <OutputSelector>SalesChannel</OutputSelector>
    <OutputSelector>GrandTotal</OutputSelector>
    <OutputSelector>TaxInclusive</OutputSelector>
    <OutputSelector>OrderTax</OutputSelector>
    <OutputSelector>SurchargeTotal</OutputSelector>
    <OutputSelector>SurchargeTaxable</OutputSelector>
    <OutputSelector>ProductSubtotal</OutputSelector>
    <OutputSelector>ShippingTotal</OutputSelector>
    <OutputSelector>ShippingTax</OutputSelector>
    <OutputSelector>ClientIPAddress</OutputSelector>
    <OutputSelector>CouponCode</OutputSelector>
    <OutputSelector>CouponDiscount</OutputSelector>
    <OutputSelector>ShippingDiscount</OutputSelector>
    <OutputSelector>OrderType</OutputSelector>
    <OutputSelector>OnHoldType</OutputSelector>
    <OutputSelector>OrderStatus</OutputSelector>
    <OutputSelector>OrderPayment</OutputSelector>
    <OutputSelector>OrderPayment.PaymentType</OutputSelector>
    <OutputSelector>OrderPayment.DatePaid</OutputSelector>
    <OutputSelector>DateUpdated</OutputSelector>
    <OutputSelector>DatePlaced</OutputSelector>
    <OutputSelector>DateRequired</OutputSelector>
    <OutputSelector>DateInvoiced</OutputSelector>
    <OutputSelector>DatePaid</OutputSelector>
    <OutputSelector>DateCompleted</OutputSelector>
    <OutputSelector>OrderLine</OutputSelector>
    <OutputSelector>OrderLine.ProductName</OutputSelector>
    <OutputSelector>OrderLine.ItemNotes</OutputSelector>
    <OutputSelector>OrderLine.SerialNumber</OutputSelector>
    <OutputSelector>OrderLine.PickQuantity</OutputSelector>
    <OutputSelector>OrderLine.BackorderQuantity</OutputSelector>
    <OutputSelector>OrderLine.UnitPrice</OutputSelector>
    <OutputSelector>OrderLine.Tax</OutputSelector>
    <OutputSelector>OrderLine.TaxCode</OutputSelector>
    <OutputSelector>OrderLine.WarehouseID</OutputSelector>
    <OutputSelector>OrderLine.WarehouseName</OutputSelector>
    <OutputSelector>OrderLine.WarehouseReference</OutputSelector>
    <OutputSelector>OrderLine.Quantity</OutputSelector>
    <OutputSelector>OrderLine.PercentDiscount</OutputSelector>
    <OutputSelector>OrderLine.ProductDiscount</OutputSelector>
    <OutputSelector>OrderLine.CouponDiscount</OutputSelector>
    <OutputSelector>OrderLine.CostPrice</OutputSelector>
    <OutputSelector>OrderLine.ShippingMethod</OutputSelector>
    <OutputSelector>OrderLine.ShippingTracking</OutputSelector>
    <OutputSelector>OrderLine.Weight</OutputSelector>
    <OutputSelector>OrderLine.Cubic</OutputSelector>
    <OutputSelector>OrderLine.Extra</OutputSelector>
    <OutputSelector>OrderLine.ExtraOptions</OutputSelector>
    <OutputSelector>OrderLine.BinLoc</OutputSelector>
    <OutputSelector>OrderLine.QuantityShipped</OutputSelector>
    <OutputSelector>ShippingSignature</OutputSelector>
    <OutputSelector>RealtimeConfirmation</OutputSelector>
    <OutputSelector>InternalOrderNotes</OutputSelector>
    <OutputSelector>OrderLine.eBay.eBayUsername</OutputSelector>
    <OutputSelector>OrderLine.eBay.eBayStoreName</OutputSelector>
    <OutputSelector>OrderLine.eBay.eBayTransactionID</OutputSelector>
    <OutputSelector>OrderLine.eBay.eBayAuctionID</OutputSelector>
    <OutputSelector>OrderLine.eBay.ListingType</OutputSelector>
    <OutputSelector>OrderLine.eBay.DateCreated</OutputSelector>
    <OutputSelector>CompleteStatus</OutputSelector>
    <OutputSelector>OrderLine.eBay.DatePaid</OutputSelector>
    <OutputSelector>UserGroup</OutputSelector>
    <OutputSelector>StickyNotes</OutputSelector>
    <UpdateResults>
      <ExportStatus></ExportStatus>
      <ExportedToWMS>(Boolean)</ExportedToWMS>
    </UpdateResults>
  </Filter>
</GetOrder>

JSON POST

{
  "Filter": {
    "OrderID":[
      "String"
      /*, ...*/
    ],
    "Username":[
      "String"
      /*, ...*/
    ],
    "SKU":[
      "String"
      /*, ...*/
    ],
    "Supplier":[
      "String"
      /*, ...*/
    ],
    "OrderStatus":[
      "Enumeration"
      /*, ...*/
    ],
    "OrderType":[
      "Enumeration"
      /*, ...*/
    ],
    "OnHoldType":[
      "Enumeration"
      /*, ...*/
    ],
    "CompleteStatus":[
      "Enumeration"
      /*, ...*/
    ],
    "PaymentStatus":[
      "Enumeration"
      /*, ...*/
    ],
    "ExportStatus":[
      "Enumeration"
      /*, ...*/
    ],
    "WarehouseID":[
      "Integer"
      /*, ...*/
    ],
    "ExportedToWMS":[
      "Boolean"
      /*, ...*/
    ],
    "ShippingMethod":[
      "String"
      /*, ...*/
    ],
    "SalesChannel":[
      "String"
      /*, ...*/
    ],
    "DatePaidFrom":"DateTime",
    "DatePaidTo":"DateTime",
    "DateRequiredFrom":"DateTime",
    "DateRequiredTo":"DateTime",
    "DateInvoicedFrom":"DateTime",
    "DateInvoicedTo":"DateTime",
    "DatePlacedFrom":"DateTime",
    "DatePlacedTo":"DateTime",
    "DateUpdatedFrom":"DateTime",
    "DateUpdatedTo":"DateTime",
    "DateCompletedFrom":"DateTime",
    "DateCompletedTo":"DateTime",
    "WarehouseQuantityUpdatedFrom":"DateTime",
    "WarehouseQuantityUpdatedTo":"DateTime",
    "SplitKitComponents":"Boolean",
    "Page":"Integer",
    "Limit":"Integer",
    "OutputSelector":[
      "Enumeration"
      /*, ...*/
    ],
    "UpdateResults": {
      "ExportStatus":"Enumeration",
      "ExportedToWMS":"Boolean"
    } 
  } 
}

<Filter>

Element Name Required Field Type / Options
OrderID Optional
Supports Multiple Elements
String(15)
Username Optional
Supports Multiple Elements
String(25)
SKU Optional
Supports Multiple Elements
String(25)
Supplier Optional
Supports Multiple Elements
String
OrderStatus Optional
Supports Multiple Elements
Enumeration(New, New Backorder, Backorder Approved, Pick, Pack, Pending Pickup, Pending Dispatch, Dispatched, Cancelled, Uncommitted, On Hold)
OrderType Optional
Supports Multiple Elements
Enumeration(sales, dropshipping)
OnHoldType Optional
Supports Multiple Elements
Enumeration(On Hold, Layby)
CompleteStatus Optional
Supports Multiple Elements
Enumeration(Approved, Incomplete)
PaymentStatus Optional
Supports Multiple Elements
Enumeration(FullyPaid, PartialPaid, Pending)
ExportStatus Optional
Supports Multiple Elements
Enumeration(Pending, Exported)
WarehouseID Optional
Supports Multiple Elements
Integer
ExportedToWMS Optional
Supports Multiple Elements
Boolean(True, False)
ShippingMethod Optional
Supports Multiple Elements
String(50)
SalesChannel Optional
Supports Multiple Elements
String(50)
DatePaidFrom Optional DateTime
DatePaidTo Optional DateTime
DateRequiredFrom Optional DateTime
DateRequiredTo Optional DateTime
DateInvoicedFrom Optional DateTime
DateInvoicedTo Optional DateTime
DatePlacedFrom Optional DateTime
DatePlacedTo Optional DateTime
DateUpdatedFrom Optional DateTime
DateUpdatedTo Optional DateTime
DateCompletedFrom Optional DateTime
DateCompletedTo Optional DateTime
WarehouseQuantityUpdatedFrom Optional DateTime
WarehouseQuantityUpdatedTo Optional DateTime
SplitKitComponents Optional Boolean(True, False)
Page Optional Integer
Limit Optional Integer

<OutputSelector>

Determines what is returned by the POST. Refer to the example response below this table or the related XSD schema for details and restrictions of each output element.

Note: Each OutputSelector should be a separate element in your post.

OutputSelector Enumeration (ID, ShippingOption, DeliveryInstruction, RelatedOrderID, Username, Email, ShipAddress, BillAddress, PurchaseOrderNumber, SalesPerson, CustomerRef1, CustomerRef2, CustomerRef3, CustomerRef4, CustomerRef5, CustomerRef6, CustomerRef7, CustomerRef8, CustomerRef9, CustomerRef10, SalesChannel, GrandTotal, TaxInclusive, OrderTax, SurchargeTotal, SurchargeTaxable, ProductSubtotal, ShippingTotal, ShippingTax, ClientIPAddress, CouponCode, CouponDiscount, ShippingDiscount, OrderType, OnHoldType, OrderStatus, OrderPayment, OrderPayment.PaymentType, OrderPayment.DatePaid, DateUpdated, DatePlaced, DateRequired, DateInvoiced, DatePaid, DateCompleted, OrderLine, OrderLine.ProductName, OrderLine.ItemNotes, OrderLine.SerialNumber, OrderLine.PickQuantity, OrderLine.BackorderQuantity, OrderLine.UnitPrice, OrderLine.Tax, OrderLine.TaxCode, OrderLine.WarehouseID, OrderLine.WarehouseName, OrderLine.WarehouseReference, OrderLine.Quantity, OrderLine.PercentDiscount, OrderLine.ProductDiscount, OrderLine.CouponDiscount, OrderLine.CostPrice, OrderLine.ShippingMethod, OrderLine.ShippingTracking, OrderLine.Weight, OrderLine.Cubic, OrderLine.Extra, OrderLine.ExtraOptions, OrderLine.BinLoc, OrderLine.QuantityShipped, ShippingSignature, RealtimeConfirmation, InternalOrderNotes, OrderLine.eBay.eBayUsername, OrderLine.eBay.eBayStoreName, OrderLine.eBay.eBayTransactionID, OrderLine.eBay.eBayAuctionID, OrderLine.eBay.ListingType, OrderLine.eBay.DateCreated, CompleteStatus, OrderLine.eBay.DatePaid, UserGroup, StickyNotes)
UpdateResults Optional UpdateResultsType

<UpdateResults>

Element Name Required Field Type / Options
ExportStatus Optional Enumeration(Pending, Exported)
ExportedToWMS Optional Boolean(True, False)

GetOrder Responses

XML Response

<?xml version="1.0" encoding="utf-8"?>
<GetOrder>
  <Order>
    <OrderLine>
      <Quantity>(Integer)</Quantity>
      <SKU>(String)</SKU>
      <OrderLineID>(String)</OrderLineID>
      <ProductName>(String)</ProductName>
      <ItemNotes>(String)</ItemNotes>
      <SerialNumber>(String)</SerialNumber>
      <PickQuantity>(String)</PickQuantity>
      <BackorderQuantity>(String)</BackorderQuantity>
      <UnitPrice>(String)</UnitPrice>
      <Tax>(String)</Tax>
      <TaxCode>(String)</TaxCode>
      <WarehouseID>(Integer)</WarehouseID>
      <WarehouseName>(String)</WarehouseName>
      <WarehouseReference>(String)</WarehouseReference>
      <PercentDiscount>(String)</PercentDiscount>
      <ProductDiscount>(String)</ProductDiscount>
      <CostPrice>(String)</CostPrice>
      <ShippingMethod>(String)</ShippingMethod>
      <ShippingTracking>(String)</ShippingTracking>
      <Shipping>(String)</Shipping>
      <Weight>(String)</Weight>
      <Cubic>(String)</Cubic>
      <Extra>(String)</Extra>
      <ExtraOptions>
        <ExtraOption>
          <Name>(String)</Name>
          <Value>(String)</Value>
        </ExtraOption>
      </ExtraOptions>
      <BinLoc>(String)</BinLoc>
      <QuantityShipped>(Integer)</QuantityShipped>
      <CouponDiscount>(String)</CouponDiscount>
      <eBay>
        <eBayUsername>(String)</eBayUsername>
        <eBayStoreName>(String)</eBayStoreName>
        <eBayAuctionID>(String)</eBayAuctionID>
        <eBayTransactionID>(String)</eBayTransactionID>
        <ListingType>(String)</ListingType>
        <DateCreated>(String)</DateCreated>
        <DatePaid>(String)</DatePaid>
      </eBay>
    </OrderLine>
    <OrderID>(String)</OrderID>
    <ID>(String)</ID>
    <ComponentOfKit>(String)</ComponentOfKit>
    <KitPartID>(String)</KitPartID>
    <ShippingOption>(String)</ShippingOption>
    <DeliveryInstruction>(String)</DeliveryInstruction>
    <RelatedOrderID>(String)</RelatedOrderID>
    <GrandTotal>(String)</GrandTotal>
    <TaxInclusive>(String)</TaxInclusive>
    <OrderTax>(String)</OrderTax>
    <SurchargeTotal>(String)</SurchargeTotal>
    <SurchargeTaxable>(String)</SurchargeTaxable>
    <ShippingTotal>(String)</ShippingTotal>
    <ShippingTax>(String)</ShippingTax>
    <ShippingDiscount>(String)</ShippingDiscount>
    <DateRequired>(String)</DateRequired>
    <DateInvoiced>(String)</DateInvoiced>
    <DatePaid>(String)</DatePaid>
    <DatePlaced>(String)</DatePlaced>
    <DateUpdated>(String)</DateUpdated>
    <ShippingSignature>(String)</ShippingSignature>
    <RealtimeConfirmation>(String)</RealtimeConfirmation>
    <InternalOrderNotes>(String)</InternalOrderNotes>
    <Username>(String)</Username>
    <OrderStatus>(String)</OrderStatus>
    <OrderType>(String)</OrderType>
    <OnHoldType>(String)</OnHoldType>
    <Email>(String)</Email>
    <SalesPerson>(String)</SalesPerson>
    <CustomerRef1>(String)</CustomerRef1>
    <CustomerRef2>(String)</CustomerRef2>
    <CustomerRef3>(String)</CustomerRef3>
    <CustomerRef4>(String)</CustomerRef4>
    <CustomerRef5>(String)</CustomerRef5>
    <CustomerRef6>(String)</CustomerRef6>
    <CustomerRef7>(String)</CustomerRef7>
    <CustomerRef8>(String)</CustomerRef8>
    <CustomerRef9>(String)</CustomerRef9>
    <CustomerRef10>(String)</CustomerRef10>
    <SalesChannel>(String)</SalesChannel>
    <ShipFirstName>(String)</ShipFirstName>
    <ShipLastName>(String)</ShipLastName>
    <ShipCompany>(String)</ShipCompany>
    <ShipStreetLine1>(String)</ShipStreetLine1>
    <ShipStreetLine2>(String)</ShipStreetLine2>
    <ShipCity>(String)</ShipCity>
    <ShipCountry>(String)</ShipCountry>
    <ShipState>(String)</ShipState>
    <ShipPostCode>(String)</ShipPostCode>
    <ShipPhone>(String)</ShipPhone>
    <ShipFax>(String)</ShipFax>
    <BillFirstName>(String)</BillFirstName>
    <BillLastName>(String)</BillLastName>
    <BillCompany>(String)</BillCompany>
    <BillStreetLine1>(String)</BillStreetLine1>
    <BillStreetLine2>(String)</BillStreetLine2>
    <BillCity>(String)</BillCity>
    <BillCountry>(String)</BillCountry>
    <BillState>(String)</BillState>
    <BillPostCode>(String)</BillPostCode>
    <BillPhone>(String)</BillPhone>
    <BillFax>(String)</BillFax>
    <ProductSubtotal>(String)</ProductSubtotal>
    <PurchaseOrderNumber>(String)</PurchaseOrderNumber>
    <CouponCode>(String)</CouponCode>
    <CouponDiscount>(String)</CouponDiscount>
    <CompleteStatus>(String)</CompleteStatus>
    <eBay>
      <eBayUsername>(String)</eBayUsername>
    </eBay>
    <OrderPayment>
      <OrderPaymentId>(String)</OrderPaymentId>
      <OrderPaymentAmount>(String)</OrderPaymentAmount>
      <PaymentType>(String)</PaymentType>
    </OrderPayment>
    <StickyNotes>
      <StickyNoteID>(String)</StickyNoteID>
      <Title>(String)</Title>
      <Description>(String)</Description>
    </StickyNotes>
  </Order>  <Messages>
    <Error>
      <Message>(String)</Message>
      <SeverityCode>(String)</SeverityCode>
      <Description>(String)</Description>
    </Error>
    <Warning>
      <Message>(String)</Message>
      <SeverityCode>(String)</SeverityCode>
    </Warning>
  </Messages>
</GetOrder>

JSON Response

{
  "Order": [ {
    "OrderLine": [ {
      "Quantity":"Integer",
      "SKU":"String",
      "OrderLineID":"String",
      "ProductName":"String",
      "ItemNotes":"String",
      "SerialNumber":"String",
      "PickQuantity":"String",
      "BackorderQuantity":"String",
      "UnitPrice":"String",
      "Tax":"String",
      "TaxCode":"String",
      "WarehouseID":"Integer",
      "WarehouseName":"String",
      "WarehouseReference":"String",
      "PercentDiscount":"String",
      "ProductDiscount":"String",
      "CostPrice":"String",
      "ShippingMethod":"String",
      "ShippingTracking":"String",
      "Shipping":"String",
      "Weight":"String",
      "Cubic":"String",
      "Extra":"String",
      "ExtraOptions": {
        "ExtraOption": [ {
          "Name":"String",
          "Value":"String"
        } ]
      } ,
      "BinLoc":"String",
      "QuantityShipped":"Integer",
      "CouponDiscount":"String",
      "eBay": {
        "eBayUsername":"String",
        "eBayStoreName":"String",
        "eBayAuctionID":"String",
        "eBayTransactionID":"String",
        "ListingType":"String",
        "DateCreated":"String",
        "DatePaid":"String"
      } 
    } ],
    "OrderID":"String",
    "ID":"String",
    "ComponentOfKit":"String",
    "KitPartID":"String",
    "ShippingOption":"String",
    "DeliveryInstruction":"String",
    "RelatedOrderID":"String",
    "GrandTotal":"String",
    "TaxInclusive":"String",
    "OrderTax":"String",
    "SurchargeTotal":"String",
    "SurchargeTaxable":"String",
    "ShippingTotal":"String",
    "ShippingTax":"String",
    "ShippingDiscount":"String",
    "DateRequired":"String",
    "DateInvoiced":"String",
    "DatePaid":"String",
    "DatePlaced":"String",
    "DateUpdated":"String",
    "ShippingSignature":"String",
    "RealtimeConfirmation":"String",
    "InternalOrderNotes":"String",
    "Username":"String",
    "OrderStatus":"String",
    "OrderType":"String",
    "OnHoldType":"String",
    "Email":"String",
    "SalesPerson":"String",
    "CustomerRef1":"String",
    "CustomerRef2":"String",
    "CustomerRef3":"String",
    "CustomerRef4":"String",
    "CustomerRef5":"String",
    "CustomerRef6":"String",
    "CustomerRef7":"String",
    "CustomerRef8":"String",
    "CustomerRef9":"String",
    "CustomerRef10":"String",
    "SalesChannel":"String",
    "ShipFirstName":"String",
    "ShipLastName":"String",
    "ShipCompany":"String",
    "ShipStreetLine1":"String",
    "ShipStreetLine2":"String",
    "ShipCity":"String",
    "ShipCountry":"String",
    "ShipState":"String",
    "ShipPostCode":"String",
    "ShipPhone":"String",
    "ShipFax":"String",
    "BillFirstName":"String",
    "BillLastName":"String",
    "BillCompany":"String",
    "BillStreetLine1":"String",
    "BillStreetLine2":"String",
    "BillCity":"String",
    "BillCountry":"String",
    "BillState":"String",
    "BillPostCode":"String",
    "BillPhone":"String",
    "BillFax":"String",
    "ProductSubtotal":"String",
    "PurchaseOrderNumber":"String",
    "CouponCode":"String",
    "CouponDiscount":"String",
    "CompleteStatus":"String",
    "eBay": {
      "eBayUsername":"String"
    } ,
    "OrderPayment": [ {
      "OrderPaymentId":"String",
      "OrderPaymentAmount":"String",
      "PaymentType":"String"
    } ],
    "StickyNotes": [ {
      "StickyNoteID":"String",
      "Title":"String",
      "Description":"String"
    } ]
  } ],  "Messages": {
    "Error": [ {
      "Message":"String",
      "SeverityCode":"String",
      "Description":"String"
    } ],
    "Warning": [ {
      "Message":"String",
      "SeverityCode":"String"
    } ]
  } 
}

<Order>

Element Name Field Type
OrderLine OrderLineType
OrderID String
ID String
ComponentOfKit String
KitPartID String
ShippingOption String
DeliveryInstruction String
RelatedOrderID String
GrandTotal String
TaxInclusive String
OrderTax String
SurchargeTotal String
SurchargeTaxable String
ShippingTotal String
ShippingTax String
ShippingDiscount String
DateRequired String
DateInvoiced String
DatePaid String
DatePlaced String
DateUpdated String
ShippingSignature String
RealtimeConfirmation String
InternalOrderNotes String
Username String
OrderStatus String
OrderType String
OnHoldType String
Email String
SalesPerson String
CustomerRef1 String
CustomerRef2 String
CustomerRef3 String
CustomerRef4 String
CustomerRef5 String
CustomerRef6 String
CustomerRef7 String
CustomerRef8 String
CustomerRef9 String
CustomerRef10 String
SalesChannel String
ShipFirstName String
ShipLastName String
ShipCompany String
ShipStreetLine1 String
ShipStreetLine2 String
ShipCity String
ShipCountry String
ShipState String
ShipPostCode String
ShipPhone String
ShipFax String
BillFirstName String
BillLastName String
BillCompany String
BillStreetLine1 String
BillStreetLine2 String
BillCity String
BillCountry String
BillState String
BillPostCode String
BillPhone String
BillFax String
ProductSubtotal String
PurchaseOrderNumber String
CouponCode String
CouponDiscount String
CompleteStatus String
eBay eBayType
OrderPayment OrderPaymentType
StickyNotes StickyNotesType

<OrderLine>

Element Name Field Type
Quantity Integer
SKU String
OrderLineID String
ProductName String
ItemNotes String
SerialNumber String
PickQuantity String
BackorderQuantity String
UnitPrice String
Tax String
TaxCode String
WarehouseID Integer
WarehouseName String
WarehouseReference String
PercentDiscount String
ProductDiscount String
CostPrice String
ShippingMethod String
ShippingTracking String
Shipping String
Weight String
Cubic String
Extra String
ExtraOptions ExtraOptionsType
BinLoc String
QuantityShipped Integer
CouponDiscount String
eBay eBayType

<ExtraOptions>

Element Name Field Type
ExtraOption ExtraOptionType

<ExtraOption>

Element Name Field Type
Name String
Value String

<eBay>

Element Name Field Type
eBayUsername String
eBayStoreName String
eBayAuctionID String
eBayTransactionID String
ListingType String
DateCreated String
DatePaid String

<eBay>

Element Name Field Type
eBayUsername String

<OrderPayment>

Element Name Field Type
OrderPaymentId String
OrderPaymentAmount String
PaymentType String

<StickyNotes>

Element Name Field Type
StickyNoteID String
Title String
Description String

<Messages>

Element Name Field Type
Error ErrorType
Warning WarningType

<Error>

Element Name Field Type
Message String
SeverityCode String
Description String

<Warning>

Element Name Field Type
Message String
SeverityCode String

More Examples

Get orders for multiple order status and mark as exported on success response.

GetOrder Post

XML
JSON

Get order details for a specific order (Order ID: N001001)

GerOrder POST

XML
JSON

Get all the order data you need to ship orders that have been approved to be shipped, are in the new or pick status and that have not yet been exported (pending export). On success response mark orders as exported. This call is typically used by 3PL, WMS and other 3rd party shipping apps.

GerOrder POST

XML
JSON

Sample Response (Success)

Showing multiple orders being returned for the above call.

XML
JSON