REST API for Oracle Commerce Cloud December 2017

listShippingMethods

get

/ccadmin/v1/shippingMethods

List Shipping Methods. Get a list of shipping methods based on request parameters. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

application/json

Query Parameters

enabledOnly: Type: boolean

Only return shipping methods which are enabled. Defaults to true.
production: Type: boolean

If set to true, returns shipping methods from the production database i.e only published data will be retrieved.
shippingGroupType: Type: string

If set, only returns shipping methods of the given shipping group type.
useSiteHeader: Type: boolean

If set to true, returns shipping methods of the given site else return all the shipping methods. Defaults to false

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 : listShippingMethods_response

Properties

object: Type: array object

Additional Properties Allowed:

the array of shipping methods

Nested Schema : object

Type: array

the array of shipping methods

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

description: Type: string

The description of shipping group.
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 shipping method item
shippingCalculator: Type: string

a valid key for the available calculator types
shippingGroupType: Type: string

The shipping group type.
shipToLocations: Type: array shipToLocations

Additional Properties Allowed:

The array of repository IDs 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

The array of repository IDs 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

Repository ID of shipping location.

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"
            }
        ]
    },
    {
        "eligibleForProductWithSurcharges":true,
        "shippingCalculator":"priceRange",
        "ranges":[
            {
                "amount":8.75,
                "high":14.99,
                "low":0,
                "repositoryId":"twoDayRange1"
            },
            {
                "amount":9.95,
                "high":49.99,
                "low":15,
                "repositoryId":"twoDayRange2"
            },
            {
                "amount":10.5,
                "high":null,
                "low":50,
                "repositoryId":"twoDayRange3"
            }
        ],
        "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":"Two Day",
        "description":null,
        "type":0,
        "taxCode":"FR020400",
        "shippingGroupType":"hardgoodShippingGroup",
        "enabled":true,
        "displaySequence":1,
        "repositoryId":"twoDay",
        "shipToLocations":[
            {
                "repositoryId":"SouthUS"
            },
            {
                "repositoryId":"EastUS"
            }
        ]
    },
    {
        "eligibleForProductWithSurcharges":false,
        "shippingCalculator":"priceRange",
        "ranges":[
            {
                "amount":16.4,
                "high":null,
                "low":0,
                "repositoryId":"overnightRange1"
            }
        ],
        "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":"Overnight",
        "description":null,
        "type":0,
        "taxCode":"FR020400",
        "shippingGroupType":"hardgoodShippingGroup",
        "enabled":true,
        "displaySequence":2,
        "repositoryId":"overnight",
        "shipToLocations":[
            {
                "repositoryId":"WestUS"
            },
            {
                "repositoryId":"NorthUS"
            }
        ]
    },
    {
        "eligibleForProductWithSurcharges":false,
        "shippingCalculator":"priceRange",
        "ranges":[
            {
                "amount":66,
                "high":59.99,
                "low":0,
                "repositoryId":"100001"
            },
            {
                "amount":76,
                "high":null,
                "low":60,
                "repositoryId":"100002"
            }
        ],
        "associatedPriceListGroups":[
        ],
        "displayName":"asdfsdaf",
        "description":null,
        "type":0,
        "taxCode":null,
        "shippingGroupType":"hardgoodShippingGroup",
        "enabled":true,
        "displaySequence":3,
        "repositoryId":"100001",
        "shipToLocations":[
        ]
    }
]

Default Response

The error response

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"}
    ]
  },
  {
    "eligibleForProductWithSurcharges": true,
    "shippingCalculator": "priceRange",
    "ranges": [
      {
        "amount": 8.75,
        "high": 14.99,
        "low": 0,
        "repositoryId": "twoDayRange1"
      },
      {
        "amount": 9.95,
        "high": 49.99,
        "low": 15,
        "repositoryId": "twoDayRange2"
      },
      {
        "amount": 10.5,
        "high": null,
        "low": 50,
        "repositoryId": "twoDayRange3"
      }
    ],
    "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": "Two Day",
    "description": null,
    "type": 0,
    "taxCode": "FR020400",
    "shippingGroupType": "hardgoodShippingGroup",
    "enabled": true,
    "displaySequence": 1,
    "repositoryId": "twoDay",
    "shipToLocations": [
      {"repositoryId": "SouthUS"},
      {"repositoryId": "EastUS"}
    ]
  },
  {
    "eligibleForProductWithSurcharges": false,
    "shippingCalculator": "priceRange",
    "ranges": [{
      "amount": 16.4,
      "high": null,
      "low": 0,
      "repositoryId": "overnightRange1"
    }],
    "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": "Overnight",
    "description": null,
    "type": 0,
    "taxCode": "FR020400",
    "shippingGroupType": "hardgoodShippingGroup",
    "enabled": true,
    "displaySequence": 2,
    "repositoryId": "overnight",
    "shipToLocations": [
      {"repositoryId": "WestUS"},
      {"repositoryId": "NorthUS"}
    ]
  },
  {
    "eligibleForProductWithSurcharges": false,
    "shippingCalculator": "priceRange",
    "ranges": [
      {
        "amount": 66,
        "high": 59.99,
        "low": 0,
        "repositoryId": "100001"
      },
      {
        "amount": 76,
        "high": null,
        "low": 60,
        "repositoryId": "100002"
      }
    ],
    "associatedPriceListGroups": [],
    "displayName": "asdfsdaf",
    "description": null,
    "type": 0,
    "taxCode": null,
    "shippingGroupType": "hardgoodShippingGroup",
    "enabled": true,
    "displaySequence": 3,
    "repositoryId": "100001",
    "shipToLocations": []
  }
]