BigCommerce · Schema
Rate Quote Object
A quote being returned as part of the rate request.
E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS
Properties
| Name | Type | Description |
|---|---|---|
| code | string | A code describing the service. |
| display_name | string | A display name for the service. |
| cost | object | Value object for a money amount. |
| messages | array | |
| description | string | |
| rate_id | string | |
| discounted_cost | object | Value object for a money amount. Optional field; merchants may request features. |
| dispatch_date | string | Date at which carrier dispatches to the shipping destination. Optional field; merchants may request features. |
| transit_time | object | Value object for the length of time in transit. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/RateQuoteObject",
"title": "Rate Quote Object",
"type": "object",
"properties": {
"code": {
"description": "A code describing the service.",
"type": "string",
"maxLength": 50,
"example": "GND"
},
"display_name": {
"description": "A display name for the service.",
"type": "string",
"maxLength": 100
},
"cost": {
"description": "Value object for a money amount.",
"type": "object",
"properties": {
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"amount": {
"type": "number",
"minimum": 0
}
},
"required": [
"currency",
"amount"
],
"title": "Money Value"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"type": {
"type": "string",
"enum": [
"INFO",
"WARNING",
"ERROR"
]
}
},
"required": [
"text",
"type"
],
"title": "Message",
"description": "A simple string/type response for returning information."
}
},
"description": {
"type": "string",
"maxLength": 500
},
"rate_id": {
"type": "string",
"maxLength": 50
},
"discounted_cost": {
"description": "Value object for a money amount. Optional field; merchants may request features.",
"type": "object",
"properties": {
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"amount": {
"type": "number",
"minimum": 0
}
},
"required": [
"currency",
"amount"
],
"title": "Money Value"
},
"dispatch_date": {
"type": "string",
"format": "date",
"description": "Date at which carrier dispatches to the shipping destination. Optional field; merchants may request features."
},
"transit_time": {
"type": "object",
"properties": {
"units": {
"type": "string",
"enum": [
"BUSINESS_DAYS",
"DAYS",
"HOURS"
]
},
"duration": {
"type": "integer",
"minimum": 1,
"maximum": 90
}
},
"title": "Transit Time Object",
"description": "Value object for the length of time in transit."
}
},
"required": [
"code",
"display_name",
"cost"
],
"description": "A quote being returned as part of the rate request.",
"x-internal": false
}