listShippingMethodsForCurrentOrder

get

/ccstore/v1/shippingMethods

List Shipping Methods for Current Order (Cart). Get a list of shipping methods supported for the address of each shipping group id passed in. The shipping group id must match a shipping group in the cart. It will ignore any shipping groups that do not support an address. If no ids are passed it will automatically use all the shipping groups in the cart. This endpoint can be used to obtain the supported shipping methods for the logged in shopper???s cart. It may be used for the anonymous shopper???s cart when used alongside the cart (current incomplete order) actions grouping. Anonymous shoppers must be identified using X-CCVisitorId.

Request

Supported Media Types
Query Parameters
  • Comma seperated list of shipping group ids contained in the cart. Used to provide a subset of the carts shipping groups. Example ?shippingGroupIds=sg123456,sg234567.
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listShippingMethodsForCurrentOrder_response
Type: object
Show Source
Nested Schema : items
Type: array
The array of shipping method details for a shipping groups.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : shippingMethods
Type: array
The shipping methods
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details
Show Source
Nested Schema : associatedPriceListGroups
Type: array
The associated Price list groups for this Shipping Method.
Show Source
Nested Schema : excludedCategories
Type: array
The excluded categories
Show Source
Nested Schema : excludedCategoriesShippingCharge
Type: array
List of categories excluded from shipping charges.
Show Source
Nested Schema : ranges
Type: array
The price ranges for this shipping method
Show Source
Nested Schema : shipToLocations
Type: array
The array of repository IDs of shipping locations.
Show Source
Nested Schema : sites
Type: array
List of sites.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : currency
Type: object
The currency of the price list group.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source

500 Response

The error response. The following error occurs when a shipping group id passed via the shippingGroupIds query parameter is not contained within the cart. |Error Code|Description| |------------------|------------------| |28441|Shipping group sg45678 not found in the cart.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top