Orders | Update

Patch Order - update only values in request

patch/api/Orders/{orderId}/PatchOrder

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}/PatchOrder
  • Auth: API key in header Authorization

Path parameters

orderIdstring nullable required

ID of existing order. (Required)

Request body

idstring nullable

Unique order ID

orderNumberstring nullable

Order identifier - does not have to be unique for each store, market etc

customerIdstring nullable

The ID of the customer - should be a unique value

customerNumberstring nullable

The customer number

billingCurrencystring nullable

Currency of the order. e.g. "USD","NOK"

customerClubMemberIdstring nullable

If Customer is member of customer club, set Customer ID as member ID.

customerNamestring nullable

Name of customer

customerPhonestring nullable

Customer phone number with prefix. e.g. +4740000000

customerEmailstring nullable

Customer e-mail

customerTypestring nullable

B2B or B2C (Business customer or private customer / consumer)

marketIdstring nullable

Market ID e.g. US, NOR, SWE

statusstring nullable

Order status, e.g. "New", "InProgress", "Cancelled", etc.

remainingPaymentnumber nullable

Amount not paid

salesPersonIdstring nullable

id of seller

salesPersonNamestring nullable

Name of seller

salesChannelstring nullable

Name of sales channel

modifiedBystring nullable

Modified by

createdstring date-time nullable

Order created date

followUpDatestring date-time nullable

Order follow-up date

receivedstring date-time nullable

Order received date

customerPickupDeadlinestring date-time nullable

Customer deadline for picking up order

storePickDatestring date-time nullable

Employee deadline for picking order

requestedDeliveryDatestring date-time nullable

Delivery date requested by customer

updateStatusDatestring date-time nullable

Date when order should be moved to next status. (Updated by UpdateOrderStatusScheduledTask)

nextOrderStatusstring nullable

Status order should be moved to. (Updated by UpdateOrderStatusScheduledTask)

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.

paymentTypestring nullable

Name of payment provider

orderTypestring nullable

Order type e.g. "Online", "Pos"...

storeIdstring nullable

Store ID responsible for order

customerReferencestring nullable

Reference provided by customer

customerContactstring nullable

Customer contact person

customerRequisitionstring nullable

Customer requisition provided by customer

isReadOnlyboolean nullable

If true, the order is not editable in Omnium. Used for completed PoS orders, historic data etc

isNotificationsDisabledboolean nullable

If true, notifications will not be sent to customer

relatedOrdersstring[] nullable

List of related order IDs

sessionstring nullable

Session code used for referencing a web session

replacementOrderIdsstring[] nullable

List of replacement order IDs for this order

projectIdstring nullable

Project ID - used if order is part of a project

subscriptionIdstring nullable

Subscription ID - used if order is part of a subscription

tagsstring[] nullable

Order tags (Used by notification filters, and for grouping / filtering orders)

ignorePromotionsboolean nullable

Promotion prices will be ignored when product added to cart

orderOriginstring nullable

The origin of the order should identify where the order was created. Typical values are "OMS", "ERP", "WEB" or "POS".

forceUpdatestring[] nullable

Used to update nullable prop like datetime to null, if original object has value, and you want to set null(remove value) Property name should then be in this list. Like "AuthorizationExpires" for a payment NB: Only impl for AuthorizationExpires at the moment

keepExistingListItemsboolean nullable

Determines behaviour when updating list where items does not have unique id (properties, errors). If true, new items will be added to the existing list. If false, the existing list will be replaced with the new list. 'True' by default.

customerGroupsstring[] nullable

Customer groups (for discount calculation)

invoiceCommentstring nullable

Invoice comment

Response

Order updated successfully

totalCountinteger
updatedCountinteger
unchangedCountinteger
notFoundCountinteger
errorCountinteger
errorMessagestring nullable
isModifiedboolean

Changes

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