nOrderId - The Linnworks Order Id

o.PostalTrackingNumber - A tracking number that has been applied to the order

ReferenceNum - The reference number or channel reference number as downloaded from the channel

CustomerName -  This is the Customer Name from the order or customer Id

o.cEmailAddress - The email address associated with the shipping details

o.cPostCode - The shipping post code

ShippingAddress - This will match based on any part of the shipping address

SKU - This can be either the Linnworks SKU or barcode for an order item

Source - This is the sales channel the order was placed on; such as Amazon or eBay

SubSource - This is the specific integration the order was downloaded from


So as an example if you are using the ALLDATE date type and you are looking for the exact match you can use a shortend version of the request body:


dateType=ALLDATES&searchField=SKU&exactMatch=true&searchTerm=SKU123&pageNum=1&numEntriesPerPage=22 


The search term in bold red in this example is just a generic test SKU and you will need to change this to a Sku on your database that you are looking for.


When using exact match, the call will return all results for that search criteria.


if you are using the ALLDATE date type and you are not looking for the exact match you can use a shortend version of the request body:


dateType=ALLDATES&searchField=SKU&exactMatch=false&searchTerm=SKU1&pageNum=1&numEntriesPerPage=22


When not using exact match the call will attempt to return results based on a partial match. However, this will limit the search to the past 3 months worth of data.


If you are using a date range, the maximum date range you can use is 3 months and this will pull all orders within that 3 month period.


You will set a date range and need to change the search date type to one of the following:


RECEIVED - order received date

PROCESSED - processed date

PAYMENTRECEIVED - payment received date


Here's another example:


1-27-2017 0:0:0&to=4-27-2017 23:59:59&dateType=RECEIVED&searchField=nOrderId&exactMatch=true&searchTerm=&pageNum=1&numEntriesPerPage=22