Search_PurchaseOrders

post deprecatedhttps://eu-ext.linnworks.net/api/PurchaseOrder/Search_PurchaseOrders

Searches purchase order by a number of parameters, such as Date of Purchase, status, reference number.
Returns paged result of purchase order header.
Permissions Required: GlobalPermissions.Inventory.PurchaseOrder.SearchPurchaseOrderNode
Rate limit: 250 / minute

Response

Response body

object

Result

array of objects

List of purchase order headers

Result

object

pkPurchaseID

uuid

Unique identifier for the purchase order. You have to use this ID for all updates to the PO

fkSupplierId

uuid

Unique identifier for the supplier. Empty Guid is default supplier. Otherwise use Supplier API to get the names and additional data for the supplier

fkLocationId

uuid

Unique idenfidier of the location where the PO is expected to be delivered to. Empty Guid is default location. Use Locations API methods to get the names and additional details for the locations

ExternalInvoiceNumber

string

Purchase order reference number

Status

string

Purchase order status.
PENDING - purchase order can be changed, not yet affecting stock levels
OPEN - purchase order is created and stock levels Due are reflected
PARTIAL - partially delivered
DELIVERED - fully delivered

PENDING OPEN PARTIAL DELIVERED

Currency

string

Currency of the monetary values in the purchase order

SupplierReferenceNumber

string

Supplier reference number for the purchase order

Locked

boolean

Identified whether the PO is locked. This is for external application use only.

UnitAmountTaxIncludedType

int32

Unit amount includes,exclud or no tax. 0 - Tax Exclusive cost, 1 - Cost Inclusive of tax, 2 - No Tax

LineCount

int32

Number of items in the purchase order

DeliveredLinesCount

int32

Count of all purchase order lines which are delivered
(lines where some but not all of the stock has been received are counted as undelivered)

DateOfPurchase

date-time

DateTime of the purchase order UTC

DateOfDelivery

date-time

DateTime of the purchase order delivered, will be set to DateOfPurchase until the PO is fully delivered UTC

QuotedDeliveryDate

date-time

DateTime of the purchase order qouted/expected delivery date UTC

PostagePaid

double

DEPRECIATED
Use additional costs with Shipping flag to record shipping costs. This field remains available in the API for backward compatibility and acts pretty much like an additional cost item with type id = 0

TotalCost

double

Total purchase price of the purchase order. Calculated from all purchase order items including tax and postage.

taxPaid

double

Total tax of the purchase order. Calculated from all purchase order items (excludes postage).

ShippingTaxRate

double

ConversionRate

double

Conversion rate of the purchase order currency. When PO is delivered Stock Value will be multipled by this conversion rate. For example if your system currency is GBP and Purchase order is in EUR the conversion rate is 0.81.

ConvertedShippingCost

double

Total shipping cost of the purchase order, converted to system currency

ConvertedShippingTax

double

Total shipping cost tax of the purchase order, converted to system currency

ConvertedOtherCost

double

Total amount of additional costs of the purchase order, converted to system currency

ConvertedOtherTax

double

Total tax amount of additional costs of the purchase order, converted to system currency

ConvertedGrandTotal

double

Total amount of the purchase order, converted to system currency

TotalPages

int32

Total number of pages

CurrentPageNumber

int32

Currently request page number

EntriesPerPage

int32

Requested entries per page

TotalNumberOfRecords

int32

Total number of records matching the search request

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://eu-ext.linnworks.net/api/PurchaseOrder/Search_PurchaseOrders \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
34
}
1
{
2
  "Result": [
3
    {
4
      "pkPurchaseID": "00000000-0000-0000-0000-000000000000",
5
      "fkSupplierId": "00000000-0000-0000-0000-000000000000",
6
      "fkLocationId": "00000000-0000-0000-0000-000000000000",
7
      "ExternalInvoiceNumber": "string",
8
      "Status": "PENDING",
9
      "Currency": "string",
10
      "SupplierReferenceNumber": "string",
11
      "Locked": true,
12
      "UnitAmountTaxIncludedType": 0,
13
      "LineCount": 0,
14
      "DeliveredLinesCount": 0,
15
      "DateOfPurchase": "2025-05-31T05:54:11.366Z",
16
      "DateOfDelivery": "2025-05-31T05:54:11.366Z",
17
      "QuotedDeliveryDate": "2025-05-31T05:54:11.366Z",
18
      "PostagePaid": 0,
19
      "TotalCost": 0,
20
      "taxPaid": 0,
21
      "ShippingTaxRate": 0,
22
      "ConversionRate": 0,
23
      "ConvertedShippingCost": 0,
24
      "ConvertedShippingTax": 0,
25
      "ConvertedOtherCost": 0,

200OK