{"openapi":"3.1.0","info":{"title":"AixTrack Public API v1","version":"1.0.0"},"paths":{"/v1/trackings":{"post":{"tags":["Public API v1"],"summary":"Enroll","description":"Enroll one or up to 100 parcels without a carrier network call. Batch is atomic.","operationId":"enroll_v1_trackings_post","security":[{"DeveloperKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ShipmentCreate"},{"$ref":"#/components/schemas/TrackingBatch"}],"title":"Data"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentRead"},"title":"Response Enroll V1 Trackings Post"}}}},"401":{"description":"invalid_api_key: missing, invalid or revoked developer credential"},"403":{"description":"monthly_shipment_limit: shared plan quota exhausted"},"429":{"description":"api_rate_limit: 60 requests/account/minute; see Retry-After"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Public API v1"],"summary":"Trackings","operationId":"trackings_v1_trackings_get","security":[{"DeveloperKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentRead"},"title":"Response Trackings V1 Trackings Get"}}}},"401":{"description":"invalid_api_key: missing, invalid or revoked developer credential"},"403":{"description":"monthly_shipment_limit: shared plan quota exhausted"},"429":{"description":"api_rate_limit: 60 requests/account/minute; see Retry-After"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/trackings/{tracking_id}":{"get":{"tags":["Public API v1"],"summary":"Tracking","operationId":"tracking_v1_trackings__tracking_id__get","security":[{"DeveloperKey":[]}],"parameters":[{"name":"tracking_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Tracking Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentRead"}}}},"401":{"description":"invalid_api_key: missing, invalid or revoked developer credential"},"403":{"description":"monthly_shipment_limit: shared plan quota exhausted"},"429":{"description":"api_rate_limit: 60 requests/account/minute; see Retry-After"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AnomalyRead":{"properties":{"code":{"type":"string","title":"Code"},"label":{"type":"string","title":"Label"},"reason":{"type":"string","title":"Reason"},"since":{"type":"string","format":"date-time","title":"Since"},"detected_at":{"type":"string","format":"date-time","title":"Detected At"}},"type":"object","required":["code","label","reason","since","detected_at"],"title":"AnomalyRead"},"BindingAudit":{"properties":{"at":{"type":"string","format":"date-time","title":"At"},"action":{"type":"string","title":"Action"},"result_code":{"type":"string","title":"Result Code"},"use_count":{"type":"integer","title":"Use Count"},"actor_type":{"type":"string","title":"Actor Type"}},"type":"object","required":["at","action","result_code","use_count","actor_type"],"title":"BindingAudit"},"BindingCapabilities":{"properties":{"merchant_auth_enabled":{"type":"boolean","title":"Merchant Auth Enabled"},"gls_merchant_prod_allowed":{"type":"boolean","title":"Gls Merchant Prod Allowed"},"carriers":{"items":{"$ref":"#/components/schemas/BindingCarrierCapability"},"type":"array","title":"Carriers"}},"type":"object","required":["merchant_auth_enabled","gls_merchant_prod_allowed","carriers"],"title":"BindingCapabilities"},"BindingCarrierCapability":{"properties":{"carrier":{"type":"string","title":"Carrier"},"enabled":{"type":"boolean","title":"Enabled"},"terms_version":{"type":"string","title":"Terms Version"},"display_scope":{"type":"string","title":"Display Scope"},"retention_days":{"type":"integer","title":"Retention Days"}},"type":"object","required":["carrier","enabled","terms_version","display_scope","retention_days"],"title":"BindingCarrierCapability"},"BindingInput":{"properties":{"fields":{"additionalProperties":{"type":"string","format":"password","writeOnly":true},"type":"object","maxProperties":8,"minProperties":1,"title":"Fields"},"terms_version":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Terms Version"},"label":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Label"},"account_ref":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Account Ref"}},"type":"object","required":["fields"],"title":"BindingInput"},"BindingMetadata":{"properties":{"id":{"type":"string","title":"Id"},"carrier":{"type":"string","title":"Carrier"},"kind":{"type":"string","title":"Kind"},"status":{"type":"string","title":"Status"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"fields":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"additionalProperties":{"type":"string"},"type":"object"}],"title":"Fields"},"masked_hint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Masked Hint"}},"type":"object","required":["id","carrier","kind","status","expires_at","fields","masked_hint"],"title":"BindingMetadata"},"BindingValidation":{"properties":{"id":{"type":"string","title":"Id"},"carrier":{"type":"string","title":"Carrier"},"kind":{"type":"string","title":"Kind"},"status":{"type":"string","title":"Status"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"fields":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"additionalProperties":{"type":"string"},"type":"object"}],"title":"Fields"},"masked_hint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Masked Hint"},"result_code":{"type":"string","title":"Result Code"}},"type":"object","required":["id","carrier","kind","status","expires_at","fields","masked_hint","result_code"],"title":"BindingValidation"},"CarrierDetection":{"properties":{"candidates":{"items":{"$ref":"#/components/schemas/DetectionCandidate"},"type":"array","title":"Candidates"},"attempts":{"items":{"$ref":"#/components/schemas/DetectionAttempt"},"type":"array","title":"Attempts"},"confirmed_carrier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confirmed Carrier"},"skip_reasons":{"items":{"type":"string"},"type":"array","title":"Skip Reasons","default":[]}},"type":"object","required":["candidates","attempts"],"title":"CarrierDetection"},"CarrierNotDetected":{"properties":{"detail":{"$ref":"#/components/schemas/CarrierNotDetectedDetail"}},"type":"object","required":["detail"],"title":"CarrierNotDetected"},"CarrierNotDetectedDetail":{"properties":{"code":{"type":"string","const":"carrier_not_detected","title":"Code","default":"carrier_not_detected"},"retryable":{"type":"boolean","title":"Retryable","default":false},"detection":{"$ref":"#/components/schemas/CarrierDetection"}},"type":"object","required":["detection"],"title":"CarrierNotDetectedDetail"},"CarrierRead":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"code":{"type":"string","title":"Code"},"name":{"type":"string","title":"Name"},"is_active":{"type":"boolean","title":"Is Active"}},"type":"object","required":["id","code","name","is_active"],"title":"CarrierRead"},"CheckoutRequest":{"properties":{"plan":{"type":"string","enum":["starter","growth","scale"],"title":"Plan"}},"type":"object","required":["plan"],"title":"CheckoutRequest"},"Credentials":{"properties":{"email":{"type":"string","maxLength":320,"minLength":3,"pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$","title":"Email"},"password":{"type":"string","maxLength":128,"minLength":12,"format":"password","title":"Password","writeOnly":true}},"type":"object","required":["email","password"],"title":"Credentials"},"DetectionAttempt":{"properties":{"carrier":{"type":"string","title":"Carrier"},"outcome":{"type":"string","enum":["hit","not_found","skipped","error"],"title":"Outcome"},"reason":{"type":"string","title":"Reason"}},"type":"object","required":["carrier","outcome","reason"],"title":"DetectionAttempt"},"DetectionCandidate":{"properties":{"carrier":{"type":"string","title":"Carrier"},"confidence":{"type":"number","title":"Confidence"},"rule_id":{"type":"string","title":"Rule Id"},"check_digit":{"type":"string","enum":["valid","invalid","n/a"],"title":"Check Digit"}},"type":"object","required":["carrier","confidence","rule_id","check_digit"],"title":"DetectionCandidate"},"EmailRequest":{"properties":{"email":{"type":"string","maxLength":320,"minLength":3,"pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$","title":"Email"}},"type":"object","required":["email"],"title":"EmailRequest"},"EndpointInput":{"properties":{"url":{"type":"string","maxLength":2048,"title":"Url"}},"type":"object","required":["url"],"title":"EndpointInput"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"KeyName":{"properties":{"name":{"type":"string","maxLength":80,"minLength":1,"pattern":".*\\S.*","title":"Name"}},"type":"object","required":["name"],"title":"KeyName"},"NotificationCreate":{"properties":{"shipment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Shipment Id"},"channel":{"type":"string","maxLength":32,"minLength":1,"title":"Channel"},"payload":{"additionalProperties":true,"type":"object","title":"Payload"}},"type":"object","required":["channel","payload"],"title":"NotificationCreate"},"NotificationRead":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"channel":{"type":"string","title":"Channel"},"status":{"type":"string","title":"Status"},"payload":{"additionalProperties":true,"type":"object","title":"Payload"}},"type":"object","required":["id","channel","status","payload"],"title":"NotificationRead"},"OAuthCallback":{"properties":{"state":{"type":"string","format":"password","title":"State","writeOnly":true},"code":{"type":"string","format":"password","title":"Code","writeOnly":true}},"type":"object","required":["state","code"],"title":"OAuthCallback"},"PreferencesInput":{"properties":{"email":{"type":"boolean","title":"Email","default":true},"webhook":{"type":"boolean","title":"Webhook","default":true}},"type":"object","title":"PreferencesInput"},"ProfileUpdate":{"properties":{"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone"}},"type":"object","title":"ProfileUpdate"},"ProviderSelection":{"properties":{"provider_name":{"type":"string","title":"Provider Name"},"is_fallback":{"type":"boolean","title":"Is Fallback"}},"type":"object","required":["provider_name","is_fallback"],"title":"ProviderSelection"},"ResetPassword":{"properties":{"token":{"type":"string","maxLength":256,"minLength":32,"format":"password","title":"Token","writeOnly":true},"password":{"type":"string","maxLength":128,"minLength":12,"format":"password","title":"Password","writeOnly":true}},"type":"object","required":["token","password"],"title":"ResetPassword"},"RotationInput":{"properties":{"grace_seconds":{"type":"integer","maximum":86400.0,"minimum":60.0,"title":"Grace Seconds","default":3600}},"type":"object","title":"RotationInput"},"ShipmentCreate":{"properties":{"tracking_number":{"type":"string","maxLength":128,"minLength":3,"title":"Tracking Number"},"carrier_code":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Carrier Code"},"destination_country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}],"title":"Destination Country"}},"type":"object","required":["tracking_number"],"title":"ShipmentCreate"},"ShipmentCreated":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"tracking_number":{"type":"string","title":"Tracking Number"},"status":{"$ref":"#/components/schemas/ShipmentStatus"},"provider_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Name"},"carrier_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Carrier Code"},"destination_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Destination Country"},"delivered_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Delivered At"},"carrier_data_purged_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Carrier Data Purged At"},"carrier_data_purge_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Carrier Data Purge Reason"},"events":{"items":{"$ref":"#/components/schemas/TrackingEventRead"},"type":"array","title":"Events","default":[]},"detection":{"anyOf":[{"$ref":"#/components/schemas/CarrierDetection"},{"type":"null"}]}},"type":"object","required":["id","tracking_number","status","provider_name"],"title":"ShipmentCreated"},"ShipmentRead":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"tracking_number":{"type":"string","title":"Tracking Number"},"status":{"$ref":"#/components/schemas/ShipmentStatus"},"provider_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Name"},"carrier_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Carrier Code"},"destination_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Destination Country"},"delivered_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Delivered At"},"carrier_data_purged_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Carrier Data Purged At"},"carrier_data_purge_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Carrier Data Purge Reason"},"events":{"items":{"$ref":"#/components/schemas/TrackingEventRead"},"type":"array","title":"Events","default":[]}},"type":"object","required":["id","tracking_number","status","provider_name"],"title":"ShipmentRead"},"ShipmentStatus":{"type":"string","enum":["unknown","info_received","in_transit","out_for_delivery","delivered","exception","returned","available_for_pickup"],"title":"ShipmentStatus"},"StaleSettings":{"properties":{"stale_days":{"type":"integer","maximum":365.0,"minimum":1.0,"title":"Stale Days","default":7}},"type":"object","title":"StaleSettings"},"TokenRequest":{"properties":{"token":{"type":"string","maxLength":256,"minLength":32,"format":"password","title":"Token","writeOnly":true}},"type":"object","required":["token"],"title":"TokenRequest"},"TrackingBatch":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ShipmentCreate"},"type":"array","maxItems":100,"minItems":1,"title":"Items"}},"type":"object","required":["items"],"title":"TrackingBatch"},"TrackingEventRead":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"status":{"$ref":"#/components/schemas/ShipmentStatus"},"description":{"type":"string","title":"Description"},"occurred_at":{"type":"string","format":"date-time","title":"Occurred At"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code"},"is_last_mile":{"type":"boolean","title":"Is Last Mile","default":false}},"type":"object","required":["id","status","description","occurred_at"],"title":"TrackingEventRead"},"UserRead":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"email":{"type":"string","title":"Email"},"is_admin":{"type":"boolean","title":"Is Admin"},"email_verified":{"type":"boolean","title":"Email Verified"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone"}},"type":"object","required":["id","email","is_admin","email_verified"],"title":"UserRead"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"},"DeveloperKey":{"type":"http","scheme":"bearer"}}}}