Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Cart Items API

Products added to a cart are referred to as a `cart_item`.

Elastic Path Cart Items API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cart Items. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 3 paths, and defines 37 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

7 operations 3 paths 37 schemas 3 DELETE1 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path Cart Items API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 3 DELETE, 1 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Cart Items 7

Products added to a cart are referred to as a cartitem.

GET
/v2/carts/{cartID}/items
Get Cart Items
getCartItems 2 params → 200
PUT
/v2/carts/{cartID}/items
Bulk Update Items in Cart
bulkUpdateItemsInCart 1 param body → 200400403404422
POST
/v2/carts/{cartID}/items
Add Items to Cart
manageCarts 1 param body → 201400403404422500
DELETE
/v2/carts/{cartID}/items
Delete all Cart Items
deleteAllCartItems 1 param → 204422
PUT
/v2/carts/{cartID}/items/{cartitemID}
Update a Cart Item
updateACartItem 2 params body → 200400403404
DELETE
/v2/carts/{cartID}/items/{cartitemID}
Delete a Cart Item
deleteACartItem 2 params → 200
DELETE
/v2/carts/{cartID}/discounts/{promoCode}
Delete a Promotion via Promotion Code
deleteAPromotionViaPromotionCode 2 params → 204

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are CartItemResponse (29 properties), BaseItemObjectData (9 properties), CustomItemObjectData (9 properties), CustomDiscountResponse (8 properties). Each schema is shown below with its type and property counts.

SubscriptionItemObjectData
object
4 properties 4 required
BulkUpdateCartsItemsCommon
object
6 properties
Money
object
3 properties 3 required
CustomDiscountResponse
object
8 properties
BulkUpdateCartsItemsWithQuantity
FormattedPriceData
object
3 properties
Timestamps
object
2 properties
Response.ErrorItem
object
5 properties 2 required
CustomItemObjectData
object
9 properties 4 required
RelationshipItem
object
Relationship data entry
2 properties 2 required
TaxItemResponse
object
7 properties
BulkUpdateCartsItemsWithShippingGroup
CartItemObjectData
CartTimestamps
object
3 properties
CartItemObjectRequest
object
1 property
CartMergeObject
object
2 properties 2 required
ReOrderObjectRequest
object
2 properties
BulkAddItemsRequest
object
2 properties
BulkUpdateCartsItemsWithCustomInputs
Discount
object
6 properties 2 required
CartItemCollectionResponse
object
4 properties 1 required
Response.ErrorResponse
object
1 property 1 required
SubscriptionItemObject
object
1 property
PromotionItemObjectData
object
2 properties 2 required
CustomItemObject
object
1 property
BaseItemObjectData
object
9 properties 1 required
CartItemFormattedPriceData
object
2 properties
CartItemResponse
object
29 properties
CartMergeObjectRequest
object
2 properties
UpdateAllOrNothingOptionsObject
object
1 property
CustomAttributes
object
Specifies custom attributes for cart or order objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute valu…
UpdateCartsItems
object
1 property
ReOrderObject
object
2 properties 2 required
AddAllOrNothingOptionsObject
object
1 property
BulkUpdateCartsItems
object
2 properties
PromotionItemObject
object
1 property
ItemPriceData
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-cart-items-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API