Orders | Shipments

Put shipment on order

Add/Update shipment on order.

put/api/OrderShipments/{orderId}

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

Path parameters

orderIdstring nullable required

Order ID

Request body

shipmentIdstring nullable

Unique identification for shipment. Required for all shipments.

shippingMethodIdstring nullable

ID of shipping method

shippingMethodNamestring nullable

Name of shipping method for this shipment. Should correspond to a shipment type in Omnium. Typical values would be "Bring", "PickUpInStore" or whatever provider or type of shipment that is configured.

shippingLabelstring nullable

User friendly name - Automatically populated from ShipmentOptions defined in Omnium as part of the order workflow.

shippingTaxnumber

Shipment cost tax

shipmentTaxRatenumber nullable

Shipment tax rate. If tax is 25%, value here should be 25.00. If not set, default tax rate from market will be used.

shipmentTrackingNumberstring nullable

Tracking number from external shipping provider

shipmentTrackingLinkstring nullable

Tracking link for external shipping provider

shipmentLabelLinkstring nullable

Shipping label link

shippingDiscountAmountnumber

Calculated - Total discounts for shipping. Calculated from the discount list

shippingSubTotalnumber

Shipping cost, without discounts

shippingTotalnumber

Calculated - Total shipping cost (Calculated, shippingSubTotal - shippingDiscountAmount)

shippingSubTotalExclTaxnumber

Calculated - Shipping cost without discounts excl tax

shippingCreditedTotalnumber

Total shipping cost credited

fiscalSaleIdstring nullable

The POS fiscal sale this shipment is paid in (one payment event at the till, one receipt), when the order was paid in parts. Null while the shipment is unpaid.

receiptedAtstring date-time nullable

When the receipt for this shipment was issued. Null while unpaid.

statusstring nullable

Shipment status

orderStatusstring nullable

The shipment order status is used in workflows for partial shipments the same way as the order status is used for orders with single shipments. This means the values for the shipments OrderStatus should be the same values as the available order statuses.

orderTypestring nullable

Shipment-level order type, used when shipments on a split order follow different workflows. Empty means the shipment follows the order's own order type.

allocationPlanIdstring nullable

The allocation plan this shipment belongs to. Set by Omnium's allocation engine, and writable by a channel that simulated the allocation itself and wants the decision traceable.

allocationProfileKeystring nullable

The allocation profile the plan was chosen under, for example FewestShipments. Set by Omnium's allocation engine.

prevStatusstring nullable

Previous status. Automatically set by Omnium's workflow

subTotalnumber

Calculated - Sum of all lineItems

totalnumber

Calculated - Sum of all lineItems and shipping cost

taxTotalnumber

LineItems tax total + shippingTax

warehouseCodestring nullable

Warehouse shipment is sent from. Should correspond to a store ID in Omnium.

virtualWarehouseCodestring nullable

Only relevant when using Virtual Stock Locations - Specifies which of the virtual Warehouses the inventory should be reduced.

pickUpWarehouseCodestring nullable

Warehouse shipment is sent to (optional) for pickup. Should correspond to a store ID in Omnium.

transitboolean

True if shipment is between two warehouses

commentstring nullable

Shipment comments

returnTrackingNumberstring nullable

Tracking number if return shipment is booked

returnTrackingLinkstring nullable

Tracking link if return shipment is booked

returnLabelLinkstring nullable

Link to return shipment label

servicePointIdstring nullable

Id to third party shipment service/pickup point. If you only have id set this prop. If you have complete info about pickUp point, set PickUpPointInformation object

expectedDeliveryDatestring date-time nullable

Expected/Requested delivery date for this shipment

expectedShipmentDatestring date-time nullable

Calculated - Expected shipment date (based on ATP)

shippingMethodProductIdstring nullable

Shipping method product ID. Used for external shipping providers that has shipping method product IDs defined.

isAllocatedboolean

Determines if shipment is allocated, set to true if shipment should not be reallocated.

goodsDescriptionstring nullable

Describe shipment content

completedstring date-time nullable

Completed date

updateStatusDatestring date-time nullable

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

nextOrderStatusstring nullable

Shipment order status to transition to at UpdateStatusDate. (Processed by UpdateOrderStatusScheduledTask)

Response

Success

idstring nullable

Unique order ID. This must and will be unique across all markets defined in Omnium.

orderNumberstring nullable

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.

customerIdstring nullable

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.

customerNumberstring nullable

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.

customerClubMemberIdstring nullable

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

billingCurrencystring nullable

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

customerNamestring nullable

Full 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)

marketIdstring nullable

Market ID e.g. "US", "NOR", "SWE". This must match the value of the market(s) defined in Omnium.

shippingDiscountTotalnumber

(OBSOLETE: Use property on OrderForm instead) Shipping discount amount

shippingSubTotalnumber

Total shipping cost

statusstring nullable

The current order status. This must match a status defined in the order settings in Omnium. Typical values are "New", "InProgress", "Cancelled" or "Completed".

remainingPaymentnumber

CALCULATED: The remaining payment amount if the difference between the authorized amount and total amount

salesPersonIdstring nullable

Id of seller of the order - typically set to the e-mail of the user in Omnium, but could be set to any ID.

salesPersonNamestring nullable

Name of the seller of the order

salesChannelstring nullable

Name of sales channel

completedstring date-time nullable

CALCULATED: Order completed date

modifiedstring date-time

CALCULATED: Order last modified date

modifiedBystring nullable

CALCULATED: Modified by

createdstring date-time

The creation date of the order

receivedstring date-time nullable

The received date of the order

followUpDatestring date-time nullable

Order follow-up date

customerPickupDeadlinestring date-time nullable

CALCULATED: Customer deadline for picking up order

storePickDatestring date-time nullable

CALCULATED: 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)

readyForPickupstring date-time nullable

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

nextOrderStatusstring nullable

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

paymentTypestring nullable

OBSOLETE: Use orderForm.payments instead.

orderTypestring nullable

Order type e.g. "Online", "Pos". The order type must match a order type defined in the Omnium order settings

requestedAllocationProfileKeystring nullable

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.

storeIdstring nullable

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.

orderOriginstring nullable

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

lineItemsCostnumber

Calculated: Total cost of the order. The cost price

netTotalnumber

Calculated: OrderForm total - returnForms total

netTotalExclTaxnumber

Calculated: OrderForm total excl tax - returnForms total excl tax

customerReferencestring nullable

Reference provided by customer.

customerContactstring nullable

Customer contact person

customerRequisitionstring nullable

Customer requisition provided by customer

isReadOnlyboolean

If true, the order is not editable in Omnium. Typically used for completed PoS orders, historic data or orders that should never be modified.

isNotificationsDisabledboolean

If true, Omnium's notifications will not be triggered for the order

relatedOrdersstring[] nullable

List of related order IDs

sessionstring nullable

Session code used for referencing a web session

secretKeystring nullable

A unique secret key for the order. Can be used for secure order lookups.

replacementOrderIdsstring[] nullable

List of replacement order IDs for this order

subscriptionIdstring nullable

Subscription ID - used if order is part of a subscription. The Id should match an existing subscription in Omnium

projectIdsstring[] nullable

Project IDs - used if order is part of projects

tagsstring[] nullable

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

paymentTermsNetinteger nullable

Net payment terms (in days). Used for invoice due dates.

invoiceCommentstring nullable

Invoice comment

projectIdstring nullable

OBSOLETE: Use ProjectIds instead. Project ID - used if order is part of a project

subTotalnumber

(OBSOLETE: Use property on OrderForm instead) Order total without shipment cost

subTotalExclTaxnumber

(OBSOLETE: Use property on OrderForm instead) Order total without shipment cost and without tax

taxTotalnumber

(OBSOLETE: Use property on OrderForm instead) Total tax amount

totalnumber

(OBSOLETE: Use property on OrderForm instead) Order total, including shipment cost, tax, and discounts

totalExclTaxnumber

(OBSOLETE: Use property on OrderForm instead) Order total, including shipment cost and discounts, but without tax

discountTotalIncVatnumber

(OBSOLETE: Use property on OrderForm instead) Total order discount

isNewCustomerboolean nullable

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.

versionIdstring nullable

Read only: Current version ID

namestring nullable

Order name

canceledstring date-time nullable

Canceled date

orgNrstring nullable

Organization number

correlationIdstring nullable

Correlation ID for tracing

isAnonymizedboolean

Whether the order has been anonymized

isReservableboolean nullable

Whether the order is reservable

invoiceIdsstring[] nullable

List of invoice IDs associated with this order

documentStatusstring nullable

Shows which documents have been generated for the order

customerOrderNumberstring nullable

Customer's own order number

customerGroupsstring[] nullable

Customer group memberships

isReallocatedboolean

Whether the order has been reallocated

Changes

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