getShippingMethod

get

/ccadmin/v1/shippingMethods/{id}

Get Shipping Method. Get a shipping method based on ID. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
Path Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getShippingMethod_response
Type: object
Show Source
Nested Schema : associatedPriceListGroups
Type: array
The associated Price list groups for this Shipping Method.
Show Source
Nested Schema : ranges
Type: array
The price ranges for this shipping method.
Show Source
Nested Schema : shipToLocations
Type: array
The Shipping Regions for a Shipping Method
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
Example Response (application/json)
{
    "eligibleForProductWithSurcharges":false,
    "shippingCalculator":"priceRange",
    "isExternallyPriced":false,
    "ranges":[
        {
            "amount":4.75,
            "high":14.99,
            "low":0,
            "repositoryId":"groundRange1"
        },
        {
            "amount":5.95,
            "high":49.99,
            "low":15,
            "repositoryId":"groundRange2"
        },
        {
            "amount":6.5,
            "high":null,
            "low":50,
            "repositoryId":"groundRange3"
        }
    ],
    "associatedPriceListGroups":[
        {
            "displayName":"UsDollar",
            "listPriceList":{
                "repositoryId":"listPrices"
            },
            "repositoryId":"UsDollar",
            "active":true,
            "salePriceList":{
                "repositoryId":"salePrices"
            },
            "currency":{
                "symbol":"$",
                "displayName":"US Dollar",
                "repositoryId":"en_US",
                "fractionalDigits":2,
                "currencyCode":"USD",
                "numericCode":"840"
            },
            "id":"UsDollar",
            "locale":"en_US",
            "shippingSurchargePriceList":{
                "repositoryId":"shippingSurchargePrices"
            }
        }
    ],
    "displayName":"Ground",
    "description":null,
    "type":0,
    "taxCode":"FR020400",
    "shippingGroupType":"hardgoodShippingGroup",
    "enabled":true,
    "displaySequence":0,
    "repositoryId":"ground",
    "isFallback":false,
    "shipToLocations":[
        {
            "repositoryId":"SouthUS"
        },
        {
            "repositoryId":"NorthUS"
        }
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |31015|If there was no shipping method found with the given id.|
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