{"openapi":"3.1.0","info":{"title":"QuoAPI – Shipping API","version":"1.3.0","description":"Canonical QuoAPI public API contract. Provider details and internal routes are intentionally excluded."},"servers":[{"url":"https://api.quoapi.com"}],"tags":[{"name":"shipping-api","description":"Compare shipping rates, create labels, track parcels, schedule pickups and manage insurance through one model."}],"paths":{"/v1/shipping/rates":{"post":{"operationId":"shipping_rates","summary":"Shipping rates","description":"Get normalized shipping rate options.","tags":["shipping-api"],"security":[{"BearerAuth":["shipping.rates"]}],"x-quoapi-capability":"shipping.rates","x-quoapi-contract-version":"1.3.0:shipping.rates","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"from_country":{"type":"string","x-quoapi-widget":"country","title":"From Country","default":"DE","x-quoapi-format":"iso-3166-1-alpha-2"},"to_country":{"type":"string","x-quoapi-widget":"country","title":"To Country","default":"PL","x-quoapi-format":"iso-3166-1-alpha-2"},"weight_kg":{"type":"number","x-quoapi-widget":"number","title":"Weight Kg","default":"1.2"},"origin":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"city":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country"}},"additionalProperties":false,"x-quoapi-widget":"address","title":"Origin address","default":{"country":"DE","city":"Berlin"}},"destination":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"city":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country"}},"additionalProperties":false,"x-quoapi-widget":"address","title":"Destination address","default":{"country":"PL","city":"Warsaw"}},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["from_country","to_country","weight_kg"]},"example":{"from_country":"DE","to_country":"PL","weight_kg":"1.2","origin":{"country":"DE","city":"Berlin"},"destination":{"country":"PL","city":"Warsaw"}}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/shipping/label/create":{"post":{"operationId":"shipping_label_create","summary":"Create shipping label","description":"Purchase or create a label in supported environments.","tags":["shipping-api"],"security":[{"BearerAuth":["shipping.label.create"]}],"x-quoapi-capability":"shipping.label.create","x-quoapi-contract-version":"1.3.0:shipping.label.create","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rate_id":{"type":"string","x-quoapi-widget":"text","title":"Rate Id","default":"rate_demo_standard"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["rate_id"]},"example":{"rate_id":"rate_demo_standard"}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/shipping/track":{"post":{"operationId":"shipping_track","summary":"Track shipment","description":"Track a shipment.","tags":["shipping-api"],"security":[{"BearerAuth":["shipping.track"]}],"x-quoapi-capability":"shipping.track","x-quoapi-contract-version":"1.3.0:shipping.track","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tracking_code":{"type":"string","x-quoapi-widget":"text","title":"Tracking Code","default":"DEMO123"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["tracking_code"]},"example":{"tracking_code":"DEMO123"}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/shipping/address/verify":{"post":{"operationId":"shipping_address_verify","summary":"Verify shipping address","description":"Validate shipping suitability.","tags":["shipping-api"],"security":[{"BearerAuth":["shipping.address.verify"]}],"x-quoapi-capability":"shipping.address.verify","x-quoapi-contract-version":"1.3.0:shipping.address.verify","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"line1":{"type":"string","x-quoapi-widget":"text","title":"Line1","default":"Unter den Linden 1"},"city":{"type":"string","x-quoapi-widget":"text","title":"City","default":"Berlin"},"country":{"type":"string","x-quoapi-widget":"country","title":"Country","default":"DE","x-quoapi-format":"iso-3166-1-alpha-2"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["line1","city","country"]},"example":{"line1":"Unter den Linden 1","city":"Berlin","country":"DE"}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/shipping/pickup":{"post":{"operationId":"shipping_pickup","summary":"Schedule pickup","description":"Schedule a carrier pickup.","tags":["shipping-api"],"security":[{"BearerAuth":["shipping.pickup"]}],"x-quoapi-capability":"shipping.pickup","x-quoapi-contract-version":"1.3.0:shipping.pickup","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shipment_id":{"type":"string","x-quoapi-widget":"text","title":"Shipment Id","default":"shp_demo_001"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["shipment_id"]},"example":{"shipment_id":"shp_demo_001"}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/shipping/insurance":{"post":{"operationId":"shipping_insurance","summary":"Insure shipment","description":"Add shipment insurance.","tags":["shipping-api"],"security":[{"BearerAuth":["shipping.insurance"]}],"x-quoapi-capability":"shipping.insurance","x-quoapi-contract-version":"1.3.0:shipping.insurance","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shipment_id":{"type":"string","x-quoapi-widget":"text","title":"Shipment Id","default":"shp_demo_001"},"amount":{"type":"number","x-quoapi-widget":"number","title":"Amount","default":"100"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["shipment_id","amount"]},"example":{"shipment_id":"shp_demo_001","amount":"100"}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"QuoAPI API key"}},"schemas":{"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","additionalProperties":true}}}}}}}}