API Reference

About the cart object

Cart model

NOTE: Cart inherits order with all of its properties, but has some additional properties:

Building a cart

In a headless commerce scenario, there will be multiple endpoints in the cart API used from start to end:

1. Create cart by posting a new SKU to AddItemToCart endpoint
2. Add more items to cart by posting newly created CartId and new SkuIds to AddItemToCart endpoint
3. If needed, update cart quantities with SetQuantity endpoint
4. Fetch cart with GetCart endpoint
5. If applicable, add any gift card code with AddGiftCard endpoint
6. If applicable, add any coupon code with AddCouponCode endpoint
7. Get shipping options with GetShippingOptions endpoint
8. Get payment options with GetPaymentOptions endpoint
9. Add shipment to cart with AddShipmentToCart endpoint
10. Add payment to cart with AddPaymentToCart endpoint
11. Add customer to cart with AddCustomer endpoint
12. If a custom store is selected by the customer, add store with AddStore endpoint
13. Create order from cart with CreateOrderFromCart endpoint

Cart data flow

Checkout

Creating a new cart

There are three ways of creating new carts:

1. Add item to cart
2. Put order line to CreateCart endpoint
3. Put complete cart to Cart endpoint

Using add item to cart

To create a new cart, send a post request to AddItemToCart endpoint without adding a cart ID. Then a new cart will be created.

The response will contain the new cart. The new cart will have one order line with the requested SkuId.

The cart in the response will have a new unique cartId. Use this in all future requests for this cart.

Create cart data flow

Sample new cart request

Adding one item with SkuId sc-12345-S to new cart with market NOR:

/api/Cart/AddItemToCart?skuId=sc-12345-S&quantity=1&marketId=NOR

Put order line to CreateCart endpoint

Create a cart by putting an order line to the create cart endpoint:

CreateCartFromOrderLine

This method is used if the sales channel / external system has prices and metadata already set.

Put complete cart to Cart endpoint

Create a cart by putting a complete cart to the cart endpoint:

PutCartToCart

This method is used if the cart or offer is already completed in another system.

Add items to cart

Items can be added to the cart by posting SkuId to the AddItemToCart endpoint:

AddItemToCart

This method is used if Omnium should fetch product information, prices, etc., and add to the order line. Only value needed is the product ID, and Omnium will enrich the order line.

Add item data flow

Sample request

Adding one item with SkuId sc-12345-S to cart with ID C12345:

/api/Cart/AddItemToCart?cartId=C12345&skuId=sc-12345-S&quantity=1&marketId=NOR

Change order line quantity

Change cart quantity by using one of the set quantity endpoints:

By SkuId:

ChangeQuantityBySku

By OrderLineId:

ChangeQuantityByOrderLineId

Change quantity data flow

Change quantity sample request

Change quantity of order line with SkuId sc-12345-S to 5:

/api/Cart/C12345/OrderLines/SetQuantity/Sku/sc-12345-S/5

Get carts

Get single cart

Get a single cart by using the get endpoint.

GetCart

Get cart sample request

Getting cart with ID C12345

/api/Cart/C12345

Get carts by customer

Get the latest carts by customer with the GetCartsByCustomer endpoint. Will return 50 latest carts.

GetCartsByCustomer

Search carts

Get carts by posting a OmniumCartSearchRequest to Search endpoint.

SearchCarts

Cart search request

Update carts

Update entire cart

Update a cart by putting a cart object to Stores API

UpdateCart

Add shipments to cart

Add shipments to cart by putting a list of OmniumShipment to the cart API.

AddShipmentsToCart

Shipment Properties

• ShippingMethodName
  • Required
  • Must be equal to a corresponding shipping method in shipping settings
• ShipmentId
  • Required
  • Shipment ID on order (unique only per order).

Sample shipment

Sample shipment with Bring Servicepakke

{
        "shipmentId": "1",
        "shippingMethodName": "Bring_SERVICEPAKKE",
        "warehouseCode": "WebShop"
} 

Add payments to cart

Add payment to cart by putting a list of OmniumPayment to the cart API.

AddPaymentsToCart

Payment properties

• Payment amount
  • Required
  • Must be a

positive integer value in øre

• PaymentMethodName
  • Required
  • Must be equal to a corresponding payment method in payment settings
• PaymentId
  • Required
  • Payment ID on order (unique only per order).

Add stores to cart

Add stores to cart by putting a list of OmniumStore to the cart API.

AddStoresToCart

Sample store

{
        "storeId": "VermontShop",
        "storeName": "Vermont Shop",
        "storeType": "WebShop",
        "marketId": "NOR"
}

Update customer

Update cart customer by putting a customer object to the cart API.

UpdateCustomerToCart

Add customer to cart

Add customer to cart by putting customer ID to cart API

Add customer to cart

Optional parameter to enrich cart. If true, customer name and contact information is added to the cart from the customer card.

Here’s the updated formatting to match the desired structure:

Add gift card

Add a gift card to the cart by putting the gift card code to the AddGiftCard endpoint.

AddGiftCard

Sample request

Adding gift card code ABC123 to cart with ID C12345:

/api/Cart/C12345/AddGiftCard/ABC123

Add coupon code

Add a coupon code to the cart by putting the coupon code to the AddCouponCode endpoint.

AddCouponCode

Sample request

Adding coupon code FreeShipping to cart with ID C12345:

/api/Cart/C12345/AddCouponCode/FreeShipping

Get shipping options

Get valid shipping options for the current cart by using the GetShippingOptions endpoint.

GetShippingOptions

Sample request

Get shipping options for cart with ID C12345 for postal code 0275:

/api/Cart/C12345/GetShippingOptions?postalCode=0275

Get payment options

Get valid payment options for the current cart by using the GetPaymentOptions endpoint.

GetPaymentOptions

Sample request

Get payment options for cart with ID C12345:

/api/Cart/C12345/GetPaymentOptions

Validate cart

The cart validator will post the cart to the provided endpoint and add any validation errors when the cart is validated. Read more and see built-in validators in Cart configuration.

CartValidate

Create order from cart

Create an order from the cart by posting the cart ID to the CreateOrderFromCart endpoint.

CreateOrderFromCart

Sample request

Create an order from cart with ID C12345:

/api/Cart/CreateOrderFromCart/C12345

Delete carts

Delete a cart by sending a delete request to the carts endpoint.

CartDelete