Freight Accessorial Manual Rate Create V1 Ep

POST 
/v1/freight/accessorial/manual/rate/create

Create Manual Accessorial Rate

Creates a new rate schedule for an existing manual accessorial. This allows you to set future rate changes or add a new rate to the accessorial's rate history. Rate changes can be scheduled to take effect on a specific date.

Required Scopes (if.w)

Request

accessorial_id: str
Internal identifier of the manual accessorial to add a rate to.

---

effective_from_date: datetime
The date when this rate becomes effective. Will be truncated to the start of day.

---

rate: float
The rate value to apply. Will be rounded to 5 decimal places.

---

effective_to_date: datetime | None = None
This parameter is accepted but not used for manual accessorials. Manual accessorial rates do not have expiration dates.

Response

Returns the updated manual accessorial object with all fields as described in the Manual Accessorial Overview endpoint, including:

id: str
Internal identifier for the accessorial.

---

name: str
Name of the accessorial.

---

rate: float | None = None
The current active rate for this accessorial.

---

next_scheduled_rate: AccessorialRate | None = None
The next scheduled rate change, if any.

---

rates: list[AccessorialRate] = []
Complete history of rates including the newly added rate, with their effective dates.

---

All other fields as documented in the Manual Accessorial Overview response.

Responses

200

Successful Response

422

Validation Error

application/json

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...