Purchase Orders

Cancel multiple purchase order lines

post/api/PurchaseOrders/{purchaseOrderId}/OrderLines/Cancel

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/PurchaseOrders/{purchaseOrderId}/OrderLines/Cancel
  • Auth: API key in header Authorization

Path parameters

purchaseOrderIdstring nullable required

Purchase order ID (Required)

Request body

lineItemIdsstring[] nullable

IDs of the purchase order lines to cancel. Each matched line has its remaining, undelivered quantity cancelled. IDs not found on the purchase order are ignored.

Response

Purchase order lines cancelled successfully

idstring nullable

ID of the purchase order

purchaseOrderNumberstring nullable

Purchase order number

namestring nullable

Purchase order name

supplierWarehouseCodestring nullable

Warehouse code of the supplier. If set, this purchase order is regarded as an internal transfer, and selected supplier warehouse will be reduced in inventory upon creation of delivery.

supplierIdstring nullable

ID of the supplier

supplierPhonestring nullable

Phone number of the supplier

supplierEmailstring nullable

Email address of the supplier

billingCurrencystring nullable

Billing currency for the purchase order

supplierNamestring nullable

Name of the supplier

costPriceListIdstring nullable

Selected cost price list for this purchase order. When set, products added will use prices from this list (with fallback to regular cost prices).

costPriceListNamestring nullable

Display name of the selected cost price list.

marketIdstring nullable

Market ID

referenceNumberstring nullable

Reference number of the purchase order

statusstring nullable

Status of the purchase order

subTotalnumber

Subtotal of the purchase order

subTotalExclTaxnumber

Subtotal excluding tax of the purchase order

taxTotalnumber

Tax total of the purchase order

totalnumber

Total amount of the purchase order

totalExclTaxnumber

Total amount excluding tax of the purchase order

purchaserIdstring nullable

ID of the purchaser

purchaserNamestring nullable

Name of the purchaser

modifiedstring date-time nullable

Last modified date and time of the purchase order

createdstring date-time nullable

Creation date and time of the purchase order

storeIdstring nullable

ID of the store

requestedDeliveryDatestring date-time nullable

Requested delivery date of the purchase order

originstring nullable

Origin of the purchase order

versionIdstring nullable

Version ID of the purchase order

isDeliveryboolean

If true, a delivery is created. All changes on the purchase order is reflected on the delivery.

deliveryIdstring nullable

If set, all the changes to the line items are reflected in this delivery

tagsstring[] nullable

Purchase order tags (Used by notification filters, and for grouping / filtering purchase orders)

projectIdsstring[] nullable

List of project IDs linked to this purchase order

promotionIdsstring[] nullable

List of promotion IDs linked to this purchase order. Ties the order to the campaign work it is bought for, and seeds the promotion filter on the product search.

Changes

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