Cart endpoint API

This page describes the cart endpoint, which can be used to interact with your external e-commerce solution's REST shopping cart service.

With this endpoint, you can:

Create a cart anonymously or as an authenticated user.
Add an item to a cart.
Change the quantity of items in a cart.
Remove an item from a cart.

POST

Post cart as an anonymous user

Creates a cart as an anonymous user.

Request URL

/.rest/ecommerce/v1/carts/

Parameters

Parameter	Description	Parameter type	Data type	Connector
`definitionName`	required The definition name.	`query`	`string`	commercetools Magento
`connectionName`	required The connection name.	`query`	`string`	commercetools Magento
`anonymousId`	required Identifies the cart belonging to an anonymous user.	`header`	`string`	commercetools
`currencyCode`	required A three-digit currency code as per ↗ ISO 4217.	`form`	`string`	commercetools

commercetools example

Creates a cart for an anonymous user.

curl -i --user 'superuser:superuser' -H 'anonymousId:anonymous' -F currencyCode=EUR -X POST -H 'Accept:application/json' 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts?definitionName=commercetools&connectionName=connection'

Response

JSON

{"anonymousId":"anonymous","billingAddress":null,"cartState":"ACTIVE","country":null,"createdAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"zone":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"dayOfYear":65,"year":2019,"month":"MARCH","monthValue":3,"dayOfMonth":6,"hour":12,"minute":54,"second":45,"nano":774000000,"dayOfWeek":"WEDNESDAY","chronology":{"id":"ISO","calendarType":"iso8601"}},"custom":null,"customLineItems":[],"customerEmail":null,"customerGroup":null,"customerId":null,"deleteDaysAfterLastModification":null,"discountCodes":[],"id":"5fe74769-9a06-42a4-a41c-6184d1315d1a","inventoryMode":"NONE","itemShippingAddresses":[],"lastModifiedAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"zone":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"dayOfYear":65,"year":2019,"month":"MARCH","monthValue":3,"dayOfMonth":6,"hour":12,"minute":54,"second":45,"nano":774000000,"dayOfWeek":"WEDNESDAY","chronology":{"id":"ISO","calendarType":"iso8601"}},"lineItems":[],"locale":null,"origin":"CUSTOMER","paymentInfo":null,"refusedGifts":[],"shippingAddress":null,"shippingInfo":null,"shippingRateInput":null,"taxCalculationMode":"LINE_ITEM_LEVEL","taxMode":"PLATFORM","taxRoundingMode":"HALF_EVEN","taxedPrice":null,"totalPrice":{"factory":{"defaultMonetaryContext":{"precision":0,"amountType":"org.javamoney.moneta.Money","maxScale":63,"fixedScale":false,"empty":false,"providerName":null},"amountType":"org.javamoney.moneta.Money","maxNumber":null,"minNumber":null,"maximalMonetaryContext":{"precision":0,"amountType":"org.javamoney.moneta.Money","maxScale":-1,"fixedScale":false,"empty":false,"providerName":null}},"context":{"precision":256,"amountType":"org.javamoney.moneta.Money","maxScale":-1,"fixedScale":false,"empty":false,"providerName":null},"number":0,"currency":{"context":{"empty":false,"providerName":"java.util.Currency"},"defaultFractionDigits":2,"currencyCode":"EUR","numericCode":978},"zero":true,"negative":false,"positive":false,"positiveOrZero":true,"negativeOrZero":true},"version":1}

Magento example

Creates an empty cart and quote for a guest and returns the quote ID.

curl -i --user superuser:superuser -X POST -H 'Accept:application/json' 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts?definitionName=magento&connectionName=connection'

Response

JSON

64c32568be8c837cf9930149592c3c16

Post cart as an authenticated user

Creates a cart for a registered user.

Request URL

/.rest/ecommerce/v1/carts/

Parameters

Parameter	Description	Parameter type	Data type	Connector
`definitionName`	required The definition name.	`query`	`string`	commercetools Magento
`connectionName`	required The connection name.	`query`	`string`	commercetools Magento
`userId`	required commercetools: The unique ID of the user. Magento: Access token.	`header`	`string`	commercetools Magento
`currencyCode`	required A three-digit currency code as per ↗ ISO 4217.	`form`	`string`	commercetools

commercetools example

Creates a cart for an authenticated user.

curl -i --user superuser:superuser -H 'userId: fe7c3772-f414-426b-8706-083d15c94d29' -H 'Accept: application/json' -F currencyCode=EUR -X POST 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts?definitionName=commercetools&connectionName=connection'

Response

JSON

{"anonymousId":null,"billingAddress":null,"cartState":"ACTIVE","country":null,"createdAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"fixedOffset":true,"transitions":[],"transitionRules":[]}},"zone":{"totalSeconds":0,"id":"Z","rules":{"fixedOffset":true,"transitions":[],"transitionRules":[]}},"year":2019,"month":"MARCH","dayOfMonth":9,"dayOfWeek":"SATURDAY","dayOfYear":68,"hour":8,"minute":55,"second":9,"nano":16000000,"monthValue":3,"chronology":{"id":"ISO","calendarType":"iso8601"}},"custom":null,"customLineItems":[],"customerEmail":null,"customerGroup":null,"customerId":"fe7c3772-f414-426b-8706-083d15c94d29","deleteDaysAfterLastModification":null,"discountCodes":[],"id":"246b396a-d233-4ebc-8351-4a886589e75b","inventoryMode":"NONE","itemShippingAddresses":[],"lastModifiedAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"fixedOffset":true,"transitions":[],"transitionRules":[]}},"zone":{"totalSeconds":0,"id":"Z","rules":{"fixedOffset":true,"transitions":[],"transitionRules":[]}},"year":2019,"month":"MARCH","dayOfMonth":9,"dayOfWeek":"SATURDAY","dayOfYear":68,"hour":8,"minute":55,"second":9,"nano":16000000,"monthValue":3,"chronology":{"id":"ISO","calendarType":"iso8601"}},"lineItems":[],"locale":null,"origin":"CUSTOMER","paymentInfo":null,"refusedGifts":[],"shippingAddress":null,"shippingInfo":null,"shippingRateInput":null,"taxCalculationMode":"LINE_ITEM_LEVEL","taxMode":"PLATFORM","taxRoundingMode":"HALF_EVEN","taxedPrice":null,"totalPrice":{"factory":{"defaultMonetaryContext":{"amountType":"org.javamoney.moneta.Money","maxScale":63,"fixedScale":false,"precision":0,"empty":false,"providerName":null},"maxNumber":null,"minNumber":null,"amountType":"org.javamoney.moneta.Money","maximalMonetaryContext":{"amountType":"org.javamoney.moneta.Money","maxScale":-1,"fixedScale":false,"precision":0,"empty":false,"providerName":null}},"context":{"amountType":"org.javamoney.moneta.Money","maxScale":-1,"fixedScale":false,"precision":256,"empty":false,"providerName":null},"negativeOrZero":true,"positiveOrZero":true,"currency":{"context":{"empty":false,"providerName":"java.util.Currency"},"defaultFractionDigits":2,"numericCode":978,"currencyCode":"EUR"},"zero":true,"negative":false,"number":0,"positive":false},"version":1}

Magento example

Creates a cart for an authenticated user and returns the quoteId of the created cart.

curl -i --user superuser:superuser -H 'userId: 5buf20ns1pk7mxqq6v80pft3ug4due1m' -X POST -H 'Accept: application/json' 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts?definitionName=magento&connectionName=connection'

Response

JSON
53

GET

Get a cart by ID

Returns a cart by its ID.

Request URL

/.rest/ecommerce/v1/carts/{cartId}

Parameters

Parameter

Description

Parameter type

Data type

Connector

cartId

required

commercetools: The unique ID of the cart.

Magento: quote ID.

path

string

commercetools

Magento (anonymous)

definitionName

required

The definition name

query

string

commercetools

Magento

connectionName

required

The connection name

query

string

commercetools

Magento

commercetools example

Gets a cart by its ID (for both anonymous and authenticated users).

curl -i --user superuser:superuser -X GET -H 'Accept: application/json' 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts/060c8a1d-ef13-4208-9723-96e574e611b0?definitionName=commercetools&connectionName=connection'

Response

JSON

{"anonymousId":"123","billingAddress":null,"cartState":"ACTIVE","country":null,"createdAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"zone":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"year":2019,"month":"MARCH","monthValue":3,"dayOfMonth":7,"hour":16,"minute":27,"second":42,"nano":379000000,"dayOfWeek":"THURSDAY","dayOfYear":66,"chronology":{"id":"ISO","calendarType":"iso8601"}},"custom":null,"customLineItems":[],"customerEmail":null,"customerGroup":null,"customerId":null,"deleteDaysAfterLastModification":null,"discountCodes":[],"id":"060c8a1d-ef13-4208-9723-96e574e611b0","inventoryMode":"NONE","itemShippingAddresses":[],"lastModifiedAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"zone":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"year":2019,"month":"MARCH","monthValue":3,"dayOfMonth":7,"hour":16,"minute":27,"second":42,"nano":379000000,"dayOfWeek":"THURSDAY","dayOfYear":66,"chronology":{"id":"ISO","calendarType":"iso8601"}},"lineItems":[],"locale":null,"origin":"CUSTOMER","paymentInfo":null,"refusedGifts":[],"shippingAddress":null,"shippingInfo":null,"shippingRateInput":null,"taxCalculationMode":"LINE_ITEM_LEVEL","taxMode":"PLATFORM","taxRoundingMode":"HALF_EVEN","taxedPrice":null,"totalPrice":{"factory":{"defaultMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":63,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"amountType":"org.javamoney.moneta.Money","maxNumber":null,"minNumber":null,"maximalMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null}},"context":{"precision":256,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"number":0,"zero":true,"negative":false,"currency":{"context":{"empty":false,"providerName":"java.util.Currency"},"defaultFractionDigits":2,"currencyCode":"EUR","numericCode":978},"positive":false,"negativeOrZero":true,"positiveOrZero":true},"version":1}

Magento example

Get a cart by its quote ID for anonymous users. For authenticated users, use get by user ID.

curl -i --user superuser:superuser -X GET -H 'Accept: application/json' 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts/64c32568be8c837cf9930149592c3c16?definitionName=magento&connectionName=connection'

Response

JSON

{"id":89,"created_at":"2019-03-08 07:57:49","updated_at":"2019-03-08 07:57:49","is_active":true,"is_virtual":false,"items":[],"items_count":0,"items_qty":0,"customer":{"email":null,"firstname":null,"lastname":null},"billing_address":{"id":180,"region":null,"region_id":null,"region_code":null,"country_id":null,"street":[""],"telephone":null,"postcode":null,"city":null,"firstname":null,"lastname":null,"email":null,"same_as_billing":0,"save_in_address_book":0},"orig_order_id":0,"currency":{"global_currency_code":"EUR","base_currency_code":"EUR","store_currency_code":"EUR","quote_currency_code":"EUR","store_to_base_rate":0,"store_to_quote_rate":0,"base_to_global_rate":1,"base_to_quote_rate":1},"customer_is_guest":false,"customer_note_notify":true,"customer_tax_class_id":3,"store_id":1,"extension_attributes":{"shipping_assignments":[]}}

Get a cart by user ID

Returns a cart by user ID.

Request URL

/.rest/ecommerce/v1/carts/user

Parameters

Parameter	Description	Parameter type	Data type	Connector
`userId`	required commercetools: the unique ID of the user. Magento: the Access token.	`header`	`string`	commercetools Magento
`definitionName`	required The definition name.	`query`	`string`	commercetools Magento
`connectionName`	required The connection name.	`query`	`string`	commercetools Magento

commercetools example

Returns a cart by user ID.

curl -i --user superuser:superuser -X GET -H 'Accept: application/json' -H 'userId: fe7c3772-f414-426b-8706-083d15c94d29' 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts/user?definitionName=commercetools&connectionName=connection'

Response

JSON

{"anonymousId":null,"billingAddress":null,"cartState":"ACTIVE","country":null,"createdAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"zone":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"year":2019,"month":"MARCH","monthValue":3,"dayOfMonth":7,"hour":16,"minute":58,"second":2,"nano":528000000,"dayOfWeek":"THURSDAY","dayOfYear":66,"chronology":{"id":"ISO","calendarType":"iso8601"}},"custom":null,"customLineItems":[],"customerEmail":null,"customerGroup":null,"customerId":"fe7c3772-f414-426b-8706-083d15c94d29","deleteDaysAfterLastModification":null,"discountCodes":[],"id":"6ebccf42-19ad-4628-a139-8351fc355839","inventoryMode":"NONE","itemShippingAddresses":[],"lastModifiedAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"zone":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"year":2019,"month":"MARCH","monthValue":3,"dayOfMonth":7,"hour":16,"minute":58,"second":2,"nano":528000000,"dayOfWeek":"THURSDAY","dayOfYear":66,"chronology":{"id":"ISO","calendarType":"iso8601"}},"lineItems":[],"locale":null,"origin":"CUSTOMER","paymentInfo":null,"refusedGifts":[],"shippingAddress":null,"shippingInfo":null,"shippingRateInput":null,"taxCalculationMode":"LINE_ITEM_LEVEL","taxMode":"PLATFORM","taxRoundingMode":"HALF_EVEN","taxedPrice":null,"totalPrice":{"factory":{"defaultMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":63,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"amountType":"org.javamoney.moneta.Money","maxNumber":null,"minNumber":null,"maximalMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null}},"context":{"precision":256,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"number":0,"zero":true,"negative":false,"currency":{"context":{"empty":false,"providerName":"java.util.Currency"},"defaultFractionDigits":2,"currencyCode":"EUR","numericCode":978},"positive":false,"negativeOrZero":true,"positiveOrZero":true},"version":1}

Magento example

Returns a cart by user access token.

curl -i --user superuser:superuser -X GET -H 'Accept: application/json' -H 'userId: tdsxx5miep5pc6ihq8elk7gp83jfg883' 'http://localhost:8080/magnoliuthor/.rest/ecommerce/v1/carts/user?definitionName=magento&connectionName=connection'

Response

JSON

{"id":53,"created_at":"2019-03-09 09:00:49","updated_at":"2019-03-09 09:00:49","is_active":true,"is_virtual":false,"items":[],"items_count":0,"items_qty":0,"customer":{"id":3,"group_id":1,"default_billing":"2","default_shipping":"2","created_at":"2019-03-09 08:16:38","updated_at":"2019-03-09 08:16:38","created_in":"Default Store View","email":"jdoe@example.com","firstname":"Jane","lastname":"Doe","store_id":1,"website_id":1,"addresses":[{"id":2,"customer_id":3,"region":{"region_code":"NY","region":"New York","region_id":43},"region_id":43,"country_id":"US","street":["123 Oak Ave"],"telephone":"512-555-1111","postcode":"10755","city":"Purchase","firstname":"Jane","lastname":"Doe","default_shipping":true,"default_billing":true}],"disable_auto_group_change":0,"extension_attributes":{"is_subscribed":false}},"billing_address":{"id":106,"region":null,"region_id":null,"region_code":null,"country_id":null,"street":[""],"telephone":null,"postcode":null,"city":null,"firstname":null,"lastname":null,"customer_id":3,"email":"jdoe@example.com","same_as_billing":0,"save_in_address_book":0},"orig_order_id":0,"currency":{"global_currency_code":"EUR","base_currency_code":"EUR","store_currency_code":"EUR","quote_currency_code":"EUR","store_to_base_rate":0,"store_to_quote_rate":0,"base_to_global_rate":1,"base_to_quote_rate":1},"customer_is_guest":false,"customer_note_notify":true,"customer_tax_class_id":3,"store_id":1,"extension_attributes":{"shipping_assignments":[]}}

POST

Post an item to cart

Adds an item to a cart.

Request URL

/.rest/ecommerce/v1/carts/items

Parameters

Parameter	Description	Parameter type	Data type	Connector
`productId`	required commercetools: the unique ID of the product. Magento: SKU of the product.	`form`	`string`	commercetools Magento
`cartId`	required in commercetools, o nly for anonymous in Magento The unique ID of the cart.	`form`	`string`	commercetools Magento
`quantity`	required , default is 1 Quantity of products added to the cart.	`form`	`string`	commercetools Magento
`quoteId`	required The quote id.	`form`	`string`	Magento
`definitionName`	required The definition name.	`query`	`string`	commercetools Magento
`connectionName`	required The connection name.	`query`	`string`	commercetools Magento
`accessToken`	required The access token.	`header`	`string`	Magento

commercetools example

Adds an item to a cart.

curl -i --user superuser:superuser -F cartId=d459f9f3-c067-481f-a446-10d1c24157a6 -F productId=84e64c7c-7f98-4a1c-af4a-e8cc2b7f483c -F quantity=5 -X POST -H 'Accept: application/json' 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts/items?definitionName=commercetools&connectionName=connection'

Response

JSON

{"anonymousId":"123","billingAddress":null,"cartState":"ACTIVE","country":null,"createdAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"zone":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"year":2019,"month":"MARCH","monthValue":3,"dayOfMonth":7,"hour":17,"minute":19,"second":38,"nano":144000000,"dayOfWeek":"THURSDAY","dayOfYear":66,"chronology":{"id":"ISO","calendarType":"iso8601"}},"custom":null,"customLineItems":[],"customerEmail":null,"customerGroup":null,"customerId":null,"deleteDaysAfterLastModification":null,"discountCodes":[],"id":"d459f9f3-c067-481f-a446-10d1c24157a6","inventoryMode":"NONE","itemShippingAddresses":[],"lastModifiedAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"zone":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"year":2019,"month":"MARCH","monthValue":3,"dayOfMonth":7,"hour":17,"minute":20,"second":9,"nano":571000000,"dayOfWeek":"THURSDAY","dayOfYear":66,"chronology":{"id":"ISO","calendarType":"iso8601"}},"lineItems":[{"custom":null,"discountedPricePerQuantity":[],"distributionChannel":null,"id":"dc68f18f-d101-4d57-a74d-7f070f496b10","lineItemMode":"STANDARD","name":{"en":"Paco Rabanne"},"price":{"channel":null,"country":null,"custom":null,"customerGroup":null,"discounted":null,"id":"93029315-3c55-4090-ae5a-68a02e35d507","tiers":null,"validFrom":null,"validUntil":null,"value":{"factory":{"defaultMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":63,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"amountType":"org.javamoney.moneta.Money","maxNumber":null,"minNumber":null,"maximalMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null}},"context":{"precision":256,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"number":72,"zero":false,"negative":false,"currency":{"context":{"empty":false,"providerName":"java.util.Currency"},"defaultFractionDigits":2,"currencyCode":"EUR","numericCode":978},"positive":true,"negativeOrZero":false,"positiveOrZero":true}},"priceMode":"PLATFORM","productId":"84e64c7c-7f98-4a1c-af4a-e8cc2b7f483c","productSlug":{"en":"paco-rabanne"},"productType":{"typeId":"product-type","id":"495ab177-e063-43cc-87be-fdb216113274","key":null},"quantity":5,"shippingDetails":null,"state":[{"state":{"typeId":"state","id":"97211d7c-cf9f-4de8-885a-36f492163dfe","key":null},"quantity":5}],"supplyChannel":null,"taxRate":null,"taxedPrice":null,"totalPrice":{"factory":{"defaultMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":63,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"amountType":"org.javamoney.moneta.Money","maxNumber":null,"minNumber":null,"maximalMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null}},"context":{"precision":256,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"number":360,"zero":false,"negative":false,"currency":{"context":{"empty":false,"providerName":"java.util.Currency"},"defaultFractionDigits":2,"currencyCode":"EUR","numericCode":978},"positive":true,"negativeOrZero":false,"positiveOrZero":true},"variant":{"assets":[],"attributes":[{"name":"baseId","value":"624"}],"availability":null,"id":1,"images":[{"url":"https://55b04f920fa53a42249e-5110a72d79ca30656f0873e4e7b95dbe.ssl.cf3.rackcdn.com/paco-rabanne-olympea--SdfLcCO.jpg","dimensions":{"w":215,"h":251},"label":null}],"key":"34","price":null,"prices":[{"channel":null,"country":null,"custom":null,"customerGroup":null,"discounted":null,"id":"93029315-3c55-4090-ae5a-68a02e35d507","tiers":null,"validFrom":null,"validUntil":null,"value":{"factory":{"defaultMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":63,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"amountType":"org.javamoney.moneta.Money","maxNumber":null,"minNumber":null,"maximalMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null}},"context":{"precision":256,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"number":72,"zero":false,"negative":false,"currency":{"context":{"empty":false,"providerName":"java.util.Currency"},"defaultFractionDigits":2,"currencyCode":"EUR","numericCode":978},"positive":true,"negativeOrZero":false,"positiveOrZero":true}}],"scopedPrice":null,"sku":"12341234","isMatchingVariant":null,"scopedPriceDiscounted":null}}],"locale":null,"origin":"CUSTOMER","paymentInfo":null,"refusedGifts":[],"shippingAddress":null,"shippingInfo":null,"shippingRateInput":null,"taxCalculationMode":"LINE_ITEM_LEVEL","taxMode":"PLATFORM","taxRoundingMode":"HALF_EVEN","taxedPrice":null,"totalPrice":{"factory":{"defaultMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":63,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"amountType":"org.javamoney.moneta.Money","maxNumber":null,"minNumber":null,"maximalMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null}},"context":{"precision":256,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"number":360,"zero":false,"negative":false,"currency":{"context":{"empty":false,"providerName":"java.util.Currency"},"defaultFractionDigits":2,"currencyCode":"EUR","numericCode":978},"positive":true,"negativeOrZero":false,"positiveOrZero":true},"version":3}

Magento example (anonymous)

Adds an item to a cart for an anonymous user.

curl -i --user superuser:superuser -F cartId=179 -F productId=24-MB02 -F quantity=5 -F quoteId=39221e4d2830caf22f83da7a0138a393 -X POST -H 'Accept: application/json' 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts/items?definitionName=magento&connectionName=connection'

Response

JSON

{"item_id":162,"sku":"24-MB02","qty":5,"name":"Fusion Backpack","price":59,"product_type":"simple","quote_id":"179"}

Magento example (authenticated)

Adds an item to a cart for an authenticated user.

curl -i --user superuser:superuser -H 'accessToken: sv72pa2wn92k8m81609g8i84s7mpe7ym' -F productId=24-MB02 -F quantity=5 -F quoteId=12 -X POST -H 'Accept: application/json' 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts/items?connectionName=connection&definitionName=magento'

Response

JSON

{"item_id":52,"sku":"24-MB02","qty":5,"name":"Fusion Backpack","price":59,"product_type":"simple","quote_id":"12"}

Post the quantity of items

Changes the quantity of items in a cart.

Request URL

/.rest/ecommerce/v1/carts/items/{itemId}

Parameters

Parameter	Description	Parameter type	Data type	Connector
`itemId`	required The ID of an item in a cart.	`path`	`string`	commercetools Magento
`cartId`	required in commercetools, only for anonymous in Magento The unique ID of the cart.	`form`	`string`	commercetools Magento
`quantity`	required New quantity of products in the cart.	`form`	`string`	commercetools Magento
`quoteId`	required The quote ID.	`form`	`string`	Magento
`definitionName`	required The definition name.	`query`	`string`	commercetools Magento
`connectionName`	required The connection name.	`query`	`string`	commercetools Magento
`accessToken`	required for authenticated users The access token.	`header`	`string`	Magento

commercetools example

Changes the quantity of items in a cart.

curl -i --user superuser:superuser -F quantity=10 -F cartId=6e1ffa9c-2f47-47e3-8b21-93e0b31f86c3 -X POST -H 'Accept: application/json' 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts/items/252ca4db-334b-460e-b372-be9694d8e1eb?definitionName=commercetools&connectionName=connection'

Response

JSON

{"anonymousId":"123","billingAddress":null,"cartState":"ACTIVE","country":null,"createdAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"zone":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"year":2019,"month":"MARCH","monthValue":3,"dayOfMonth":8,"hour":6,"minute":29,"second":34,"nano":469000000,"dayOfWeek":"FRIDAY","dayOfYear":67,"chronology":{"id":"ISO","calendarType":"iso8601"}},"custom":null,"customLineItems":[],"customerEmail":null,"customerGroup":null,"customerId":null,"deleteDaysAfterLastModification":null,"discountCodes":[],"id":"6e1ffa9c-2f47-47e3-8b21-93e0b31f86c3","inventoryMode":"NONE","itemShippingAddresses":[],"lastModifiedAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"zone":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"year":2019,"month":"MARCH","monthValue":3,"dayOfMonth":8,"hour":6,"minute":41,"second":38,"nano":276000000,"dayOfWeek":"FRIDAY","dayOfYear":67,"chronology":{"id":"ISO","calendarType":"iso8601"}},"lineItems":[{"custom":null,"discountedPricePerQuantity":[],"distributionChannel":null,"id":"252ca4db-334b-460e-b372-be9694d8e1eb","lineItemMode":"STANDARD","name":{"en":"Paco Rabanne"},"price":{"channel":null,"country":null,"custom":null,"customerGroup":null,"discounted":null,"id":"93029315-3c55-4090-ae5a-68a02e35d507","tiers":null,"validFrom":null,"validUntil":null,"value":{"factory":{"defaultMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":63,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"amountType":"org.javamoney.moneta.Money","maxNumber":null,"minNumber":null,"maximalMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null}},"context":{"precision":256,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"number":72,"zero":false,"negative":false,"currency":{"context":{"empty":false,"providerName":"java.util.Currency"},"defaultFractionDigits":2,"currencyCode":"EUR","numericCode":978},"positive":true,"negativeOrZero":false,"positiveOrZero":true}},"priceMode":"PLATFORM","productId":"84e64c7c-7f98-4a1c-af4a-e8cc2b7f483c","productSlug":{"en":"paco-rabanne"},"productType":{"typeId":"product-type","id":"495ab177-e063-43cc-87be-fdb216113274","key":null},"quantity":10,"shippingDetails":null,"state":[{"state":{"typeId":"state","id":"97211d7c-cf9f-4de8-885a-36f492163dfe","key":null},"quantity":10}],"supplyChannel":null,"taxRate":null,"taxedPrice":null,"totalPrice":{"factory":{"defaultMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":63,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"amountType":"org.javamoney.moneta.Money","maxNumber":null,"minNumber":null,"maximalMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null}},"context":{"precision":256,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"number":720,"zero":false,"negative":false,"currency":{"context":{"empty":false,"providerName":"java.util.Currency"},"defaultFractionDigits":2,"currencyCode":"EUR","numericCode":978},"positive":true,"negativeOrZero":false,"positiveOrZero":true},"variant":{"assets":[],"attributes":[{"name":"baseId","value":"624"}],"availability":null,"id":1,"images":[{"url":"https://55b04f920fa53a42249e-5110a72d79ca30656f0873e4e7b95dbe.ssl.cf3.rackcdn.com/paco-rabanne-olympea--SdfLcCO.jpg","dimensions":{"w":215,"h":251},"label":null}],"key":"34","price":null,"prices":[{"channel":null,"country":null,"custom":null,"customerGroup":null,"discounted":null,"id":"93029315-3c55-4090-ae5a-68a02e35d507","tiers":null,"validFrom":null,"validUntil":null,"value":{"factory":{"defaultMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":63,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"amountType":"org.javamoney.moneta.Money","maxNumber":null,"minNumber":null,"maximalMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null}},"context":{"precision":256,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"number":72,"zero":false,"negative":false,"currency":{"context":{"empty":false,"providerName":"java.util.Currency"},"defaultFractionDigits":2,"currencyCode":"EUR","numericCode":978},"positive":true,"negativeOrZero":false,"positiveOrZero":true}}],"scopedPrice":null,"sku":"12341234","isMatchingVariant":null,"scopedPriceDiscounted":null}}],"locale":null,"origin":"CUSTOMER","paymentInfo":null,"refusedGifts":[],"shippingAddress":null,"shippingInfo":null,"shippingRateInput":null,"taxCalculationMode":"LINE_ITEM_LEVEL","taxMode":"PLATFORM","taxRoundingMode":"HALF_EVEN","taxedPrice":null,"totalPrice":{"factory":{"defaultMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":63,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"amountType":"org.javamoney.moneta.Money","maxNumber":null,"minNumber":null,"maximalMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null}},"context":{"precision":256,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"number":720,"zero":false,"negative":false,"currency":{"context":{"empty":false,"providerName":"java.util.Currency"},"defaultFractionDigits":2,"currencyCode":"EUR","numericCode":978},"positive":true,"negativeOrZero":false,"positiveOrZero":true},"version":5}

Magento example (anonymous)

Changes the quantity of items in a cart (anonymous user).

curl -i --user superuser:superuser -F qouteId=af619e70d4d03ecc362b8ae4ac7e308f -F quantity=10 -F cartId=119 -X POST -H 'Accept: application/json' 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts/items/103?definitionName=magento&connectionName=connection'

Response

JSON

{"item_id":103,"sku":"24-MB02","qty":10,"name":"Fusion Backpack","price":59,"product_type":"simple","quote_id":"119"}

Magento example (authenticated)

Changes the quantity of items in a cart (authenticated user).

curl -i --user superuser:superuser -H 'accessToken: sv72pa2wn92k8m81609g8i84s7mpe7ym' -F qouteId=12 -F quantity=10 -X POST -H 'Accept: application/json' 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts/items/52?definitionName=magento&connectionName=connection'

Response

JSON

{"item_id":52,"sku":"24-MB02","qty":10,"name":"Fusion Backpack","price":59,"product_type":"simple","quote_id":"12"}

DELETE items

Removes an item from a cart.

Request URL

/.rest/ecommerce/v1/carts/items/{itemId}

Parameters

Parameter	Description	Parameter type	Data type	Connector
`itemId`	required ID of an item in the cart.	`path`	`string`	commercetools Magento
`cartId`	required The unique ID of the cart.	`form`	`string`	commercetools
`definitionName`	required The definition name.	`query`	`string`	commercetools Magento
`connectionName`	required The connection name.	`query`	`string`	commercetools Magento
`accessToken`	required The access token.	`header`	`string`	Magento - authenticated cart
`quoteId`	required The quote id.	`form`	`string`	Magento - anonymous

commercetools example

Removes an item from a cart.

curl -i --user superuser:superuser -X DELETE -H 'Accept: application/json' -F cartId=d459f9f3-c067-481f-a446-10d1c24157a6 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts/items/dc68f18f-d101-4d57-a74d-7f070f496b10?definitionName=commercetools&connectionName=connection'

Response

JSON

{"anonymousId":"123","billingAddress":null,"cartState":"ACTIVE","country":null,"createdAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"zone":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"year":2019,"month":"MARCH","monthValue":3,"dayOfMonth":7,"hour":17,"minute":19,"second":38,"nano":144000000,"dayOfWeek":"THURSDAY","dayOfYear":66,"chronology":{"id":"ISO","calendarType":"iso8601"}},"custom":null,"customLineItems":[],"customerEmail":null,"customerGroup":null,"customerId":null,"deleteDaysAfterLastModification":null,"discountCodes":[],"id":"d459f9f3-c067-481f-a446-10d1c24157a6","inventoryMode":"NONE","itemShippingAddresses":[],"lastModifiedAt":{"offset":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"zone":{"totalSeconds":0,"id":"Z","rules":{"transitions":[],"transitionRules":[],"fixedOffset":true}},"year":2019,"month":"MARCH","monthValue":3,"dayOfMonth":7,"hour":17,"minute":40,"second":34,"nano":55000000,"dayOfWeek":"THURSDAY","dayOfYear":66,"chronology":{"id":"ISO","calendarType":"iso8601"}},"lineItems":[],"locale":null,"origin":"CUSTOMER","paymentInfo":null,"refusedGifts":[],"shippingAddress":null,"shippingInfo":null,"shippingRateInput":null,"taxCalculationMode":"LINE_ITEM_LEVEL","taxMode":"PLATFORM","taxRoundingMode":"HALF_EVEN","taxedPrice":null,"totalPrice":{"factory":{"defaultMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":63,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"amountType":"org.javamoney.moneta.Money","maxNumber":null,"minNumber":null,"maximalMonetaryContext":{"precision":0,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null}},"context":{"precision":256,"fixedScale":false,"maxScale":-1,"amountType":"org.javamoney.moneta.Money","empty":false,"providerName":null},"number":0,"zero":true,"negative":false,"currency":{"context":{"empty":false,"providerName":"java.util.Currency"},"defaultFractionDigits":2,"currencyCode":"EUR","numericCode":978},"positive":false,"negativeOrZero":true,"positiveOrZero":true},"version":5}

Magento example (anonymous)

Removes an item from a cart (anonymous).

curl -i --user superuser:superuser -X DELETE -H 'Accept: application/json' -F quoteId=db24b082c0007eeddf72d4359e6d4cc2 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts/items/159?definitionName=magento&connectionName=connection'

Response

JSON

true

Magento example (authenticated)

Removes an item from a cart (authenticated).

curl -i --user superuser:superuser -H 'accessToken: sv72pa2wn92k8m81609g8i84s7mpe7ym' -X DELETE -H 'Accept: application/json' 'http://localhost:8080/magnoliaAuthor/.rest/ecommerce/v1/carts/items/52?definitionName=magento&connectionName=connection'

Response

JSON

true

Page tree

Cart endpoint API

POST

Post cart as an anonymous user

Request URL

Parameters

commercetools example

Response

Magento example

Response

Post cart as an authenticated user

Request URL

Parameters

commercetools example

Response

Magento example

Response

GET

Get a cart by ID

Request URL

Parameters

commercetools example

Response

Magento example

Response

Get a cart by user ID

Request URL

Parameters

commercetools example

Response

Magento example

Response

POST

Post an item to cart

Request URL

Parameters

commercetools example

Response

Magento example (anonymous)

Response

Magento example (authenticated)

Response

Post the quantity of items

Request URL

Parameters

commercetools example

Response

Magento example (anonymous)

Response

Magento example (authenticated)

Response

DELETE items

Request URL

Parameters

commercetools example

Response

Magento example (anonymous)

Response

Magento example (authenticated)

Response