{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aftership/main/json-schema/aftership-rate-record-v3-schema.json",
  "title": "RateRecord",
  "description": "RateRecord object: the description of rates information",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aftership-rates-api-openapi.yml#/components/schemas/Rate_record.v3",
  "x-stoplight": {
    "id": "a0hnwegyy5k4z"
  },
  "type": "object",
  "x-tags": [
    "Resource"
  ],
  "properties": {
    "created_at": {
      "type": "string",
      "description": "the timestamp of created_at, example: 2022-05-18T09:17:38+00:00"
    },
    "id": {
      "type": "string",
      "description": "rate id"
    },
    "updated_at": {
      "type": "string",
      "description": "the timestamp of updated_at, example: 2022-05-18T09:17:38+00:00"
    },
    "status": {
      "type": "string",
      "enum": [
        "calculating",
        "calculated",
        "failed"
      ]
    },
    "rates": {
      "type": "array",
      "description": "rates array",
      "items": {
        "$ref": "#/$defs/Rate.v3"
      }
    }
  },
  "$defs": {
    "Money.v3": {
      "title": "Money",
      "x-stoplight": {
        "id": "okc04k6a0ua3b"
      },
      "type": "object",
      "x-tags": [
        "Primitive"
      ],
      "properties": {
        "currency": {
          "type": "string",
          "enum": [
            "AED",
            "AFN",
            "ALL",
            "AMD",
            "ANG",
            "AOA",
            "ARS",
            "AUD",
            "AWG",
            "AZN",
            "BAM",
            "BBD",
            "BDT",
            "BGN",
            "BHD",
            "BIF",
            "BMD",
            "BND",
            "BOB",
            "BOV",
            "BRL",
            "BSD",
            "BTN",
            "BWP",
            "BYN",
            "BZD",
            "CAD",
            "CDF",
            "CHE",
            "CHF",
            "CHW",
            "CLF",
            "CLP",
            "CNY",
            "COP",
            "COU",
            "CRC",
            "CUC",
            "CUP",
            "CVE",
            "CZK",
            "DJF",
            "DKK",
            "DOP",
            "DZD",
            "EGP",
            "ERN",
            "ETB",
            "EUR",
            "FJD",
            "FKP",
            "GBP",
            "GEL",
            "GHS",
            "GIP",
            "GMD",
            "GNF",
            "GTQ",
            "GYD",
            "HKD",
            "HNL",
            "HRK",
            "HTG",
            "HUF",
            "IDR",
            "ILS",
            "INR",
            "IQD",
            "IRR",
            "ISK",
            "JMD",
            "JOD",
            "JPY",
            "KES",
            "KGS",
            "KHR",
            "KMF",
            "KPW",
            "KRW",
            "KWD",
            "KYD",
            "KZT",
            "LAK",
            "LBP",
            "LKR",
            "LRD",
            "LSL",
            "LYD",
            "MAD",
            "MDL",
            "MGA",
            "MKD",
            "MMK",
            "MNT",
            "MOP",
            "MRU",
            "MUR",
            "MVR",
            "MWK",
            "MXN",
            "MXV",
            "MYR",
            "MZN",
            "NAD",
            "NGN",
            "NIO",
            "NOK",
            "NPR",
            "NZD",
            "OMR",
            "PAB",
            "PEN",
            "PGK",
            "PHP",
            "PKR",
            "PLN",
            "PYG",
            "QAR",
            "RON",
            "RSD",
            "RUB",
            "RWF",
            "SAR",
            "SBD",
            "SCR",
            "SDG",
            "SEK",
            "SGD",
            "SHP",
            "SLL",
            "SOS",
            "SRD",
            "SSP",
            "STN",
            "SVC",
            "SYP",
            "SZL",
            "THB",
            "TJS",
            "TMT",
            "TND",
            "TOP",
            "TRY",
            "TTD",
            "TWD",
            "TZS",
            "UAH",
            "UGX",
            "USD",
            "USN",
            "UYI",
            "UYW",
            "UYU",
            "UZS",
            "VES",
            "VND",
            "VUV",
            "WST",
            "XAF",
            "XAU",
            "XBA",
            "XBB",
            "XBC",
            "XBD",
            "XCD",
            "XDR",
            "XOF",
            "XPD",
            "XPF",
            "XPT",
            "XSU",
            "XTS",
            "XXX",
            "YER",
            "ZAR",
            "ZMW",
            "ZWL"
          ],
          "description": "Currency of Money"
        },
        "amount": {
          "type": "number",
          "description": "Amount of Money"
        }
      },
      "description": "The money object is used to represent the currency amount."
    },
    "Rate.v3": {
      "title": "Rate",
      "x-stoplight": {
        "id": "gzq8uf274umrg"
      },
      "type": "object",
      "description": "Rate object: the description of rate information",
      "x-tags": [
        "Resource"
      ],
      "properties": {
        "charge_weight": {
          "$ref": "#/$defs/Weight.v3"
        },
        "total_charge": {
          "$ref": "#/$defs/Money.v3"
        },
        "shipper_account": {
          "type": "object",
          "description": "Shipper Account (brief information for rate and manifest responses)\n",
          "required": [
            "id",
            "slug"
          ],
          "properties": {
            "id": {
              "type": "string"
            },
            "slug": {
              "type": "string"
            },
            "description": {
              "type": "string"
            }
          }
        },
        "service_type": {
          "type": "string",
          "description": "Service Types\n"
        },
        "service_name": {
          "type": "string",
          "description": "name of service\n"
        },
        "pickup_deadline": {
          "type": [
            "string",
            "null"
          ],
          "description": "A formatted date.\n"
        },
        "booking_cut_off": {
          "type": [
            "string",
            "null"
          ],
          "description": "A formatted date.\n"
        },
        "delivery_date": {
          "type": [
            "string",
            "null"
          ],
          "description": "A formatted date.\n"
        },
        "transit_time": {
          "type": [
            "integer",
            "null"
          ],
          "description": "transit time"
        },
        "detailed_charges": {
          "type": "array",
          "description": "Courier charges, it may be different for different couriers",
          "items": {
            "type": [
              "object",
              "array"
            ],
            "properties": {
              "type": {
                "type": "string",
                "description": "detailed charges type"
              },
              "charge": {
                "$ref": "#/$defs/Money.v3"
              }
            }
          }
        },
        "error_message": {
          "type": [
            "string",
            "null"
          ],
          "description": "error information"
        },
        "info_message": {
          "type": [
            "string",
            "null"
          ],
          "description": "other information of request/response"
        }
      },
      "required": [
        "shipper_account",
        "service_type",
        "service_name"
      ]
    },
    "Weight.v3": {
      "title": "Weight",
      "x-stoplight": {
        "id": "sqe056qqggctt"
      },
      "type": "object",
      "description": "Weight object: unit weight of the item",
      "x-tags": [
        "Primitive"
      ],
      "properties": {
        "unit": {
          "type": "string",
          "description": "weight unit",
          "enum": [
            "lb",
            "kg",
            "oz",
            "g"
          ]
        },
        "value": {
          "type": "number",
          "description": "value of Weight"
        }
      },
      "required": [
        "unit",
        "value"
      ]
    }
  }
}