Add order line
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}/OrderLines
- Auth: API key in header Authorization
Path parameters
Order ID (Required)
Query parameters
Request body
Line item ID / Order Line ID - REQUIRED
SKU
Product EAN / GTIN number
GTIN numbers
Product display name
Additional or alternative product name
The price for one item, without discounts, i.e. list price
Calculated - The price for one item, without discounts, i.e. list price, without tax
Calculated - Total line item price with all discounts applied, including item and order level discounts
Calculated - Total line item price with all discounts applied, including item and order level discounts, without tax
Calculated - Reference to connected price list. Used in the context of 'PriceFactor'
Calculated - Reference to connected price list item. Used in the context of 'PriceFactor'
Calculated - Total line item price with all item discounts applied. Without order discounts.
Calculated - Total line item price with all item discounts applied. Without order discounts. Without tax.
(OBSOLETE: Use property on Discounted instead) Calculated - Total line item discount.
(OBSOLETE: Use property on DiscountedPriceExclTax instead) Calculated - Total line item discount excl. tax.
Suggested retail price. Not used in any calculations. Only used for reports or statistics by third party applications.
Suggested retail price without tax. Not used in any calculations. Only used for reports or statistics by third party applications.
Calculated - This order line's share of the order level discounts
Calculated - credited amount for order line
Calculated - Original extended price per unit before cancellation, used for credit calculations when ExtendedPrice becomes 0 after full cancellation
Order line comment
Number of ordered items
Quantity unit - e.g. Meter,Pcs,Litre, etc
The selected unit of measurement on order line if product is sold in multiple units (Null if sold unit is default unit)
Conversion factor from default unit to selected unit
The quantity ordered in the selected unit of measurement.
Number of items returned
Return reason comment
Date returned
Return type ID (should correspond to preconfigured list of return types)
Number of items cancelled
Reason / type of order line cancellation
Comment regarding cancellation
Number of items delivered
Deadline for when the customer needs to pick up the order line (Used for partial deliveries)
Deadline for when the store needs to pick the order line (Used for partial deliveries)
Number of items ready for pick up
Date orderLine is ready for pick up
If item should be sent as a gift
Product on order line can be back-ordered
Mark the order line as read only.
Mark the order line as read only for the customer. Typically used for carts where there should be order lines that the customer should not be allowed to modify.
Enriched from product data: Item cost
Calculated - Total cost for all items
Total line item discount
Total line item discount without tax
Calculated - Total tax for order line
Tax rate in percent. If tax is 25%, value here should be 25.00. If not set(null) tax from market will be used.
Optional campaign id
Enriched by product data - item size
Enriched by product data - name of color
Enriched by product data - name of brand
Product type
Supplier ID
Supplier Sku ID
Supplier name
Enriched by product data: Product ID
Enriched by product data: Product image URL
Expected delivery date for order line
Serial number for order line
Indicates whether the product requires a serial number
Indicates whether the order line represents a rental product. Rental dates are stored in Properties (keys: RentalFrom, RentalTo).
Package sku ID / Code (used if product is part of package)
Package line item ID (used if product is part of package)
Applicable only when the order line represents a component. Stores the identifier of the corresponding component within the parent package's component list.
Public website URL to product
Customs code for the line item. Enriched by product data
Country of origin. Enriched by product data
Weight of a single unit, in kilograms (kg). Enriched by product data when not already set on the line
Used by order return. If we should increase stock
Number of items replaced (if a replacement order has been created)
Replaced date (if a replacement order has been created)
Type of replacement (should correspond to preconfigured list of replacement types)
Reason for replacement
(OBSOLETE: Use 'IsPackageProduct' or 'IsPackageBrokeDown' instead) If true, product is a package with broken down components. Breakdown is skipped.
If true, product is a bundle with components. Prices are unchanged on broken down components and should be 0 on the bundle itself.
If true, product is a package with components. Packages have their own 'package' price (price required). Broken down components price will be set to 0.
If true, package/bundle breakdown is skipped
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
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
Reason for order line modification
If true, purchase order should be created from order line
Calculated: Reserved inventory
If true, order line is reserved on an incoming purchase order. Order lines with this flag will not be reserved on regular inventory items.
Calculated: Reserved inventory purchase order ID
Calculated: Reserved purchase order line ID
Calculated: True if inventory is reserved
Calculated: Reservation delivery ID
Order line group ID (should correspond to ID on order.groups)
Date of orderline delivery
Requested delivery date for the orderline
Date of orderline delivery
If true promotion prices are not recalculated for this order line.
When true, the price is locked and will not be recalculated. Also sets IsExcludedFromPromotions to true.
Calculated - true when the product on this order line is blocked from having a manual discount applied.
Reason code for manual discount applied to this order line (audit trail). Kept in sync with DiscountReason.ReasonCode for legacy consumers.
Indicates whether the order line represents a product option/accessory that is attached to another line item.
The origin/source of this order line (e.g. "Omnium" for UI-created lines, or values set by external systems)
The ID of the sales channel or register that created or last modified this order line (e.g. the InStore register ID)
Response
Order line added successfully
Unique order ID. This must and will be unique across all markets defined in Omnium.
In most cases, this property will be identical to the Id property. However, if you have orders from multiple sources (multiple e-commerce sites, pos systems or other sales channels), and the order numbers from the sources could overlap, you could set the Id to a unique value and the order number to the user friendly number.
The ID of the customer that has placed the order. Typically this is set to the customers phone number or email address, but it could be set to anything. A customer with the matching ID does not have to exist in the system before the order is placed. If there are no overlapping IDs, but you still have multiple sources of IDs, consider using ExternalIds instead.
In most cases, the customer number could be set to the same value as the CustomerId. However, in some edge cases the customers could get imported from multiple systems with the same ID range. In that case, you should set the user friendly number to the CustomerNumber and an unique ID for the CustomerId.
If Customer is member of customer club, set Customer ID as member ID.
Currency of the order. e.g. "USD","NOK"
Full name of customer
Customer phone number with prefix. e.g. +4740000000
Customer e-mail
B2B or B2C (Business customer or private customer)
Market ID e.g. "US", "NOR", "SWE". This must match the value of the market(s) defined in Omnium.
(OBSOLETE: Use property on OrderForm instead) Shipping discount amount
Total shipping cost
The current order status. This must match a status defined in the order settings in Omnium. Typical values are "New", "InProgress", "Cancelled" or "Completed".
CALCULATED: The remaining payment amount if the difference between the authorized amount and total amount
Id of seller of the order - typically set to the e-mail of the user in Omnium, but could be set to any ID.
Name of the seller of the order
Name of sales channel
CALCULATED: Order completed date
CALCULATED: Order last modified date
CALCULATED: Modified by
The creation date of the order
The received date of the order
Order follow-up date
CALCULATED: Customer deadline for picking up order
CALCULATED: Employee deadline for picking order
Delivery date requested by customer
Date when order should be moved to next status. (Updated by UpdateOrderStatusScheduledTask)
Calculated: When the order was set to ready for pickup. The property can be set by workflow step with name: Set ready for pickup date
Status order should be moved to. (Updated by UpdateOrderStatusScheduledTask)
OBSOLETE: Use orderForm.payments instead.
Order type e.g. "Online", "Pos". The order type must match a order type defined in the Omnium order settings
The allocation profile Omnium's allocation engine should rank plans under for this order, for example FewestShipments or Closest. Empty means the profile configured for the market.
The store Id identifies the store that sells the orders. Should match an ID of an existing store. A store would typically be the front end e-commerce solution, a physical store or other sales channels.
The origin of the order should identify where the order was created. Typical values are "OMS", "ERP", "WEB" or "POS".
Calculated: Total cost of the order. The cost price
Calculated: OrderForm total - returnForms total
Calculated: OrderForm total excl tax - returnForms total excl tax
Reference provided by customer.
Customer contact person
Customer requisition provided by customer
If true, the order is not editable in Omnium. Typically used for completed PoS orders, historic data or orders that should never be modified.
If true, Omnium's notifications will not be triggered for the order
List of related order IDs
Session code used for referencing a web session
A unique secret key for the order. Can be used for secure order lookups.
List of replacement order IDs for this order
Subscription ID - used if order is part of a subscription. The Id should match an existing subscription in Omnium
Project IDs - used if order is part of projects
Order tags (Used by notification filters, and for grouping / filtering orders)
Net payment terms (in days). Used for invoice due dates.
Invoice comment
OBSOLETE: Use ProjectIds instead. Project ID - used if order is part of a project
(OBSOLETE: Use property on OrderForm instead) Order total without shipment cost
(OBSOLETE: Use property on OrderForm instead) Order total without shipment cost and without tax
(OBSOLETE: Use property on OrderForm instead) Total tax amount
(OBSOLETE: Use property on OrderForm instead) Order total, including shipment cost, tax, and discounts
(OBSOLETE: Use property on OrderForm instead) Order total, including shipment cost and discounts, but without tax
(OBSOLETE: Use property on OrderForm instead) Total order discount
Indicates whether the customer is new. Set automatically by the workflow if the customer's creation date is in the past, but can also be updated via the API.
Read only: Current version ID
Order name
Canceled date
Organization number
Correlation ID for tracing
Whether the order has been anonymized
Whether the order is reservable
List of invoice IDs associated with this order
Shows which documents have been generated for the order
Customer's own order number
Customer group memberships
Whether the order has been reallocated
Changes
No recorded changes to this operation across all 1 revision of this API.