shipengine-json-schema

{ "$id": "get_rate_by_id_response_body", "title": "get_rate_by_id_response_body", "type": "object", "required": [ "rates", "invalid_rates", "rate_request_id", "shipment_id", "created_at", "status", "errors" ], "additionalProperties": false, "allOf": [ { "title": "rate", "type": "object", "required": [ "rate_id", "rate_type", "carrier_id", "shipping_amount", "insurance_amount", "confirmation_amount", "other_amount", "zone", "package_type", "guaranteed_service", "negotiated_rate", "service_type", "service_code", "trackable", "carrier_code", "carrier_nickname", "carrier_friendly_name", "validation_status", "warning_messages", "error_messages" ], "additionalProperties": false, "properties": { "rate_id": { "allOf": [ { "title": "se_id", "type": "string", "minLength": 1, "maxLength": 25, "pattern": "^se(-[a-z0-9]+)+$" } ] }, "rate_type": { "allOf": [ { "title": "rate_type", "type": "string", "enum": [ "check", "shipment" ] } ] }, "carrier_id": { "allOf": [ { "title": "se_id", "type": "string", "minLength": 1, "maxLength": 25, "pattern": "^se(-[a-z0-9]+)+$" } ] }, "shipping_amount": { "allOf": [ { "title": "monetary_value", "type": "object", "required": [ "currency", "amount" ], "additionalProperties": false, "properties": { "currency": { "allOf": [ { "title": "currency", "type": "string", "enum": [ "usd", "cad", "aud", "gbp", "eur", "nzd" ] } ] }, "amount": { "type": "number", "format": "double", "minimum": 0 } } } ] }, "insurance_amount": { "allOf": [ { "title": "monetary_value", "type": "object", "required": [ "currency", "amount" ], "additionalProperties": false, "properties": { "currency": { "allOf": [ { "title": "currency", "type": "string", "enum": [ "usd", "cad", "aud", "gbp", "eur", "nzd" ] } ] }, "amount": { "type": "number", "format": "double", "minimum": 0 } } } ] }, "confirmation_amount": { "allOf": [ { "title": "monetary_value", "type": "object", "required": [ "currency", "amount" ], "additionalProperties": false, "properties": { "currency": { "allOf": [ { "title": "currency", "type": "string", "enum": [ "usd", "cad", "aud", "gbp", "eur", "nzd" ] } ] }, "amount": { "type": "number", "format": "double", "minimum": 0 } } } ] }, "other_amount": { "allOf": [ { "title": "monetary_value", "type": "object", "required": [ "currency", "amount" ], "additionalProperties": false, "properties": { "currency": { "allOf": [ { "title": "currency", "type": "string", "enum": [ "usd", "cad", "aud", "gbp", "eur", "nzd" ] } ] }, "amount": { "type": "number", "format": "double", "minimum": 0 } } } ] }, "tax_amount": { "allOf": [ { "title": "monetary_value", "type": "object", "required": [ "currency", "amount" ], "additionalProperties": false, "properties": { "currency": { "allOf": [ { "title": "currency", "type": "string", "enum": [ "usd", "cad", "aud", "gbp", "eur", "nzd" ] } ] }, "amount": { "type": "number", "format": "double", "minimum": 0 } } } ] }, "zone": { "type": "integer", "format": "int32", "minimum": 0 }, "package_type": { "type": "string", "minLength": 1 }, "delivery_days": { "type": "integer", "format": "int32", "minimum": 1 }, "guaranteed_service": { "type": "boolean" }, "estimated_delivery_date": { "allOf": [ { "title": "date", "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$" } ] }, "carrier_delivery_days": { "type": "string", "minLength": 1 }, "ship_date": { "type": "string", "format": "date-time", "minLength": 1 }, "negotiated_rate": { "type": "boolean" }, "service_type": { "type": "string", "minLength": 1 }, "service_code": { "type": "string", "minLength": 1 }, "trackable": { "type": "boolean" }, "carrier_code": { "type": "string", "minLength": 1 }, "carrier_nickname": { "type": "string", "minLength": 1 }, "carrier_friendly_name": { "type": "string", "minLength": 1 }, "validation_status": { "allOf": [ { "title": "validation_status", "type": "string", "enum": [ "valid", "invalid", "has_warnings", "unknown" ] } ] }, "warning_messages": { "type": "array", "minItems": 0, "items": { "type": "string", "minLength": 0 } }, "error_messages": { "type": "array", "minItems": 0, "items": { "type": "string", "minLength": 0 } } } } ] }