Shipping::Rates::Name

Add a new rate name to a shipping profile

post/workspaces/{workspace_id}/shipping/rates/names

Request

Path parameters

workspace_idstring required

Request body

Example request

{
  "shipping_rates_name": {
    "shipping_rates_name": {
      "name": "Example Shipping Rates Name"
    }
  }
}

Response

Created

idinteger

Rate Name ID

public_idstring nullable

Rate Name public ID

workspace_idinteger

Workspace ID

namestring

Rate Name

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

Example response

{
  "id": 2,
  "public_id": "DRAhis",
  "workspace_id": 42000,
  "name": "Example Shipping Rates Name",
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}

Changes

    • info

      for the path request parameter workspace_id, the type was generalized from integer to string

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status