1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. Shipping Methods

updateShippingMethod

put

/ccadmin/v1/shippingMethods/{id}

Update Shipping Method. Update a shipping method based on ID and request parameters. The properties omitted will not be updated. **Requires the x-ccasset-language header so translated content can be set for a specific language.**

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : updateShippingMethod_request
Type: object
Show Source
Example:
{
    "eligibleForProductWithSurcharges":false,
    "isExternallyPriced":true,
    "ranges":[
        {
            "amount":"50.00",
            "high":null,
            "low":0
        }
    ],
    "associatedPriceListGroups":[
        "UsDollar"
    ],
    "shippingCharges":"valid",
    "displayName":"Sea transport",
    "externalId":"externalId",
    "description":"sea transport",
    "taxCode":"abcd",
    "enabled":true,
    "internalName":"Internal Name",
    "repositoryId":"100002",
    "isFallback":false,
    "shipToLocations":[
        {
            "shippingRegion":"SouthUS"
        },
        {
            "shippingRegion":"NorthUS"
        }
    ]
}
Nested Schema : associatedPriceListGroups
Type: array
The Price list group for shipping method
Show Source
Nested Schema : ranges
Type: array
The price ranges for this shipping method.
Show Source
Nested Schema : shipToLocations
Type: array
The Shipping Regions for a Shipping Method
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateShippingMethod_response
Type: object
Show Source
Nested Schema : associatedPriceListGroups
Type: array
The associated Price list groups for this Shipping Method.
Show Source
Nested Schema : ranges
Type: array
The price ranges for this shipping method.
Show Source
Nested Schema : shipToLocations
Type: array
The Shipping Regions for this Shipping Method.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : currency
Type: object
The currency of the price list group.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : shippingCountryRegion
Type: array
The shipping country region.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : country
Type: object
The shipping country.
Show Source
Nested Schema : regions
Type: array
The regions in the shipping country.
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "eligibleForProductWithSurcharges":false,
    "shippingCalculator":"priceRange",
    "isExternallyPriced":false,
    "ranges":[
        {
            "amount":50,
            "high":null,
            "low":0,
            "repositoryId":"100004"
        }
    ],
    "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":"Sea transport",
    "externalId":"id12345",
    "description":"sea transport",
    "type":0,
    "taxCode":"abcd",
    "shippingGroupType":"hardgoodShippingGroup",
    "enabled":true,
    "internalName":"Internal Name",
    "displaySequence":4,
    "repositoryId":"100002",
    "isFallback":false,
    "shipToLocations":[
        {
            "repositoryId":"SouthUS"
        },
        {
            "repositoryId":"NorthUS"
        }
    ]
}

412 Response

ETag mismatch. Asset has been updated by another user.

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| |------------------|------------------| |31005|{0} is not valid price list group| |31010|For any validation error with input data| |31011|Internal error when updating a shipping method| |31018|The Shipping Region {0} does not exist|
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