Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

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.PurchaseOrder.ViewPurchaseOrderNode

Example Request

The following request format is required for this method.

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=9bc0ba45-b26b-432b-a6a1-067c5382fd70

Response

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

{
  "PurchaseOrderHeader": {
    "pkPurchaseID": "b7895ad0-c8e3-47d0-9125-7dc04ec18be4",
    "fkSupplierId": "fb8d3c30-7bf7-4f2f-8cda-50699a4ada55",
    "fkLocationId": "6b194b52-fe9f-4c61-8cb0-4b8592258872",
    "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.2802149Z",
    "DateOfDelivery": "2021-07-29T09:24:43.2802149Z",
    "QuotedDeliveryDate": "2021-07-29T09:24:43.2802149Z",
    "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": "61f972a0-0a0b-44df-b471-576191300053",
      "fkStockItemId": "cd339b8e-d9ee-43b8-9aa6-55733cfd8925",
      "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": "bd10c240-4a9f-4e1b-b58c-0d76cc5e5b69",
          "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": "2021-07-29T09:24:43.2812151+01:00",
      "PaymentDate": "2021-07-29T09:24:43.2812151+01:00",
      "fkPurchaseAdditionalCostItemId": 1
    }
  ],
  "DeliveredRecords": [
    {
      "pkDeliveryRecordId": 1,
      "fkPurchaseItemId": "03367bc9-c064-416d-aeb9-ccdafd088ab0",
      "fkStockLocationId": "41fd19fc-3554-4f29-ad52-4d53f7694515",
      "UnitCost": 4.0,
      "DeliveredQuantity": 5,
      "CreatedDateTime": "2021-07-29T09:24:43.2802149+01:00",
      "ModifiedDateTime": "2021-07-29T09:24:43.2802149+01:00",
      "fkBatchInventoryId": 1
    }
  ]
}