Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

PurchaseOrder /Search_PurchaseOrders

Allows 250 calls per minute

Response: Search_PurchaseOrdersResult



Searches purchase order by a number of parameters, such as Date of Purchase, status, reference number.
Returns paged result of purchase order header.

Parameters

NameTypeDescription
searchParameterSearch_PurchaseOrderParameterSearch Parameter class

Permissions

GlobalPermissions.PurchaseOrder.SearchPurchaseOrderNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/PurchaseOrder/Search_PurchaseOrders

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

searchParameter={
  "DateFrom": "2021-07-29T09:24:12.318565+01:00",
  "DateTo": "2021-07-29T09:24:12.318565+01:00",
  "Status": 0,
  "ReferenceLike": "sample string 1",
  "EntriesPerPage": 2,
  "PageNumber": 3,
  "Location": [
    "68c2b984-1384-40ac-809e-0184ba270edb"
  ],
  "Supplier": [
    "ec7f4039-60d9-4a05-afe7-e4b96909be13"
  ]
}

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "Result": [
    {
      "pkPurchaseID": "e5c3edf1-7bad-484c-ba49-9b7836c7b218",
      "fkSupplierId": "5364a2e5-aff3-4dd7-a498-11ea379b6e09",
      "fkLocationId": "2e8e9dcd-4151-4890-8ba3-19aea192d2a3",
      "ExternalInvoiceNumber": "sample string 4",
      "Status": 0,
      "Currency": "sample string 5",
      "SupplierReferenceNumber": "sample string 6",
      "Locked": true,
      "LineCount": 8,
      "DeliveredLinesCount": 9,
      "UnitAmountTaxIncludedType": 10,
      "DateOfPurchase": "2021-07-29T09:24:43.2242162Z",
      "DateOfDelivery": "2021-07-29T09:24:43.2242162Z",
      "QuotedDeliveryDate": "2021-07-29T09:24:43.2242162Z",
      "PostagePaid": 4.0,
      "TotalCost": 5.0,
      "taxPaid": 6.0,
      "ShippingTaxRate": 7.0,
      "ConversionRate": 8.0,
      "ConvertedShippingCost": 9.0,
      "ConvertedShippingTax": 10.0,
      "ConvertedOtherCost": 11.0,
      "ConvertedOtherTax": 12.0,
      "ConvertedGrandTotal": 13.0
    }
  ],
  "TotalPages": 1,
  "CurrentPageNumber": 2,
  "EntriesPerPage": 3,
  "TotalNumberOfRecords": 4
}