REST API for Oracle Commerce Cloud December 2017

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

application/json

Path Parameters

id: Type: string

Required: true

the id of the shipping method to get

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


{
    "shippingCalculator":"priceRange",
    "eligibleForProductWithSurcharges":null,
    "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",
    "displaySequence":7,
    "repositoryId":"groundShippingMethod",
    "description":null,
    "type":0,
    "taxCode":null,
    "shippingGroupType":"hardgoodShippingGroup",
    "enabled":true,
    "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

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:

{
  "shippingCalculator": "priceRange",
  "eligibleForProductWithSurcharges": null,
  "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",
  "displaySequence": 7,
  "repositoryId": "groundShippingMethod",
  "description": null,
  "type": 0,
  "taxCode": null,
  "shippingGroupType": "hardgoodShippingGroup",
  "enabled": true,
  "shipToLocations": [{"repositoryId": "100001"}]
}