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 Shipping Groups API

The Cart Shipping Groups API from Elastic Path — 2 operation(s) for cart shipping groups.

Elastic Path Cart Shipping Groups 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 Shipping Groups. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 29 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.

5 operations 2 paths 29 schemas 1 DELETE2 GET1 POST1 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 Shipping Groups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 5

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

Cart Shipping Groups 5
GET
/v2/carts/{cartID}/shipping-groups
Retrieve all shipping groups for a cart
getShippingGroups 1 param → 200404
POST
/v2/carts/{cartID}/shipping-groups
Create a new shipping group for a cart
createShippingGroup 1 param body → 201400404
GET
/v2/carts/{cartId}/shipping-groups/{shippingGroupId}
Retrieve a specific shipping group for a cart
getShippingGroupById 2 params → 200404
PUT
/v2/carts/{cartId}/shipping-groups/{shippingGroupId}
Update a shipping group for a cart
updateShippingGroup 2 params body → 200400404
DELETE
/v2/carts/{cartId}/shipping-groups/{shippingGroupId}
Delete Cart Shipping Group
deleteCartShippingGroup 2 params → 204400404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are OrderItemResponse (23 properties), ShippingGroupResponse (15 properties), AddressCommon (10 properties), OrderPriceWrapperMeta (10 properties). Each schema is shown below with its type and property counts.

Money
object
3 properties 3 required
OrderPriceWrapperMeta
object
Order pricing information.
10 properties 10 required
OrderItemResponse
object
23 properties
DiscountFormattedPriceData
object
3 properties
FormattedPriceData
object
3 properties
Response.ErrorItem
object
5 properties 2 required
Timestamps
object
2 properties
ShippingAddress
Shipping address information. You must specify at least one of region (state/province) or county.
RelationshipItem
object
Relationship data entry
2 properties 2 required
AddressWithRegion
ShippingPriceRequest
object
5 properties
DiscountData
object
6 properties
CreateShippingGroupRequest
object
1 property
ShippingPriceResponse
object
5 properties 2 required
Discounts
array
AddressWithCounty
SingleRelationship
object
Single relationship
1 property
Discount
object
6 properties 2 required
NonNegativeFormattedPriceData
object
3 properties
Response.ErrorResponse
object
1 property 1 required
ShippingGroupEntityResponse
object
3 properties
ShippingGroupResponse
object
15 properties
DeliveryEstimate
object
2 properties
ShippingGroupMeta
object
2 properties
OrderItemFormattedUnitPriceData
object
2 properties
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…
OrderPriceData
object
3 properties
AddressCommon
object
10 properties 5 required
UpdateCartShippingGroupRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-cart-shipping-groups-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