Jump to

• Request
• Response

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: string
  the id of the shipping method to get

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getShippingMethod_response

Type: object

Show Source

• description(optional): string
  Description of the shipping method.
• displayName(optional): string
  The display name for the shipping method given the current locale.
• displaySequence(optional): integer
  Used to determine the ordering of shipping methods in the UI. Lower values should appear first in any ordered list.
• eligibleForProductWithSurcharges(optional): boolean
  whether this shipping method is enabled for products with surcharges or not.
• enabled(optional): boolean
  whether this shipping method is enabled or not.
• isExternallyPriced(optional): boolean
  Whether this shipping method can be priced externally or not. Defaults to false.
• isFallback(optional): boolean
  Use this shipping method when Commerce Cloud cannot connect to an external shipping service. Defaults to false.
• ranges(optional): array ranges
  The price ranges for this shipping method.
• repositoryId(optional): string
  the id of the newly created shipping method item
• shippingCalculator(optional): string
  A valid key for the available calculator types.
• shippingGroupType(optional): string
  Shipping group type.
• shipToLocations(optional): array shipToLocations
  List of shipping locations
• taxCode(optional): string
  A valid tax code for calculating tax on shipping.
• type(optional): integer
  The type property of the shipping method.

{
    "properties":{
        "eligibleForProductWithSurcharges":{
            "description":"whether this shipping method is enabled for products with surcharges or not.",
            "type":"boolean"
        },
        "shippingCalculator":{
            "description":"A valid key for the available calculator types.",
            "type":"string"
        },
        "isExternallyPriced":{
            "description":"Whether this shipping method can be priced externally or not. Defaults to false.",
            "type":"boolean"
        },
        "ranges":{
            "description":"The price ranges for this shipping method.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "high":{
                        "description":"The upper boundary of the range.",
                        "type":"number"
                    },
                    "amount":{
                        "description":"The value for the range in selected price list group.",
                        "type":"number"
                    },
                    "secondaryCurrencyShippingAmount":{
                        "description":"The value for the range in monetary currency. In case of mix currency, if payShippingInSecondaryCurrency flag is set to true and the secondaryCurrencyCode is set at site, this amount will be calculated according to the exchange rate defined between selected priceListGroup's currency code and site's secondary currency code",
                        "type":"number"
                    },
                    "low":{
                        "description":"The lower boundary of the range.",
                        "type":"number"
                    },
                    "repositoryId":{
                        "description":"The repository id of this priceRange item.",
                        "type":"string"
                    }
                }
            }
        },
        "displayName":{
            "description":"The display name for the shipping method given the current locale.",
            "type":"string"
        },
        "description":{
            "description":"Description of the shipping method.",
            "type":"string"
        },
        "type":{
            "description":"The type property of the shipping method.",
            "type":"integer"
        },
        "taxCode":{
            "description":"A valid tax code for calculating tax on shipping.",
            "type":"string"
        },
        "shippingGroupType":{
            "description":"Shipping group type.",
            "type":"string"
        },
        "enabled":{
            "description":"whether this shipping method is enabled or not.",
            "type":"boolean"
        },
        "displaySequence":{
            "description":"Used to determine the ordering of shipping methods in the UI. Lower values should appear first in any ordered list.",
            "type":"integer"
        },
        "repositoryId":{
            "description":"the id of the newly created shipping method item",
            "type":"string"
        },
        "isFallback":{
            "description":"Use this shipping method when Commerce Cloud cannot connect to an external shipping service. Defaults to false.",
            "type":"boolean"
        },
        "shipToLocations":{
            "description":"List of shipping locations",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Allowed shipping country-region IDs.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : ranges

Type: array

The price ranges for this shipping method.

Show Source

• Array of: object items

{
    "description":"The price ranges for this shipping method.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "high":{
                "description":"The upper boundary of the range.",
                "type":"number"
            },
            "amount":{
                "description":"The value for the range in selected price list group.",
                "type":"number"
            },
            "secondaryCurrencyShippingAmount":{
                "description":"The value for the range in monetary currency. In case of mix currency, if payShippingInSecondaryCurrency flag is set to true and the secondaryCurrencyCode is set at site, this amount will be calculated according to the exchange rate defined between selected priceListGroup's currency code and site's secondary currency code",
                "type":"number"
            },
            "low":{
                "description":"The lower boundary of the range.",
                "type":"number"
            },
            "repositoryId":{
                "description":"The repository id of this priceRange item.",
                "type":"string"
            }
        }
    }
}

Nested Schema : shipToLocations

Type: array

List of shipping locations

Show Source

• Array of: object items

{
    "description":"List of shipping locations",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Allowed shipping country-region IDs.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  The value for the range in selected price list group.
• high(optional): number
  The upper boundary of the range.
• low(optional): number
  The lower boundary of the range.
• repositoryId(optional): string
  The repository id of this priceRange item.
• secondaryCurrencyShippingAmount(optional): number
  The value for the range in monetary currency. In case of mix currency, if payShippingInSecondaryCurrency flag is set to true and the secondaryCurrencyCode is set at site, this amount will be calculated according to the exchange rate defined between selected priceListGroup's currency code and site's secondary currency code

{
    "type":"object",
    "properties":{
        "high":{
            "description":"The upper boundary of the range.",
            "type":"number"
        },
        "amount":{
            "description":"The value for the range in selected price list group.",
            "type":"number"
        },
        "secondaryCurrencyShippingAmount":{
            "description":"The value for the range in monetary currency. In case of mix currency, if payShippingInSecondaryCurrency flag is set to true and the secondaryCurrencyCode is set at site, this amount will be calculated according to the exchange rate defined between selected priceListGroup's currency code and site's secondary currency code",
            "type":"number"
        },
        "low":{
            "description":"The lower boundary of the range.",
            "type":"number"
        },
        "repositoryId":{
            "description":"The repository id of this priceRange item.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  Allowed shipping country-region IDs.

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Allowed shipping country-region IDs.",
            "type":"string"
        }
    }
}

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

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top