Shipment is a JSON Structure definition published by Otter, describing 4 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-structure/public-api-shipment-structure.json",
"name": "Shipment",
"description": "Shipment schema from Public API (Otter Public API).",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A UUID for the shipment.",
"example": "18695c43-c670-4c57-a714-e0d7b215db20"
},
"deliveryInfo": {
"$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-shipment-delivery-info-schema.json"
},
"lineItems": {
"type": "array",
"description": "A list of the shipment line items.",
"items": {
"$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-shipment-line-item-schema.json"
}
},
"stateChanges": {
"type": "array",
"minItems": 1,
"description": "The state changes for the shipment. The final state change represents the current state of the shipment.",
"items": {
"$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-shipment-state-change-schema.json"
}
}
},
"required": [
"id",
"deliveryInfo",
"lineItems",
"stateChanges"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.