API Reference
Start typing to search…

Add_PurchaseOrderItem

post https://eu-ext.linnworks.net/api/PurchaseOrder/Add_PurchaseOrderItem

Method adds purchase order item to an existing PENDING order. Items can only be added to PENDING purchase orders. Returns class that represents modified/recalculated purchase order header and modified purchase order item line
Permissions Required: GlobalPermissions.Inventory.PurchaseOrder.EditPurchaseOrderNode
Rate limit: 250 / minute

Log in to see full request history
Body Params
addItemParameter
object

Class represents parameter for adding line to the purchase order.

Response

Response body
object
NewPurchaseOrderItem
object

Class represents purchase order item.

uuid

Unique record identifier. Use this id to update quantity, cost, deliver item etc

uuid

Unique system stock identifier. Use this id to query linnworks api for product information, stock levels etc

int32

Unique system stock integer identifier. Use this id to query linnworks api for product information, stock levels etc

int32

Quantity of unique stock items ordered

double

Line Total cost of all the purchase order item inclusive of tax (unitcost * qty) + tax

int32

Number of items delivered on the PO. If this number is more than 1, purchase order item cannot be deleted from the PO. Cannot be decreased.

double

Tax rate as a whole number, for example 20 represents 20%

double

Tax calculated from Cost * (TaxRate/100)

int32

Arbitary identifier of how many packs ordered. Number not used in any of the calculation and purely for visualization and minimum reorder quantity purposes only

int32

Arbitary identifier of how many items in each pack. Number not used in any of the calculation and purely for visualization and minimum reorder quantity purposes only

string

Item SKU

string

Item Title

int32

Stock item tracking type. 0 = none. 1 = Ordered by Sell by Date. 2 = Ordered by Priority Sequence

boolean

Whether or not the stock item for this purchase order item has been deleted in the system

int32

Order the item was added to PO. First item = 0

double

Item height

double

Item Width

string

Barcode

double

Item Depth

int32

Number of open order items this item is bound

string

Bin rack

int32

Sum of quantity of items bound to open order items

string

Supplier Code

string
SkuGroupIds
array of int32s

Sku group id assocaited with purchase item. Used for containerisation.

SkuGroupIds
PurchaseOrderHeader
object

Class represents purchase order header.

uuid

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

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

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

string

Purchase order reference number

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

string

Currency of the monetary values in the purchase order

string

Supplier reference number for the purchase order

boolean

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

int32

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

int32

Number of items in the purchase order

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)

date-time

DateTime of the purchase order UTC

date-time

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

date-time

DateTime of the purchase order qouted/expected delivery date UTC

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

double

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

double

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

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

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.

double

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

double

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

double

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

double

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

double

Total amount of the purchase order, converted to system currency

int32

If the item was batched or booked into a WMS location, this is the batch inventory id for the booked in stock.
If an item was not delivered or was a non batched item, this will be null.

Updated over 1 year ago

Did this page help you?
Language
Credentials

Updated over 1 year ago

Did this page help you?