getShippingMethod

get

/ccagent/v1/shippingMethods/{id}

Get Shipping Method. Get a shipping method.This Endpoint is clone of StoreFront endpoint and it can be used if application running on agent/admin server need access to shipping methods data configured for StoreFront.

Request

Supported Media Types
Path 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 : ranges
Type: array
The price ranges for this shipping method.
Show Source
Nested Schema : shipToLocations
Type: array
Allowed shipping locations.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "shippingCalculator":"priceRange",
    "eligibleForProductWithSurcharges":null,
    "isExternallyPriced":false,
    "ranges":[
        {
            "amount":4.5,
            "high":49.99,
            "low":0,
            "repositoryId":"groundRange_01"
        },
        {
            "amount":8.5,
            "high":99.99,
            "low":50,
            "repositoryId":"groundRange_02"
        },
        {
            "amount":11,
            "high":null,
            "low":100,
            "repositoryId":"groundRange_03"
        }
    ],
    "displayName":"Ground",
    "description":null,
    "type":0,
    "taxCode":null,
    "shippingGroupType":"hardgoodShippingGroup",
    "enabled":true,
    "displaySequence":7,
    "repositoryId":"groundShippingMethod",
    "isFallback":false,
    "shipToLocations":[
        {
            "repositoryId":"100001"
        }
    ]
}

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|No shipping method found with id: {0}|
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