shipengine-json-schema

{ "$id": "get_carrier_by_id_response_body", "title": "get_carrier_by_id_response_body", "type": "object", "additionalProperties": false, "allOf": [ { "title": "carrier", "type": "object", "additionalProperties": false, "properties": { "carrier_id": { "allOf": [ { "title": "se_id", "type": "string", "minLength": 1, "maxLength": 25, "pattern": "^se(-[a-z0-9]+)+$" } ] }, "carrier_code": { "allOf": [ { "title": "se_id", "type": "string", "minLength": 1, "maxLength": 25, "pattern": "^se(-[a-z0-9]+)+$" } ] }, "account_number": { "type": "string", "minLength": 1 }, "requires_funded_amount": { "type": "boolean" }, "balance": { "type": "number", "format": "double", "minimum": 0 }, "nickname": { "type": "string", "minLength": 1 }, "friendly_name": { "type": "string", "minLength": 1 }, "primary": { "type": "boolean" }, "has_multi_package_supporting_services": { "type": "boolean" }, "supports_label_messages": { "type": "boolean" }, "services": { "type": "array", "items": { "allOf": [ { "title": "service", "type": "object", "additionalProperties": false, "properties": { "carrier_id": { "allOf": [ { "title": "se_id", "type": "string", "minLength": 1, "maxLength": 25, "pattern": "^se(-[a-z0-9]+)+$" } ] }, "carrier_code": { "allOf": [ { "title": "se_id", "type": "string", "minLength": 1, "maxLength": 25, "pattern": "^se(-[a-z0-9]+)+$" } ] }, "service_code": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "domestic": { "type": "boolean" }, "international": { "type": "boolean" }, "is_multi_package_supported": { "type": "boolean" } } } ] } }, "packages": { "type": "array", "items": { "allOf": [ { "title": "package_type", "type": "object", "required": [ "name", "package_code" ], "additionalProperties": false, "properties": { "package_id": { "allOf": [ { "title": "se_id", "type": "string", "minLength": 1, "maxLength": 25, "pattern": "^se(-[a-z0-9]+)+$" } ] }, "package_code": { "allOf": [ { "title": "package_code", "type": "string", "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$" } ] }, "name": { "type": "string", "minLength": 1 }, "dimensions": { "allOf": [ { "title": "dimensions", "type": "object", "required": [ "unit", "length", "width", "height" ], "additionalProperties": false, "properties": { "unit": { "default": "inch", "allOf": [ { "title": "dimension_unit", "type": "string", "enum": [ "inch", "centimeter" ] } ] }, "length": { "type": "number", "format": "double", "minimum": 0, "default": 0 }, "width": { "type": "number", "format": "double", "minimum": 0, "default": 0 }, "height": { "type": "number", "format": "double", "minimum": 0, "default": 0 } } } ] } } } ] } }, "options": { "type": "array", "items": { "allOf": [ { "title": "carrier_advanced_option", "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1 }, "default_value": { "type": "string", "minLength": 1 } } } ] } } } } ] }