Orders | Order Lines

Patch OrderLines - update only values in request

Sample request for patching order line with lineItemId "1". Updating color and placedPrice.

PATCH /api/{orderId}/patchUpdateOrderLines
{
    [
        {
            "lineItemId": "1",
            "color" : "blue",
            "placedPrice": 100
        }
    ]
}
patch/api/Orders/{orderId}/PatchUpdateOrderLines

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/Orders/{orderId}/PatchUpdateOrderLines
  • Auth: API key in header Authorization

Path parameters

orderIdstring nullable required

ID of existing order. (Required)

Request body

lineItemIdstring nullable

Line item ID

codestring nullable

Product / SKU number

eanstring nullable

Product EAN / GTIN number

gtinsstring[] nullable

Product GTIN number

displayNamestring nullable

Product display name

alternativeProductNamestring nullable

Additional or alternative product name

placedPricenumber nullable

The price for one item, without discounts, i.e. list price

placedPriceExclTaxnumber nullable

The price for one item, without discounts, i.e. list price, without tax

extendedPricenumber nullable

Calculated - Total line item price with all discounts applied, including item and order level discounts

extendedPriceExclTaxnumber nullable

Calculated - Total line item price with all discounts applied, including item and order level discounts, without tax

priceListIdstring nullable

Calculated - Reference to connected price list. Used in the context of 'PriceFactor'

priceListItemIdstring nullable

Calculated - Reference to connected price list item. Used in the context of 'PriceFactor'

discountedPricenumber nullable

Calculated - Total line item price with all item discounts applied. Without order disounts.

discountedPriceExclTaxnumber nullable

Calculated - Total line item price with all item discounts applied. Without order disounts. Without tax.

suggestedRetailPricenumber nullable

Suggested retail price. Not used in any calculations. Only used for reports or statistics by third party applications.

suggestedRetailPriceExclTaxnumber nullable

Suggested retail price withoud tax. Not used in any calculations. Only used for reports or statistics by third party applications.

orderDiscountAmountnumber nullable

Calculated - This orderlines share of the order level discounts

commentstring nullable

Order line comment

quantitynumber nullable

Number of items

unitstring nullable

Quantity unit - e.g. Meter,Pcs,Litre, etc

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.

returnQuantitynumber nullable

Number of items returned

returnReasonstring nullable

Return reason comment

returnDatestring date-time nullable

Date returned

returnTypestring nullable

Return type ID (should correspond to preconfigured list of return types)

canceledQuantitynumber nullable

Number of items cancelled

canceledDatestring date-time nullable

Date of cancellation

cancelReasonstring nullable

Reason / type of order line cancellation

cancelCommentstring nullable

Comment regarding cancellation

deliveredQuantitynumber nullable

Number of items delivered

customerPickupDeadlinestring date-time nullable

Deadline for when the customer needs to pick up the order line (Used for partial deliveries)

storePickDatestring date-time nullable

Deadline for when the store needs to pick the order line (Used for partial deliveries)

isGiftboolean nullable

If item should be sent as a gift

isReadOnlyboolean nullable

Is order line read only for customer

costnumber nullable

Item cost

costTotalnumber nullable

Total cost for all items

discountednumber nullable

Total line item discount

discountedExclTaxnumber nullable

Total line item discount without tax

taxTotalnumber nullable

Total tax for order line

taxRatenumber nullable

Tax rate in percent. If tax is 25%, value here should be 25.00. If not set(null) tax from market will be used.

campaignIdstring nullable

Optional campaign id

keepExistingCustomPropertiesboolean nullable

Set to 'false' if you want to update the whole 'properties' list. If true, new properties will be added to the existing list of properties. 'True' by default.

sizestring nullable

Item size

colorstring nullable

Item color

brandstring nullable

Brand name

productTypestring nullable

Product type

supplierIdstring nullable

Supplier ID

supplierSkuIdstring nullable

Supplier SKU ID

supplierNamestring nullable

Supplier name

productIdstring nullable

Product ID

imageUrlstring nullable

Product image URL

customsCodestring nullable

Customs tariff code / HS number, used for customs declarations (NVIT)

countryOfOriginstring nullable

Country of origin (ISO 3166-1 alpha-2)

weightnumber double nullable

Weight of a single unit, in kilograms (kg), used as a fallback for NVIT net weight when packages don't have an explicit net weight

expectedDeliveryDatestring date-time nullable

Expected delivery date for order line

serialNumberstring nullable

Serial number for order line

isSerializableProductboolean nullable

Indicates whether the product requires a serial number

packageSkuIdstring nullable

Package sku ID / Code (used if product is part of package)

packageLineItemIdstring nullable

Package line item ID (used if product is part of package)

webSiteProductUrlstring nullable

Public website URL to product

updateStockboolean nullable

Used by order return. If we should increase stock

creditedAmountnumber nullable

Line item credited amount

replacedQuantitynumber nullable

Number of items replaced

replacedDatestring date-time nullable

Replaced date

replacementTypestring nullable

Type of replacement

replacementReasonstring nullable

Reason for replacement

isPackageboolean nullable

If true, product is a product with components

isVirtualProductboolean nullable

Indicates whether the product on the order line is a virtual product. Virtual products, such as gift cards or other electronic products, do not require or affect inventory

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

reservedInventoryQuantitynumber nullable

Reserved inventory

reservedInventoryPurchaseOrderIdstring nullable

Reserved inventory purchase order ID

reservedInventoryPurchaseOrderLineIdstring nullable

Reserved purchase order line ID

reservedInventoryboolean nullable

True if inventory is reserved

reservedInventoryDeliveryIdstring nullable

Reservation delivery ID

isAwaitingPurchaseOrderboolean nullable

If true, order line is reserved on an incoming purchase order

deliveredDatestring date-time nullable

DateTime of delivery of lineItem

requestedDeliveryDatestring date-time nullable

DateTime of requested delivery date for line item

internalWarehouseLocationstring nullable

For return: Use this to specify the warehouseLocation within a warehouse, Example Broken/Used/SellAsNew or front/back

isSkuAccessoryboolean nullable

Indicates whether the order line represents a product option/accessory that is attached to another line item.

discountReasonCodestring nullable

Reason code for manual discount applied to this order line (audit trail). Kept in sync with DiscountReason.ReasonCode for legacy consumers.

isExcludedFromPromotionsboolean nullable

If true, promotion prices are not recalculated for this order line.

isPriceLockedboolean nullable

When true, the price is locked and will not be recalculated. Also sets IsExcludedFromPromotions to true.

salesOriginstring nullable

The origin/source of this order line (e.g. "Omnium" for UI-created lines, or values set by external systems)

Response

OrderLines updated successfully

totalCountinteger
updatedCountinteger
unchangedCountinteger
notFoundCountinteger
errorCountinteger
errorMessagestring nullable
isModifiedboolean

Changes

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