Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

PurchaseOrder /Get_PurchaseOrder

Allows 250 calls per minute

Response: Get_PurchaseOrderResponse



Get purchase order header and items in one call

Parameters

NameTypeDescription
pkPurchaseIdGuidPurchase Order unique identifier

Permissions

GlobalPermissions.Inventory.PurchaseOrder.ViewPurchaseOrderNode

Example Request

The following request format is required for this method.

Get

Endpoint URL

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

GET https://eu-ext.linnworks.net/api/PurchaseOrder/Get_PurchaseOrder?pkPurchaseId=9a4d43ba-48ef-4bb9-9272-55bef473c847

Headers

Connection: keep-alive
Accept: application/json
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Post

Endpoint URL

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

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.

pkPurchaseId=9a4d43ba-48ef-4bb9-9272-55bef473c847

Response

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

{
  "PurchaseOrderHeader": {
    "pkPurchaseID": "aa31de6d-8b2f-452a-9bfe-35c0b7ecaf48",
    "fkSupplierId": "ac55e1a5-b183-4afc-8cf6-6c2884321a74",
    "fkLocationId": "43ae9ed8-6453-4174-95c0-718029dfcc1b",
    "ExternalInvoiceNumber": "sample string 4",
    "Status": 0,
    "Currency": "sample string 5",
    "SupplierReferenceNumber": "sample string 6",
    "Locked": true,
    "LineCount": 8,
    "DeliveredLinesCount": 9,
    "UnitAmountTaxIncludedType": 10,
    "DateOfPurchase": "2022-01-13T12:45:46.3925899Z",
    "DateOfDelivery": "2022-01-13T12:45:46.3925899Z",
    "QuotedDeliveryDate": "2022-01-13T12:45:46.3925899Z",
    "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
  },
  "PurchaseOrderItem": [
    {
      "pkPurchaseItemId": "ba0ac840-467d-42f0-b054-abd10de6722f",
      "fkStockItemId": "bc184f7e-3a3d-42b6-b5eb-598e6f1edf56",
      "StockItemIntId": 3,
      "Quantity": 4,
      "Cost": 5.0,
      "Delivered": 6,
      "TaxRate": 7.0,
      "Tax": 8.0,
      "PackQuantity": 9,
      "PackSize": 10,
      "SKU": "sample string 11",
      "ItemTitle": "sample string 12",
      "InventoryTrackingType": 13,
      "IsDeleted": true,
      "SortOrder": 15,
      "DimHeight": 16.0,
      "DimWidth": 17.0,
      "BarcodeNumber": "sample string 18",
      "DimDepth": 19.0,
      "BoundToOpenOrdersItems": 20,
      "BinRack": "sample string 21",
      "QuantityBoundToOpenOrdersItems": 22,
      "SupplierCode": "sample string 24",
      "SupplierBarcode": "sample string 25",
      "SkuGroupIds": [
        1
      ]
    }
  ],
  "AdditionalCosts": [
    {
      "PurchaseAdditionalCostItemId": 1,
      "AdditionalCostTypeId": 2,
      "Reference": "sample string 3",
      "SubTotalLineCost": 4.0,
      "TaxRate": 5.0,
      "Tax": 6.0,
      "Currency": "sample string 7",
      "ConversionRate": 8.0,
      "TotalLineCost": 9.0,
      "CostAllocation": [
        {
          "CostAllocationId": 1,
          "PurchaseAdditionalCostItemId": 2,
          "PurchaseItemId": "6cc65c33-0721-4ef1-8a7d-b364a3e0b5d9",
          "AllocationPercentage": 4.0
        }
      ],
      "AllocationLocked": true,
      "AdditionalCostTypeName": "sample string 11",
      "AdditionalCostTypeIsShippingType": true,
      "AdditionalCostTypeIsPartialAllocation": true,
      "Print": true,
      "AllocationMethod": 0
    }
  ],
  "NoteCount": 1,
  "PaymentStatements": [
    {
      "PurchasePaymentStatementId": 1,
      "LineCost": 2.0,
      "ConversionRate": 3.0,
      "Currency": "sample string 4",
      "Reference": "sample string 5",
      "CreationDate": "2022-01-13T12:45:46.3925899+00:00",
      "PaymentDate": "2022-01-13T12:45:46.3925899+00:00",
      "fkPurchaseAdditionalCostItemId": 1
    }
  ],
  "DeliveredRecords": [
    {
      "pkDeliveryRecordId": 1,
      "fkPurchaseItemId": "a43819e8-915e-4336-afe4-4f4a4b3d6d35",
      "fkStockLocationId": "182cca2d-33ae-4915-957b-21cdf88bb218",
      "UnitCost": 4.0,
      "DeliveredQuantity": 5,
      "CreatedDateTime": "2022-01-13T12:45:46.3925899+00:00",
      "ModifiedDateTime": "2022-01-13T12:45:46.3925899+00:00",
      "fkBatchInventoryId": 1
    }
  ]
}