REST API for Oracle Commerce Cloud December 2017

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

application/json

Path Parameters

id: Type: string

Required: true

The id of the shipping method to get.

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getShippingMethod_response

Properties

description: Type: string

Description of the shipping method.
displayName: Type: string

The display name for the shipping method given the current locale.
displaySequence: Type: integer

Used to determine the ordering of shipping methods in the UI. Lower values should appear first in any ordered list.
eligibleForProductWithSurcharges: Type: boolean

whether this shipping method is enabled for products with surcharges or not.
enabled: Type: boolean

whether this shipping method is enabled or not.
ranges: Type: array ranges

Additional Properties Allowed:

The price ranges for this shipping method.
repositoryId: Type: string

the id of the newly created shipping method item
shippingCalculator: Type: string

A valid key for the available calculator types.
shippingGroupType: Type: string

Shipping group type.
shipToLocations: Type: array shipToLocations

Additional Properties Allowed:

List of shipping locations
taxCode: Type: string

A valid tax code for calculating tax on shipping.
type: Type: integer

The type property of the shipping method.

Nested Schema : ranges

Type: array

The price ranges for this shipping method.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shipToLocations

Type: array

List of shipping locations

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

amount: Type: number

The monetary value for the range.
high: Type: number

The upper boundary of the range.
low: Type: number

The lower boundary of the range.
repositoryId: Type: string

The repository id of this priceRange item.

Nested Schema : items

Type: object

Properties

repositoryId: Type: string

Allowed shipping country-region IDs.

Example application/json


{
    "eligibleForProductWithSurcharges":false,
    "shippingCalculator":"priceRange",
    "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",
    "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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "eligibleForProductWithSurcharges": false,
  "shippingCalculator": "priceRange",
  "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",
  "shipToLocations": [
    {"repositoryId": "SouthUS"},
    {"repositoryId": "NorthUS"}
  ]
}