» Shipping Rate PUT API Documentation

Updating a Shipping Rate

Endpoint: PUT /api/v4/admin/shipping_rates/{shipping_rate_id}

Purpose

This API updates the attributes of an existing shipping rate identified by its ID. This includes modifying the policy type, conditions, cost settings, and other relevant shipping configurations.

Path Parameters

ParameterTypeDescription
shipping_rate_idIntegerRequired. ID of the shipping rate.

Query Parameters

No query parameters for this endpoint.

Use Case

An admin needs to revise an existing flat-rate shipping policy by enabling cumulative charges and updating the cost-related conditions for better pricing flexibility.

Request Body

The request body must include updated shipping rate data and its associated conditions. All existing data will be overwritten with the new values provided.

Response

Returns the updated shipping rate object with its ID and the latest values, including conditions and timestamps for creation and update.