Jump to

• Request
• Response

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

• application/json

Query Parameters

• shippingGroupIds: string
  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

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listShippingMethodsForCurrentOrder_response

Type: object

Show Source

• items(optional): array items
  The array of shipping method details for a shipping groups.

{
    "properties":{
        "items":{
            "description":"The array of shipping method details for a shipping groups.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "shippingGroupId":{
                        "description":"The shipping group ID.",
                        "type":"string"
                    },
                    "shippingMethods":{
                        "description":"The shipping methods",
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/shippingMethod"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The array of shipping method details for a shipping groups.

Show Source

• Array of: object items

{
    "description":"The array of shipping method details for a shipping groups.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "shippingGroupId":{
                "description":"The shipping group ID.",
                "type":"string"
            },
            "shippingMethods":{
                "description":"The shipping methods",
                "type":"array",
                "items":{
                    "$ref":"#/definitions/shippingMethod"
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• shippingGroupId(optional): string
  The shipping group ID.
• shippingMethods(optional): array shippingMethods
  The shipping methods

{
    "type":"object",
    "properties":{
        "shippingGroupId":{
            "description":"The shipping group ID.",
            "type":"string"
        },
        "shippingMethods":{
            "description":"The shipping methods",
            "type":"array",
            "items":{
                "$ref":"#/definitions/shippingMethod"
            }
        }
    }
}

Nested Schema : shippingMethods

Type: array

The shipping methods

Show Source

• Array of: object shippingMethod
  The shipping method details

{
    "description":"The shipping methods",
    "type":"array",
    "items":{
        "$ref":"#/definitions/shippingMethod"
    }
}

Nested Schema : shippingMethod

Type: object

The shipping method details

Show Source

• allSites(optional): boolean
  Whether or not it includes all sites in the response.

  Example: true
• associatedPriceListGroups(optional): array associatedPriceListGroups
  The associated Price list groups for this Shipping Method.
• description(optional): string
  The description of shipping group.

  Example: Standard shipping method
• displayName(optional): string
  The display name for the shipping method given the current locale.

  Example: Standard
• displaySequence(optional): integer
  Used to determine the ordering of shipping methods in the UI. Lower values should appear first in any ordered list.

  Example: 0
• eligibleForProductWithSurcharges(optional): boolean
  Whether this shipping method is enabled for products with surcharges or not. Defaults to null.

  Example: true
• enabled(optional): boolean
  Whether this shipping method is enabled or not.

  Example: true
• excludedCategories(optional): array excludedCategories
  The excluded categories
• excludedCategoriesShippingCharge(optional): array excludedCategoriesShippingCharge
  List of categories excluded from shipping charges.
• id(optional): string
  The shipping method id.

  Example: standardShippingMethod
• isExternallyPriced(optional): boolean
  Whether this shipping method can be priced externally or not. Defaults to false.

  Example: false
• isFallback(optional): boolean
  Use this shipping method when Commerce Cloud cannot connect to an external shipping service. Defaults to false.

  Example: false
• ranges(optional): array ranges
  The price ranges for this shipping method
• repositoryId(optional): string
  The id of the shipping method item

  Example: standardShippingMethod
• shippingCalculator(optional): string
  a valid key for the available calculator types

  Example: priceRange
• shippingGroupType(optional): string
  The shipping group type.

  Example: hardgoodShippingGroup
• shipToLocations(optional): array shipToLocations
  The array of repository IDs of shipping locations.
• sites(optional): array sites
  List of sites.
• taxCode(optional): string
  A valid tax code for calculating tax on shipping.

  Example: TAX0001
• type(optional): integer
  The type property of the shipping method.

  Example: 0

{
    "description":"The shipping method details",
    "type":"object",
    "properties":{
        "shippingCalculator":{
            "description":"a valid key for the available calculator types",
            "type":"string",
            "example":"priceRange"
        },
        "eligibleForProductWithSurcharges":{
            "description":"Whether this shipping method is enabled for products with surcharges or not. Defaults to null.",
            "type":"boolean",
            "example":true
        },
        "isExternallyPriced":{
            "description":"Whether this shipping method can be priced externally or not. Defaults to false.",
            "type":"boolean",
            "example":false
        },
        "ranges":{
            "description":"The price ranges for this shipping method",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "high":{
                        "description":"The upper boundary of the range",
                        "type":"number",
                        "example":99.99
                    },
                    "amount":{
                        "description":"The monetary value for the range",
                        "type":"number",
                        "example":25
                    },
                    "secondaryCurrencyShippingAmount":{
                        "description":"In case of mix currency, if secondaryCurrencyCode is sent in request, shipping amount will be calculated according to given secondaryCurrencyCode. Else if payShippingInSecondaryCurrency flag is enabled in site repository, shipping amount will be calculated according to site level secondaryCurrencyCode",
                        "type":"string"
                    },
                    "low":{
                        "description":"The lower boundary of the range",
                        "type":"number",
                        "example":0
                    },
                    "repositoryId":{
                        "description":"The repository id of this priceRange item",
                        "type":"string",
                        "example":"standardRange_01"
                    }
                }
            }
        },
        "associatedPriceListGroups":{
            "description":"The associated Price list groups for this Shipping Method.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "deleted":{
                        "description":"If the price list deleted",
                        "type":"boolean",
                        "example":false
                    },
                    "displayName":{
                        "description":"The display name of the price list group.",
                        "type":"string",
                        "example":"Default Price Group"
                    },
                    "repositoryId":{
                        "description":"The repository Id of the price list group.",
                        "type":"string",
                        "example":"defaultPriceGroup"
                    },
                    "active":{
                        "description":"If the price list group is active.",
                        "type":"boolean",
                        "example":true
                    },
                    "currency":{
                        "description":"The currency of the price list group.",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"The repository ID of the currency.",
                                "type":"string",
                                "example":"en_US"
                            }
                        }
                    },
                    "id":{
                        "description":"The id of the price list group.",
                        "type":"string",
                        "example":"defaultPriceGroup"
                    },
                    "locale":{
                        "description":"The locale associated",
                        "type":"string",
                        "example":"en_US"
                    }
                }
            }
        },
        "displayName":{
            "description":"The display name for the shipping method given the current locale.",
            "type":"string",
            "example":"Standard"
        },
        "description":{
            "description":"The description of shipping group.",
            "type":"string",
            "example":"Standard shipping method"
        },
        "allSites":{
            "description":"Whether or not it includes all sites in the response.",
            "type":"boolean",
            "example":true
        },
        "sites":{
            "description":"List of sites.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The site id.",
                        "type":"string",
                        "example":"siteUS"
                    }
                }
            }
        },
        "type":{
            "description":"The type property of the shipping method.",
            "type":"integer",
            "example":0
        },
        "taxCode":{
            "description":"A valid tax code for calculating tax on shipping.",
            "type":"string",
            "example":"TAX0001"
        },
        "shippingGroupType":{
            "description":"The shipping group type.",
            "type":"string",
            "example":"hardgoodShippingGroup"
        },
        "enabled":{
            "description":"Whether this shipping method is enabled or not.",
            "type":"boolean",
            "example":true
        },
        "displaySequence":{
            "description":"Used to determine the ordering of shipping methods in the UI. Lower values should appear first in any ordered list.",
            "type":"integer",
            "example":0
        },
        "repositoryId":{
            "description":"The id of the shipping method item",
            "type":"string",
            "example":"standardShippingMethod"
        },
        "id":{
            "description":"The shipping method id.",
            "type":"string",
            "example":"standardShippingMethod"
        },
        "isFallback":{
            "description":"Use this shipping method when Commerce Cloud cannot connect to an external shipping service. Defaults to false.",
            "type":"boolean",
            "example":false
        },
        "excludedCategoriesShippingCharge":{
            "description":"List of categories excluded from shipping charges.",
            "type":"array",
            "items":{
                "type":"string",
                "example":"cat40012"
            }
        },
        "excludedCategories":{
            "description":"The excluded categories",
            "type":"array",
            "items":{
                "type":"string",
                "example":"cat400111"
            }
        },
        "shipToLocations":{
            "description":"The array of repository IDs of shipping locations.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The id of the ship to location.",
                        "type":"string",
                        "example":1000001
                    }
                }
            }
        }
    }
}

Nested Schema : associatedPriceListGroups

Type: array

The associated Price list groups for this Shipping Method.

Show Source

• Array of: object items

{
    "description":"The associated Price list groups for this Shipping Method.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "deleted":{
                "description":"If the price list deleted",
                "type":"boolean",
                "example":false
            },
            "displayName":{
                "description":"The display name of the price list group.",
                "type":"string",
                "example":"Default Price Group"
            },
            "repositoryId":{
                "description":"The repository Id of the price list group.",
                "type":"string",
                "example":"defaultPriceGroup"
            },
            "active":{
                "description":"If the price list group is active.",
                "type":"boolean",
                "example":true
            },
            "currency":{
                "description":"The currency of the price list group.",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The repository ID of the currency.",
                        "type":"string",
                        "example":"en_US"
                    }
                }
            },
            "id":{
                "description":"The id of the price list group.",
                "type":"string",
                "example":"defaultPriceGroup"
            },
            "locale":{
                "description":"The locale associated",
                "type":"string",
                "example":"en_US"
            }
        }
    }
}

Nested Schema : excludedCategories

Type: array

The excluded categories

Show Source

• Array of: string
  Example: cat400111

{
    "description":"The excluded categories",
    "type":"array",
    "items":{
        "type":"string",
        "example":"cat400111"
    }
}

Nested Schema : excludedCategoriesShippingCharge

Type: array

List of categories excluded from shipping charges.

Show Source

• Array of: string
  Example: cat40012

{
    "description":"List of categories excluded from shipping charges.",
    "type":"array",
    "items":{
        "type":"string",
        "example":"cat40012"
    }
}

Nested Schema : ranges

Type: array

The price ranges for this shipping method

Show Source

• Array of: object items

{
    "description":"The price ranges for this shipping method",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "high":{
                "description":"The upper boundary of the range",
                "type":"number",
                "example":99.99
            },
            "amount":{
                "description":"The monetary value for the range",
                "type":"number",
                "example":25
            },
            "secondaryCurrencyShippingAmount":{
                "description":"In case of mix currency, if secondaryCurrencyCode is sent in request, shipping amount will be calculated according to given secondaryCurrencyCode. Else if payShippingInSecondaryCurrency flag is enabled in site repository, shipping amount will be calculated according to site level secondaryCurrencyCode",
                "type":"string"
            },
            "low":{
                "description":"The lower boundary of the range",
                "type":"number",
                "example":0
            },
            "repositoryId":{
                "description":"The repository id of this priceRange item",
                "type":"string",
                "example":"standardRange_01"
            }
        }
    }
}

Nested Schema : shipToLocations

Type: array

The array of repository IDs of shipping locations.

Show Source

• Array of: object items

{
    "description":"The array of repository IDs of shipping locations.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The id of the ship to location.",
                "type":"string",
                "example":1000001
            }
        }
    }
}

Nested Schema : sites

Type: array

List of sites.

Show Source

• Array of: object items

{
    "description":"List of sites.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"The site id.",
                "type":"string",
                "example":"siteUS"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• active(optional): boolean
  If the price list group is active.

  Example: true
• currency(optional): object currency
  The currency of the price list group.
• deleted(optional): boolean
  If the price list deleted

  Example: false
• displayName(optional): string
  The display name of the price list group.

  Example: Default Price Group
• id(optional): string
  The id of the price list group.

  Example: defaultPriceGroup
• locale(optional): string
  The locale associated

  Example: en_US
• repositoryId(optional): string
  The repository Id of the price list group.

  Example: defaultPriceGroup

{
    "type":"object",
    "properties":{
        "deleted":{
            "description":"If the price list deleted",
            "type":"boolean",
            "example":false
        },
        "displayName":{
            "description":"The display name of the price list group.",
            "type":"string",
            "example":"Default Price Group"
        },
        "repositoryId":{
            "description":"The repository Id of the price list group.",
            "type":"string",
            "example":"defaultPriceGroup"
        },
        "active":{
            "description":"If the price list group is active.",
            "type":"boolean",
            "example":true
        },
        "currency":{
            "description":"The currency of the price list group.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"The repository ID of the currency.",
                    "type":"string",
                    "example":"en_US"
                }
            }
        },
        "id":{
            "description":"The id of the price list group.",
            "type":"string",
            "example":"defaultPriceGroup"
        },
        "locale":{
            "description":"The locale associated",
            "type":"string",
            "example":"en_US"
        }
    }
}

Nested Schema : currency

Type: object

The currency of the price list group.

Show Source

• repositoryId(optional): string
  The repository ID of the currency.

  Example: en_US

{
    "description":"The currency of the price list group.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The repository ID of the currency.",
            "type":"string",
            "example":"en_US"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The monetary value for the range

  Example: 25
• high(optional): number
  The upper boundary of the range

  Example: 99.99
• low(optional): number
  The lower boundary of the range

  Example: 0
• repositoryId(optional): string
  The repository id of this priceRange item

  Example: standardRange_01
• secondaryCurrencyShippingAmount(optional): string
  In case of mix currency, if secondaryCurrencyCode is sent in request, shipping amount will be calculated according to given secondaryCurrencyCode. Else if payShippingInSecondaryCurrency flag is enabled in site repository, shipping amount will be calculated according to site level secondaryCurrencyCode

{
    "type":"object",
    "properties":{
        "high":{
            "description":"The upper boundary of the range",
            "type":"number",
            "example":99.99
        },
        "amount":{
            "description":"The monetary value for the range",
            "type":"number",
            "example":25
        },
        "secondaryCurrencyShippingAmount":{
            "description":"In case of mix currency, if secondaryCurrencyCode is sent in request, shipping amount will be calculated according to given secondaryCurrencyCode. Else if payShippingInSecondaryCurrency flag is enabled in site repository, shipping amount will be calculated according to site level secondaryCurrencyCode",
            "type":"string"
        },
        "low":{
            "description":"The lower boundary of the range",
            "type":"number",
            "example":0
        },
        "repositoryId":{
            "description":"The repository id of this priceRange item",
            "type":"string",
            "example":"standardRange_01"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  The id of the ship to location.

  Example: 1000001

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The id of the ship to location.",
            "type":"string",
            "example":1000001
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  The site id.

  Example: siteUS

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The site id.",
            "type":"string",
            "example":"siteUS"
        }
    }
}

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

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top