Raw schema
{
"type": "object",
"properties": {
"to_address": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"type": "string",
"description": "Street address line 1"
},
"street2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"description": "2-letter state/province code",
"type": "string"
},
"zip": {
"type": "string",
"description": "Postal/ZIP code"
},
"country": {
"description": "2-letter ISO country code, default US",
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string"
}
},
"required": [
"street1",
"zip"
],
"description": "Destination address."
},
"from_address": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"type": "string",
"description": "Street address line 1"
},
"street2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"description": "2-letter state/province code",
"type": "string"
},
"zip": {
"type": "string",
"description": "Postal/ZIP code"
},
"country": {
"description": "2-letter ISO country code, default US",
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string"
}
},
"required": [
"street1",
"zip"
],
"description": "Origin/return address."
},
"parcel": {
"type": "object",
"properties": {
"length": {
"description": "inches",
"type": "number"
},
"width": {
"description": "inches",
"type": "number"
},
"height": {
"description": "inches",
"type": "number"
},
"weight": {
"type": "number",
"description": "weight in OUNCES (required)"
},
"predefined_package": {
"description": "carrier predefined package name, e.g. FlatRateEnvelope",
"type": "string"
}
},
"required": [
"weight"
],
"description": "Package dimensions and weight."
},
"reference": {
"description": "Your internal reference string for the shipment.",
"type": "string"
},
"carrier_accounts": {
"description": "Restrict rating to these carrier_account ids.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"to_address",
"from_address",
"parcel"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}