Purchase Orders | Deliveries

Get delivery purchase order lines

get/api/Deliveries/{deliveryId}/PurchaseOrderLines

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Deliveries/{deliveryId}/PurchaseOrderLines
  • Auth: API key in header Authorization

Path parameters

deliveryIdstring nullable required

Response

Success

lineItemIdstring nullable

Unique order line ID. Should be unique across all purchase orders.

splitFromLineItemIdstring nullable

LineItemId of the original line this line was split from. Set automatically when a line is split; always references the original (root) line, even across multiple successive splits.

codestring nullable

Sku ID of the order line

displayNamestring nullable

Display name of the line item

alternativeProductNamestring nullable

Alternative product name of the line item

eanstring nullable

EAN (European Article Number) / GTIN (Global Trade Item Number) of the line item.

gtinstring nullable

GTIN (Global Trade Item Number) of the line item.

imageUrlstring nullable

URL of the image associated with the line item

sizestring nullable

Size of the line item

colorstring nullable

Color of the line item

brandstring nullable

Brand of the line item

placedPricenumber

Price for one item that this line item represents. This property does not take any discounts into consideration.

placedPriceExclTaxnumber

Price for one item excluding tax. This property does not take any discounts into consideration.

currencystring nullable

Currency of the line item price

priceListIdstring nullable

ID of the price list / campaign the line's cost price was taken from, if any.

priceListItemIdstring nullable

ID of the specific price list item the line's cost price was taken from, if any.

priceListNamestring nullable

Name of the price list / campaign the line's cost price was taken from, for display.

quantitynumber

Number of items

lineItemDiscountAmountnumber

Total discount amount applied to the line item

lineItemDiscountAmountExclTaxnumber

Total discount amount applied to the line item, excluding tax

extendedPricenumber

Calculated - Total price of the line item, including all discounts applied on the line item (entry level and order level discounts).

extendedPriceExclTaxnumber

Calculated - Total price of the line item, excluding tax, including all discounts applied on the line item (entry level and order level discounts).

discountedPricenumber

Calculated - Total price of the line item with all entry level discounts applied on the line item. This does not take order level discounts into account.

discountedPriceExclTaxnumber

Calculated - Total price of the line item, excluding tax, with all entry level discounts applied on the line item. This does not take order level discounts into account.

taxTotalnumber

Calculated - Tax total for the line item, calculated from the tax group on the product

taxRatenumber

Tax rate applied to the line item. For example, if the tax rate is 25%, the value here should be 25.00.

unitstring nullable

Unit of measurement for the line item

customsCodestring nullable

Customs code for the line item

updateStockboolean

Specifies whether to update the stock for the line item

deliveredQuantitynumber

Quantity of the line item that has been delivered

canceledQuantitynumber

Quantity of the line item that has been canceled

countedQuantitynumber

Quantity of the line item that has been counted

commentstring nullable

Comment for the line item

supplierSkuIdstring nullable

ID of the supplier SKU

supplierNamestring nullable

Name of the supplier

purchaseOrderIdstring nullable

ID of the purchase order associated with the line item

deliveryIdstring nullable

ID of the delivery associated with the line item

estimatedTimeOfArrivalstring date-time nullable

Estimated time of arrival for the line item

isPackageboolean

Specifies whether the line item is a package

packageNamestring nullable

Name of the package

packageSkuIdstring nullable

SKU ID of the package

packageLineItemIdstring nullable

Line item ID of the package

isConfigurableProductboolean

Indicates whether the order line represents a configurable product. This value is set when a configurable product is created from the cart. Configurable products exist only as order lines and do not have standalone product entries

warehouseCodestring nullable

Warehouse code for the line item

stockLocationCodestring nullable

Stock location within the line's warehouse that goods reception receives to. Null means the SKU's default location is used

isDisabledForAllocationboolean

Specifies whether the line item is disabled for allocation

volumenumber double nullable

Total volume per unit of the line item, in cubic decimeters (dm³).

updateCostPriceboolean

Specifies whether to update the cost price on the product from this line item when goods reception is processed.

locationstring nullable

Inventory location

supplierPackagingQuantitynumber nullable

Supplier packaging quantity (D-Pack)

allowSupplierPackageBreakboolean nullable

Indicates if supplier packages can be split to order quantities smaller than the full package size.

allocateBasedOnRulesboolean

Only for Virtual Stock Locations - When true the line item inventory will be allocated to the virtual stock locations based on relevant inventory rules.

selectedUnitstring nullable

The selected unit of measurement on order line if product is sold in multiple units (Null if sold unit is default unit)

selectedUnitConversionFactornumber nullable

Conversion factor from default unit to selected unit

selectedUnitQuantitynumber nullable

The quantity ordered in the selected unit of measurement.

Changes

No recorded changes to this operation across all 1 revision of this API.