{"components":{"parameters":{"Cursor":{"in":"query","name":"cursor","schema":{"minLength":1,"type":"string"}},"IdempotencyKey":{"in":"header","name":"Idempotency-Key","required":true,"schema":{"format":"uuid","type":"string"}},"LabelId":{"in":"path","name":"label_id","required":true,"schema":{"pattern":"^lbl_[a-z0-9]{20}$","type":"string"}},"Limit":{"in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},"PickupId":{"in":"path","name":"pickup_id","required":true,"schema":{"pattern":"^pku_[a-z0-9]{20}$","type":"string"}},"ShipmentId":{"in":"path","name":"shipment_id","required":true,"schema":{"pattern":"^shp_[a-z0-9]{20}$","type":"string"}},"WebhookEndpointId":{"in":"path","name":"endpoint_id","required":true,"schema":{"pattern":"^whe_[a-z0-9]{20}$","type":"string"}}},"responses":{"BadRequest":{"content":{"application/problem+json":{"example":{"request_id":"req_00000000000000000001","status":400,"title":"Synthetic request is invalid","type":"https://parcel-events.example/problems/bad-request"},"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Request syntax or parameters are invalid"},"Conflict":{"content":{"application/problem+json":{"example":{"request_id":"req_00000000000000000005","status":409,"title":"Synthetic resource state conflicts","type":"https://parcel-events.example/problems/conflict"},"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Current resource state prevents the operation"},"NotFound":{"content":{"application/problem+json":{"example":{"request_id":"req_00000000000000000004","status":404,"title":"Synthetic resource was not found","type":"https://parcel-events.example/problems/not-found"},"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"The requested synthetic resource does not exist"},"PaymentRequired":{"content":{"application/problem+json":{"example":{"request_id":"req_00000000000000000003","status":402,"title":"Synthetic balance is insufficient","type":"https://parcel-events.example/problems/payment-required"},"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"The synthetic account cannot purchase this label"},"Unauthorized":{"content":{"application/problem+json":{"example":{"request_id":"req_00000000000000000002","status":401,"title":"Synthetic credential was rejected","type":"https://parcel-events.example/problems/unauthorized"},"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Authentication is missing or invalid"},"ValidationFailed":{"content":{"application/problem+json":{"example":{"errors":[{"message":"must be a synthetic postal code","path":"recipient.postal_code"}],"request_id":"req_00000000000000000006","status":422,"title":"Synthetic request validation failed","type":"https://parcel-events.example/problems/validation"},"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"One or more fields failed semantic validation"}},"schemas":{"Address":{"additionalProperties":false,"properties":{"city":{"example":"Exampleton","type":"string"},"company":{"example":"Northstar Supplies","type":["null","string"]},"country":{"example":"ZZ","pattern":"^[A-Z]{2}$","type":"string"},"line1":{"example":"14 Fictional Quay","type":"string"},"line2":{"example":"Unit 7","type":["null","string"]},"name":{"example":"Rowan Example","minLength":1,"type":"string"},"phone":{"example":"+00000000000","type":["null","string"]},"postal_code":{"example":"EX4 2PL","type":"string"},"region":{"example":"Test Province","type":["null","string"]}},"required":["city","country","line1","name","postal_code"],"type":"object"},"CreateLabelRequest":{"additionalProperties":false,"properties":{"format":{"$ref":"#/components/schemas/LabelFormat"},"page_size":{"default":"four_by_six","enum":["a4","letter","four_by_six"],"type":"string"},"shipment_id":{"example":"shp_00000000000000000001","type":"string"}},"required":["format","shipment_id"],"type":"object"},"CreatePickupRequest":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"notes":{"maxLength":500,"type":["null","string"]},"shipment_ids":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"window":{"$ref":"#/components/schemas/PickupWindow"}},"required":["address","shipment_ids","window"],"type":"object"},"CreateShipmentRequest":{"additionalProperties":false,"properties":{"delivery_instructions":{"example":"Leave with the synthetic reception desk","maxLength":500,"type":["null","string"]},"metadata":{"additionalProperties":{"type":"string"},"maxProperties":20,"type":"object"},"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"maxItems":20,"minItems":1,"type":"array"},"recipient":{"$ref":"#/components/schemas/Address"},"reference":{"example":"synthetic-order-1042","maxLength":80,"type":"string"},"sender":{"$ref":"#/components/schemas/Address"},"service":{"enum":["economy","express","same_day"],"type":"string"}},"required":["parcels","recipient","reference","sender","service"],"type":"object"},"CreateWebhookEndpointRequest":{"additionalProperties":false,"properties":{"description":{"maxLength":120,"type":["null","string"]},"events":{"items":{"$ref":"#/components/schemas/WebhookEventType"},"minItems":1,"type":"array","uniqueItems":true},"url":{"example":"https://hooks.parcel-events.example/events","format":"uri","type":"string"}},"required":["events","url"],"type":"object"},"Label":{"additionalProperties":false,"properties":{"download_url":{"example":"https://downloads.parcel-events.example/labels/synthetic-label.pdf","format":"uri","type":"string"},"expires_at":{"format":"date-time","type":"string"},"format":{"$ref":"#/components/schemas/LabelFormat"},"id":{"example":"lbl_00000000000000000001","type":"string"},"object":{"const":"label"},"price":{"$ref":"#/components/schemas/Money"},"shipment_id":{"example":"shp_00000000000000000001","type":"string"}},"required":["download_url","expires_at","format","id","object","price","shipment_id"],"type":"object"},"LabelFormat":{"enum":["pdf","png","zpl"],"type":"string"},"Money":{"additionalProperties":false,"properties":{"amount":{"example":"12.50","pattern":"^[0-9]+(\\.[0-9]{2})$","type":"string"},"currency":{"example":"XTS","pattern":"^[A-Z]{3}$","type":"string"}},"required":["amount","currency"],"type":"object"},"Parcel":{"additionalProperties":false,"properties":{"contents":{"items":{"$ref":"#/components/schemas/ParcelItem"},"maxItems":50,"type":"array"},"height_cm":{"example":12,"exclusiveMinimum":0,"type":"number"},"length_cm":{"example":30.5,"exclusiveMinimum":0,"type":"number"},"weight_grams":{"example":1750,"minimum":1,"type":"integer"},"width_cm":{"example":20,"exclusiveMinimum":0,"type":"number"}},"required":["height_cm","length_cm","weight_grams","width_cm"],"type":"object"},"ParcelItem":{"additionalProperties":false,"properties":{"customs_code":{"example":"610910","type":["null","string"]},"description":{"example":"Synthetic cotton shirt","type":"string"},"quantity":{"example":2,"minimum":1,"type":"integer"},"unit_value":{"$ref":"#/components/schemas/Money"}},"required":["description","quantity","unit_value"],"type":"object"},"Pickup":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"created_at":{"format":"date-time","type":"string"},"id":{"example":"pku_00000000000000000001","type":"string"},"object":{"const":"pickup"},"shipment_ids":{"items":{"type":"string"},"type":"array"},"status":{"enum":["scheduled","completed","canceled","missed"],"type":"string"},"window":{"$ref":"#/components/schemas/PickupWindow"}},"required":["address","created_at","id","object","shipment_ids","status","window"],"type":"object"},"PickupPage":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Pickup"},"type":"array"},"has_more":{"type":"boolean"},"next_cursor":{"type":["null","string"]}},"required":["data","has_more","next_cursor"],"type":"object"},"PickupWindow":{"additionalProperties":false,"properties":{"ends_at":{"example":"2026-09-06T12:00:00Z","format":"date-time","type":"string"},"starts_at":{"example":"2026-09-06T09:00:00Z","format":"date-time","type":"string"}},"required":["ends_at","starts_at"],"type":"object"},"Problem":{"additionalProperties":false,"properties":{"detail":{"type":"string"},"errors":{"items":{"additionalProperties":false,"properties":{"message":{"example":"must be a synthetic postal code","type":"string"},"path":{"example":"recipient.postal_code","type":"string"}},"required":["message","path"],"type":"object"},"type":"array"},"request_id":{"example":"req_00000000000000000001","type":"string"},"status":{"maximum":599,"minimum":400,"type":"integer"},"title":{"example":"Synthetic request validation failed","type":"string"},"type":{"example":"https://parcel-events.example/problems/validation","format":"uri","type":"string"}},"required":["request_id","status","title","type"],"type":"object"},"RateQuote":{"additionalProperties":false,"properties":{"amount":{"$ref":"#/components/schemas/Money"},"carrier":{"example":"Example Parcel Network","type":"string"},"estimated_delivery_date":{"example":"2026-09-07","format":"date","type":"string"},"expires_at":{"format":"date-time","type":"string"},"id":{"example":"rate_00000000000000000001","type":"string"},"service":{"example":"synthetic_express","type":"string"}},"required":["amount","carrier","estimated_delivery_date","expires_at","id","service"],"type":"object"},"RateQuoteRequest":{"additionalProperties":false,"properties":{"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"minItems":1,"type":"array"},"recipient":{"$ref":"#/components/schemas/Address"},"sender":{"$ref":"#/components/schemas/Address"}},"required":["parcels","recipient","sender"],"type":"object"},"Shipment":{"additionalProperties":false,"properties":{"created_at":{"example":"2026-09-04T08:15:30Z","format":"date-time","type":"string"},"delivery_instructions":{"type":["null","string"]},"id":{"example":"shp_00000000000000000001","type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"object":{"const":"shipment"},"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"type":"array"},"recipient":{"$ref":"#/components/schemas/Address"},"reference":{"example":"synthetic-order-1042","type":"string"},"sender":{"$ref":"#/components/schemas/Address"},"service":{"enum":["economy","express","same_day"],"type":"string"},"status":{"$ref":"#/components/schemas/ShipmentStatus"},"tracking_number":{"example":"PE-000000000001","type":"string"},"updated_at":{"example":"2026-09-04T08:16:12Z","format":"date-time","type":"string"}},"required":["created_at","id","object","parcels","recipient","reference","sender","service","status","tracking_number","updated_at"],"type":"object"},"ShipmentPage":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Shipment"},"type":"array"},"has_more":{"type":"boolean"},"next_cursor":{"type":["null","string"]}},"required":["data","has_more","next_cursor"],"type":"object"},"ShipmentStatus":{"enum":["draft","label_purchased","in_transit","out_for_delivery","delivered","exception","canceled"],"type":"string"},"ShipmentStatusEvent":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"data":{"additionalProperties":false,"properties":{"event":{"$ref":"#/components/schemas/TrackingEvent"},"shipment":{"$ref":"#/components/schemas/Shipment"}},"required":["event","shipment"],"type":"object"},"id":{"example":"wh_evt_0000000000000001","type":"string"},"type":{"const":"shipment.status_changed"}},"required":["created_at","data","id","type"],"type":"object"},"TrackingEvent":{"additionalProperties":false,"properties":{"id":{"example":"evt_00000000000000000001","type":"string"},"location":{"additionalProperties":false,"properties":{"city":{"example":"Samplehaven","type":"string"},"country":{"example":"ZZ","type":"string"}},"required":["city","country"],"type":"object"},"message":{"example":"Parcel scanned at synthetic sorting hub","type":"string"},"object":{"const":"tracking_event"},"occurred_at":{"example":"2026-09-05T05:40:00Z","format":"date-time","type":"string"},"shipment_id":{"example":"shp_00000000000000000001","type":"string"},"status":{"$ref":"#/components/schemas/ShipmentStatus"}},"required":["id","location","object","occurred_at","shipment_id","status"],"type":"object"},"TrackingEventPage":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/TrackingEvent"},"type":"array"},"has_more":{"type":"boolean"},"next_cursor":{"type":["null","string"]}},"required":["data","has_more","next_cursor"],"type":"object"},"TrackingTimeline":{"additionalProperties":false,"properties":{"events":{"items":{"$ref":"#/components/schemas/TrackingEvent"},"type":"array"},"shipment":{"$ref":"#/components/schemas/Shipment"}},"required":["events","shipment"],"type":"object"},"UpdateShipmentRequest":{"additionalProperties":false,"minProperties":1,"properties":{"delivery_instructions":{"maxLength":500,"type":["null","string"]},"metadata":{"additionalProperties":{"type":"string"},"type":"object"}},"type":"object"},"UpdateWebhookEndpointRequest":{"additionalProperties":false,"minProperties":1,"properties":{"enabled":{"type":"boolean"},"events":{"items":{"$ref":"#/components/schemas/WebhookEventType"},"minItems":1,"type":"array","uniqueItems":true},"url":{"format":"uri","type":"string"}},"type":"object"},"WebhookEndpoint":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"events":{"items":{"$ref":"#/components/schemas/WebhookEventType"},"type":"array"},"id":{"example":"whe_00000000000000000001","type":"string"},"object":{"const":"webhook_endpoint"},"signing_secret_hint":{"example":"synthetic-key-ending-0000","type":"string"},"url":{"example":"https://hooks.parcel-events.example/events","format":"uri","type":"string"}},"required":["created_at","enabled","events","id","object","url"],"type":"object"},"WebhookEndpointPage":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookEndpoint"},"type":"array"},"has_more":{"type":"boolean"},"next_cursor":{"type":["null","string"]}},"required":["data","has_more","next_cursor"],"type":"object"},"WebhookEventType":{"enum":["shipment.created","shipment.status_changed","shipment.delivered","shipment.exception","pickup.completed"],"type":"string"}},"securitySchemes":{"ApiKey":{"in":"header","name":"Parcel-API-Key","type":"apiKey"},"BearerToken":{"bearerFormat":"opaque","scheme":"bearer","type":"http"}}},"info":{"contact":{"name":"Parcel Events Sandbox Team","url":"https://parcel-events.example/support"},"description":"A fictional logistics API used only to exercise generated SDK publication. Every company, identifier, address, tracking event, and URL in this corpus is synthetic.","license":{"identifier":"Apache-2.0","name":"Apache-2.0"},"summary":"Synthetic parcel orchestration and tracking API","title":"Parcel Events Sandbox API","version":"2026-09-04"},"openapi":"3.1.0","paths":{"/v1/labels":{"post":{"operationId":"createLabel","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLabelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"Label created"},"402":{"$ref":"#/components/responses/PaymentRequired"},"422":{"$ref":"#/components/responses/ValidationFailed"}},"summary":"Buy and render a shipping label","tags":["Labels"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.parcel-events.example/v1/labels\");\nrequest.Content = new StringContent(\"{\\\"format\\\":\\\"pdf\\\",\\\"page_size\\\":\\\"four_by_six\\\",\\\"shipment_id\\\":\\\"shp_00000000000000000001\\\"}\", Encoding.UTF8, \"application/json\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X POST 'https://api.parcel-events.example/v1/labels' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"format\":\"pdf\",\"page_size\":\"four_by_six\",\"shipment_id\":\"shp_00000000000000000001\"}'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tbody := strings.NewReader(`{\"format\":\"pdf\",\"page_size\":\"four_by_six\",\"shipment_id\":\"shp_00000000000000000001\"}`)\n\treq, err := http.NewRequestWithContext(ctx, \"POST\", \"https://api.parcel-events.example/v1/labels\", body)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/labels\"))\n    .method(\"POST\", HttpRequest.BodyPublishers.noBody())\n    .header(\"Content-Type\", \"application/json\")\n    .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"format\\\":\\\"pdf\\\",\\\"page_size\\\":\\\"four_by_six\\\",\\\"shipment_id\\\":\\\"shp_00000000000000000001\\\"}\"))\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/labels', {\n  method: 'POST',\n  headers: { 'Content-Type': 'application/json' },\n  body: JSON.stringify({\"format\":\"pdf\",\"page_size\":\"four_by_six\",\"shipment_id\":\"shp_00000000000000000001\"}),\n});\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/labels', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: \"{\\\"format\\\":\\\"pdf\\\",\\\"page_size\\\":\\\"four_by_six\\\",\\\"shipment_id\\\":\\\"shp_00000000000000000001\\\"}\" });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/labels\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_setopt($request, CURLOPT_POSTFIELDS, \"{\\\"format\\\":\\\"pdf\\\",\\\"page_size\\\":\\\"four_by_six\\\",\\\"shipment_id\\\":\\\"shp_00000000000000000001\\\"}\");\ncurl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\n    \"POST\",\n    \"https://api.parcel-events.example/v1/labels\",\n    headers={\"Content-Type\": \"application/json\"},\n    data='{\"format\":\"pdf\",\"page_size\":\"four_by_six\",\"shipment_id\":\"shp_00000000000000000001\"}',\n)\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/labels\")\nrequest = Net::HTTPGenericRequest.new(\"POST\", true, true, uri)\nrequest['Content-Type'] = 'application/json'\nrequest.body = \"{\\\"format\\\":\\\"pdf\\\",\\\"page_size\\\":\\\"four_by_six\\\",\\\"shipment_id\\\":\\\"shp_00000000000000000001\\\"}\"\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]}},"/v1/labels/{label_id}":{"get":{"operationId":"retrieveLabel","parameters":[{"$ref":"#/components/parameters/LabelId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"Label metadata"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve label metadata and download URL","tags":["Labels"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.parcel-events.example/v1/labels/string\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X GET 'https://api.parcel-events.example/v1/labels/string'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\treq, err := http.NewRequestWithContext(ctx, \"GET\", \"https://api.parcel-events.example/v1/labels/string\", nil)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/labels/string\"))\n    .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/labels/string', { method: 'GET' });\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/labels/string', { method: 'GET' });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/labels/string\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"GET\");\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\"GET\", \"https://api.parcel-events.example/v1/labels/string\")\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/labels/string\")\nrequest = Net::HTTPGenericRequest.new(\"GET\", false, true, uri)\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]}},"/v1/pickups":{"get":{"operationId":"listPickups","parameters":[{"$ref":"#/components/parameters/Cursor"},{"$ref":"#/components/parameters/Limit"},{"in":"query","name":"scheduled_on","schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PickupPage"}}},"description":"A page of pickups"}},"summary":"List scheduled pickups","tags":["Pickups"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.parcel-events.example/v1/pickups?cursor=string&limit=25&scheduled_on=2026-06-09\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X GET 'https://api.parcel-events.example/v1/pickups?cursor=string&limit=25&scheduled_on=2026-06-09'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\treq, err := http.NewRequestWithContext(ctx, \"GET\", \"https://api.parcel-events.example/v1/pickups?cursor=string&limit=25&scheduled_on=2026-06-09\", nil)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/pickups?cursor=string&limit=25&scheduled_on=2026-06-09\"))\n    .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/pickups?cursor=string&limit=25&scheduled_on=2026-06-09', { method: 'GET' });\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/pickups?cursor=string&limit=25&scheduled_on=2026-06-09', { method: 'GET' });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/pickups?cursor=string&limit=25&scheduled_on=2026-06-09\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"GET\");\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\"GET\", \"https://api.parcel-events.example/v1/pickups?cursor=string&limit=25&scheduled_on=2026-06-09\")\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/pickups?cursor=string&limit=25&scheduled_on=2026-06-09\")\nrequest = Net::HTTPGenericRequest.new(\"GET\", false, true, uri)\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]},"post":{"operationId":"createPickup","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePickupRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pickup"}}},"description":"Pickup scheduled"},"422":{"$ref":"#/components/responses/ValidationFailed"}},"summary":"Schedule a carrier pickup","tags":["Pickups"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.parcel-events.example/v1/pickups\");\nrequest.Content = new StringContent(\"{\\\"address\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"notes\\\":\\\"string\\\",\\\"shipment_ids\\\":[\\\"string\\\"],\\\"window\\\":{\\\"ends_at\\\":\\\"2026-09-06T12:00:00Z\\\",\\\"starts_at\\\":\\\"2026-09-06T09:00:00Z\\\"}}\", Encoding.UTF8, \"application/json\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X POST 'https://api.parcel-events.example/v1/pickups' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"address\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"notes\":\"string\",\"shipment_ids\":[\"string\"],\"window\":{\"ends_at\":\"2026-09-06T12:00:00Z\",\"starts_at\":\"2026-09-06T09:00:00Z\"}}'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tbody := strings.NewReader(`{\"address\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"notes\":\"string\",\"shipment_ids\":[\"string\"],\"window\":{\"ends_at\":\"2026-09-06T12:00:00Z\",\"starts_at\":\"2026-09-06T09:00:00Z\"}}`)\n\treq, err := http.NewRequestWithContext(ctx, \"POST\", \"https://api.parcel-events.example/v1/pickups\", body)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/pickups\"))\n    .method(\"POST\", HttpRequest.BodyPublishers.noBody())\n    .header(\"Content-Type\", \"application/json\")\n    .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"address\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"notes\\\":\\\"string\\\",\\\"shipment_ids\\\":[\\\"string\\\"],\\\"window\\\":{\\\"ends_at\\\":\\\"2026-09-06T12:00:00Z\\\",\\\"starts_at\\\":\\\"2026-09-06T09:00:00Z\\\"}}\"))\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/pickups', {\n  method: 'POST',\n  headers: { 'Content-Type': 'application/json' },\n  body: JSON.stringify({\"address\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"notes\":\"string\",\"shipment_ids\":[\"string\"],\"window\":{\"ends_at\":\"2026-09-06T12:00:00Z\",\"starts_at\":\"2026-09-06T09:00:00Z\"}}),\n});\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/pickups', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: \"{\\\"address\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"notes\\\":\\\"string\\\",\\\"shipment_ids\\\":[\\\"string\\\"],\\\"window\\\":{\\\"ends_at\\\":\\\"2026-09-06T12:00:00Z\\\",\\\"starts_at\\\":\\\"2026-09-06T09:00:00Z\\\"}}\" });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/pickups\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_setopt($request, CURLOPT_POSTFIELDS, \"{\\\"address\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"notes\\\":\\\"string\\\",\\\"shipment_ids\\\":[\\\"string\\\"],\\\"window\\\":{\\\"ends_at\\\":\\\"2026-09-06T12:00:00Z\\\",\\\"starts_at\\\":\\\"2026-09-06T09:00:00Z\\\"}}\");\ncurl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\n    \"POST\",\n    \"https://api.parcel-events.example/v1/pickups\",\n    headers={\"Content-Type\": \"application/json\"},\n    data='{\"address\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"notes\":\"string\",\"shipment_ids\":[\"string\"],\"window\":{\"ends_at\":\"2026-09-06T12:00:00Z\",\"starts_at\":\"2026-09-06T09:00:00Z\"}}',\n)\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/pickups\")\nrequest = Net::HTTPGenericRequest.new(\"POST\", true, true, uri)\nrequest['Content-Type'] = 'application/json'\nrequest.body = \"{\\\"address\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"notes\\\":\\\"string\\\",\\\"shipment_ids\\\":[\\\"string\\\"],\\\"window\\\":{\\\"ends_at\\\":\\\"2026-09-06T12:00:00Z\\\",\\\"starts_at\\\":\\\"2026-09-06T09:00:00Z\\\"}}\"\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]}},"/v1/pickups/{pickup_id}":{"delete":{"operationId":"cancelPickup","responses":{"204":{"description":"Pickup canceled"},"409":{"$ref":"#/components/responses/Conflict"}},"summary":"Cancel a pickup","tags":["Pickups"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Delete, \"https://api.parcel-events.example/v1/pickups/string\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X DELETE 'https://api.parcel-events.example/v1/pickups/string'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\treq, err := http.NewRequestWithContext(ctx, \"DELETE\", \"https://api.parcel-events.example/v1/pickups/string\", nil)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/pickups/string\"))\n    .method(\"DELETE\", HttpRequest.BodyPublishers.noBody())\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/pickups/string', { method: 'DELETE' });\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/pickups/string', { method: 'DELETE' });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/pickups/string\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"DELETE\");\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\"DELETE\", \"https://api.parcel-events.example/v1/pickups/string\")\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/pickups/string\")\nrequest = Net::HTTPGenericRequest.new(\"DELETE\", false, true, uri)\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]},"get":{"operationId":"retrievePickup","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pickup"}}},"description":"Pickup details"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a pickup","tags":["Pickups"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.parcel-events.example/v1/pickups/string\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X GET 'https://api.parcel-events.example/v1/pickups/string'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\treq, err := http.NewRequestWithContext(ctx, \"GET\", \"https://api.parcel-events.example/v1/pickups/string\", nil)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/pickups/string\"))\n    .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/pickups/string', { method: 'GET' });\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/pickups/string', { method: 'GET' });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/pickups/string\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"GET\");\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\"GET\", \"https://api.parcel-events.example/v1/pickups/string\")\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/pickups/string\")\nrequest = Net::HTTPGenericRequest.new(\"GET\", false, true, uri)\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]},"parameters":[{"$ref":"#/components/parameters/PickupId"}]},"/v1/rates/quote":{"post":{"operationId":"quoteRates","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateQuoteRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RateQuote"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"Ranked rate quotes"},"422":{"$ref":"#/components/responses/ValidationFailed"}},"summary":"Quote available shipping services","tags":["Rates"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.parcel-events.example/v1/rates/quote\");\nrequest.Content = new StringContent(\"{\\\"parcels\\\":[{\\\"contents\\\":[{\\\"customs_code\\\":\\\"610910\\\",\\\"description\\\":\\\"Synthetic cotton shirt\\\",\\\"quantity\\\":2,\\\"unit_value\\\":{\\\"amount\\\":\\\"12.50\\\",\\\"currency\\\":\\\"XTS\\\"}}],\\\"height_cm\\\":12,\\\"length_cm\\\":30.5,\\\"weight_grams\\\":1750,\\\"width_cm\\\":20}],\\\"recipient\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"sender\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"}}\", Encoding.UTF8, \"application/json\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X POST 'https://api.parcel-events.example/v1/rates/quote' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"parcels\":[{\"contents\":[{\"customs_code\":\"610910\",\"description\":\"Synthetic cotton shirt\",\"quantity\":2,\"unit_value\":{\"amount\":\"12.50\",\"currency\":\"XTS\"}}],\"height_cm\":12,\"length_cm\":30.5,\"weight_grams\":1750,\"width_cm\":20}],\"recipient\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"sender\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"}}'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tbody := strings.NewReader(`{\"parcels\":[{\"contents\":[{\"customs_code\":\"610910\",\"description\":\"Synthetic cotton shirt\",\"quantity\":2,\"unit_value\":{\"amount\":\"12.50\",\"currency\":\"XTS\"}}],\"height_cm\":12,\"length_cm\":30.5,\"weight_grams\":1750,\"width_cm\":20}],\"recipient\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"sender\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"}}`)\n\treq, err := http.NewRequestWithContext(ctx, \"POST\", \"https://api.parcel-events.example/v1/rates/quote\", body)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/rates/quote\"))\n    .method(\"POST\", HttpRequest.BodyPublishers.noBody())\n    .header(\"Content-Type\", \"application/json\")\n    .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"parcels\\\":[{\\\"contents\\\":[{\\\"customs_code\\\":\\\"610910\\\",\\\"description\\\":\\\"Synthetic cotton shirt\\\",\\\"quantity\\\":2,\\\"unit_value\\\":{\\\"amount\\\":\\\"12.50\\\",\\\"currency\\\":\\\"XTS\\\"}}],\\\"height_cm\\\":12,\\\"length_cm\\\":30.5,\\\"weight_grams\\\":1750,\\\"width_cm\\\":20}],\\\"recipient\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"sender\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"}}\"))\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/rates/quote', {\n  method: 'POST',\n  headers: { 'Content-Type': 'application/json' },\n  body: JSON.stringify({\"parcels\":[{\"contents\":[{\"customs_code\":\"610910\",\"description\":\"Synthetic cotton shirt\",\"quantity\":2,\"unit_value\":{\"amount\":\"12.50\",\"currency\":\"XTS\"}}],\"height_cm\":12,\"length_cm\":30.5,\"weight_grams\":1750,\"width_cm\":20}],\"recipient\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"sender\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"}}),\n});\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/rates/quote', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: \"{\\\"parcels\\\":[{\\\"contents\\\":[{\\\"customs_code\\\":\\\"610910\\\",\\\"description\\\":\\\"Synthetic cotton shirt\\\",\\\"quantity\\\":2,\\\"unit_value\\\":{\\\"amount\\\":\\\"12.50\\\",\\\"currency\\\":\\\"XTS\\\"}}],\\\"height_cm\\\":12,\\\"length_cm\\\":30.5,\\\"weight_grams\\\":1750,\\\"width_cm\\\":20}],\\\"recipient\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"sender\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"}}\" });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/rates/quote\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_setopt($request, CURLOPT_POSTFIELDS, \"{\\\"parcels\\\":[{\\\"contents\\\":[{\\\"customs_code\\\":\\\"610910\\\",\\\"description\\\":\\\"Synthetic cotton shirt\\\",\\\"quantity\\\":2,\\\"unit_value\\\":{\\\"amount\\\":\\\"12.50\\\",\\\"currency\\\":\\\"XTS\\\"}}],\\\"height_cm\\\":12,\\\"length_cm\\\":30.5,\\\"weight_grams\\\":1750,\\\"width_cm\\\":20}],\\\"recipient\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"sender\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"}}\");\ncurl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\n    \"POST\",\n    \"https://api.parcel-events.example/v1/rates/quote\",\n    headers={\"Content-Type\": \"application/json\"},\n    data='{\"parcels\":[{\"contents\":[{\"customs_code\":\"610910\",\"description\":\"Synthetic cotton shirt\",\"quantity\":2,\"unit_value\":{\"amount\":\"12.50\",\"currency\":\"XTS\"}}],\"height_cm\":12,\"length_cm\":30.5,\"weight_grams\":1750,\"width_cm\":20}],\"recipient\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"sender\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"}}',\n)\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/rates/quote\")\nrequest = Net::HTTPGenericRequest.new(\"POST\", true, true, uri)\nrequest['Content-Type'] = 'application/json'\nrequest.body = \"{\\\"parcels\\\":[{\\\"contents\\\":[{\\\"customs_code\\\":\\\"610910\\\",\\\"description\\\":\\\"Synthetic cotton shirt\\\",\\\"quantity\\\":2,\\\"unit_value\\\":{\\\"amount\\\":\\\"12.50\\\",\\\"currency\\\":\\\"XTS\\\"}}],\\\"height_cm\\\":12,\\\"length_cm\\\":30.5,\\\"weight_grams\\\":1750,\\\"width_cm\\\":20}],\\\"recipient\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"sender\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"}}\"\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]}},"/v1/shipments":{"get":{"operationId":"listShipments","parameters":[{"$ref":"#/components/parameters/Cursor"},{"$ref":"#/components/parameters/Limit"},{"in":"query","name":"status","schema":{"$ref":"#/components/schemas/ShipmentStatus"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentPage"}}},"description":"A page of shipments"},"401":{"$ref":"#/components/responses/Unauthorized"}},"summary":"List shipments","tags":["Shipments"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X GET 'https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\treq, err := http.NewRequestWithContext(ctx, \"GET\", \"https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled\", nil)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled\"))\n    .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled', { method: 'GET' });\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled', { method: 'GET' });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"GET\");\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\"GET\", \"https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled\")\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled\")\nrequest = Net::HTTPGenericRequest.new(\"GET\", false, true, uri)\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]},"post":{"operationId":"createShipment","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShipmentRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}}},"description":"Shipment created","headers":{"Location":{"schema":{"format":"uri","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"409":{"$ref":"#/components/responses/Conflict"}},"summary":"Create a shipment","tags":["Shipments"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.parcel-events.example/v1/shipments\");\nrequest.Content = new StringContent(\"{\\\"delivery_instructions\\\":\\\"Leave with the synthetic reception desk\\\",\\\"metadata\\\":{\\\"additionalProp1\\\":\\\"string\\\"},\\\"parcels\\\":[{\\\"contents\\\":[{\\\"customs_code\\\":\\\"610910\\\",\\\"description\\\":\\\"Synthetic cotton shirt\\\",\\\"quantity\\\":2,\\\"unit_value\\\":{\\\"amount\\\":\\\"12.50\\\",\\\"currency\\\":\\\"XTS\\\"}}],\\\"height_cm\\\":12,\\\"length_cm\\\":30.5,\\\"weight_grams\\\":1750,\\\"width_cm\\\":20}],\\\"recipient\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"reference\\\":\\\"synthetic-order-1042\\\",\\\"sender\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"service\\\":\\\"economy\\\"}\", Encoding.UTF8, \"application/json\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X POST 'https://api.parcel-events.example/v1/shipments' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"delivery_instructions\":\"Leave with the synthetic reception desk\",\"metadata\":{\"additionalProp1\":\"string\"},\"parcels\":[{\"contents\":[{\"customs_code\":\"610910\",\"description\":\"Synthetic cotton shirt\",\"quantity\":2,\"unit_value\":{\"amount\":\"12.50\",\"currency\":\"XTS\"}}],\"height_cm\":12,\"length_cm\":30.5,\"weight_grams\":1750,\"width_cm\":20}],\"recipient\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"reference\":\"synthetic-order-1042\",\"sender\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"service\":\"economy\"}'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tbody := strings.NewReader(`{\"delivery_instructions\":\"Leave with the synthetic reception desk\",\"metadata\":{\"additionalProp1\":\"string\"},\"parcels\":[{\"contents\":[{\"customs_code\":\"610910\",\"description\":\"Synthetic cotton shirt\",\"quantity\":2,\"unit_value\":{\"amount\":\"12.50\",\"currency\":\"XTS\"}}],\"height_cm\":12,\"length_cm\":30.5,\"weight_grams\":1750,\"width_cm\":20}],\"recipient\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"reference\":\"synthetic-order-1042\",\"sender\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"service\":\"economy\"}`)\n\treq, err := http.NewRequestWithContext(ctx, \"POST\", \"https://api.parcel-events.example/v1/shipments\", body)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/shipments\"))\n    .method(\"POST\", HttpRequest.BodyPublishers.noBody())\n    .header(\"Content-Type\", \"application/json\")\n    .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"delivery_instructions\\\":\\\"Leave with the synthetic reception desk\\\",\\\"metadata\\\":{\\\"additionalProp1\\\":\\\"string\\\"},\\\"parcels\\\":[{\\\"contents\\\":[{\\\"customs_code\\\":\\\"610910\\\",\\\"description\\\":\\\"Synthetic cotton shirt\\\",\\\"quantity\\\":2,\\\"unit_value\\\":{\\\"amount\\\":\\\"12.50\\\",\\\"currency\\\":\\\"XTS\\\"}}],\\\"height_cm\\\":12,\\\"length_cm\\\":30.5,\\\"weight_grams\\\":1750,\\\"width_cm\\\":20}],\\\"recipient\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"reference\\\":\\\"synthetic-order-1042\\\",\\\"sender\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"service\\\":\\\"economy\\\"}\"))\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/shipments', {\n  method: 'POST',\n  headers: { 'Content-Type': 'application/json' },\n  body: JSON.stringify({\"delivery_instructions\":\"Leave with the synthetic reception desk\",\"metadata\":{\"additionalProp1\":\"string\"},\"parcels\":[{\"contents\":[{\"customs_code\":\"610910\",\"description\":\"Synthetic cotton shirt\",\"quantity\":2,\"unit_value\":{\"amount\":\"12.50\",\"currency\":\"XTS\"}}],\"height_cm\":12,\"length_cm\":30.5,\"weight_grams\":1750,\"width_cm\":20}],\"recipient\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"reference\":\"synthetic-order-1042\",\"sender\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"service\":\"economy\"}),\n});\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/shipments', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: \"{\\\"delivery_instructions\\\":\\\"Leave with the synthetic reception desk\\\",\\\"metadata\\\":{\\\"additionalProp1\\\":\\\"string\\\"},\\\"parcels\\\":[{\\\"contents\\\":[{\\\"customs_code\\\":\\\"610910\\\",\\\"description\\\":\\\"Synthetic cotton shirt\\\",\\\"quantity\\\":2,\\\"unit_value\\\":{\\\"amount\\\":\\\"12.50\\\",\\\"currency\\\":\\\"XTS\\\"}}],\\\"height_cm\\\":12,\\\"length_cm\\\":30.5,\\\"weight_grams\\\":1750,\\\"width_cm\\\":20}],\\\"recipient\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"reference\\\":\\\"synthetic-order-1042\\\",\\\"sender\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"service\\\":\\\"economy\\\"}\" });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/shipments\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_setopt($request, CURLOPT_POSTFIELDS, \"{\\\"delivery_instructions\\\":\\\"Leave with the synthetic reception desk\\\",\\\"metadata\\\":{\\\"additionalProp1\\\":\\\"string\\\"},\\\"parcels\\\":[{\\\"contents\\\":[{\\\"customs_code\\\":\\\"610910\\\",\\\"description\\\":\\\"Synthetic cotton shirt\\\",\\\"quantity\\\":2,\\\"unit_value\\\":{\\\"amount\\\":\\\"12.50\\\",\\\"currency\\\":\\\"XTS\\\"}}],\\\"height_cm\\\":12,\\\"length_cm\\\":30.5,\\\"weight_grams\\\":1750,\\\"width_cm\\\":20}],\\\"recipient\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"reference\\\":\\\"synthetic-order-1042\\\",\\\"sender\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"service\\\":\\\"economy\\\"}\");\ncurl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\n    \"POST\",\n    \"https://api.parcel-events.example/v1/shipments\",\n    headers={\"Content-Type\": \"application/json\"},\n    data='{\"delivery_instructions\":\"Leave with the synthetic reception desk\",\"metadata\":{\"additionalProp1\":\"string\"},\"parcels\":[{\"contents\":[{\"customs_code\":\"610910\",\"description\":\"Synthetic cotton shirt\",\"quantity\":2,\"unit_value\":{\"amount\":\"12.50\",\"currency\":\"XTS\"}}],\"height_cm\":12,\"length_cm\":30.5,\"weight_grams\":1750,\"width_cm\":20}],\"recipient\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"reference\":\"synthetic-order-1042\",\"sender\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"service\":\"economy\"}',\n)\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/shipments\")\nrequest = Net::HTTPGenericRequest.new(\"POST\", true, true, uri)\nrequest['Content-Type'] = 'application/json'\nrequest.body = \"{\\\"delivery_instructions\\\":\\\"Leave with the synthetic reception desk\\\",\\\"metadata\\\":{\\\"additionalProp1\\\":\\\"string\\\"},\\\"parcels\\\":[{\\\"contents\\\":[{\\\"customs_code\\\":\\\"610910\\\",\\\"description\\\":\\\"Synthetic cotton shirt\\\",\\\"quantity\\\":2,\\\"unit_value\\\":{\\\"amount\\\":\\\"12.50\\\",\\\"currency\\\":\\\"XTS\\\"}}],\\\"height_cm\\\":12,\\\"length_cm\\\":30.5,\\\"weight_grams\\\":1750,\\\"width_cm\\\":20}],\\\"recipient\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"reference\\\":\\\"synthetic-order-1042\\\",\\\"sender\\\":{\\\"city\\\":\\\"Exampleton\\\",\\\"company\\\":\\\"Northstar Supplies\\\",\\\"country\\\":\\\"ZZ\\\",\\\"line1\\\":\\\"14 Fictional Quay\\\",\\\"line2\\\":\\\"Unit 7\\\",\\\"name\\\":\\\"Rowan Example\\\",\\\"phone\\\":\\\"+00000000000\\\",\\\"postal_code\\\":\\\"EX4 2PL\\\",\\\"region\\\":\\\"Test Province\\\"},\\\"service\\\":\\\"economy\\\"}\"\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]}},"/v1/shipments/{shipment_id}":{"delete":{"operationId":"cancelShipment","responses":{"204":{"description":"Shipment canceled"},"409":{"$ref":"#/components/responses/Conflict"}},"summary":"Cancel a shipment before handoff","tags":["Shipments"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Delete, \"https://api.parcel-events.example/v1/shipments/string\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X DELETE 'https://api.parcel-events.example/v1/shipments/string'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\treq, err := http.NewRequestWithContext(ctx, \"DELETE\", \"https://api.parcel-events.example/v1/shipments/string\", nil)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/shipments/string\"))\n    .method(\"DELETE\", HttpRequest.BodyPublishers.noBody())\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/shipments/string', { method: 'DELETE' });\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/shipments/string', { method: 'DELETE' });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/shipments/string\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"DELETE\");\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\"DELETE\", \"https://api.parcel-events.example/v1/shipments/string\")\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/shipments/string\")\nrequest = Net::HTTPGenericRequest.new(\"DELETE\", false, true, uri)\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]},"get":{"operationId":"retrieveShipment","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}}},"description":"Shipment details"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Retrieve a shipment","tags":["Shipments"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.parcel-events.example/v1/shipments/string\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X GET 'https://api.parcel-events.example/v1/shipments/string'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\treq, err := http.NewRequestWithContext(ctx, \"GET\", \"https://api.parcel-events.example/v1/shipments/string\", nil)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/shipments/string\"))\n    .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/shipments/string', { method: 'GET' });\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/shipments/string', { method: 'GET' });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/shipments/string\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"GET\");\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\"GET\", \"https://api.parcel-events.example/v1/shipments/string\")\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/shipments/string\")\nrequest = Net::HTTPGenericRequest.new(\"GET\", false, true, uri)\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]},"parameters":[{"$ref":"#/components/parameters/ShipmentId"}],"patch":{"operationId":"updateShipment","requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateShipmentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}}},"description":"Updated shipment"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationFailed"}},"summary":"Update delivery instructions","tags":["Shipments"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Patch, \"https://api.parcel-events.example/v1/shipments/string\");\nrequest.Content = new StringContent(\"{\\\"delivery_instructions\\\":\\\"string\\\",\\\"metadata\\\":{\\\"additionalProp1\\\":\\\"string\\\"}}\", Encoding.UTF8, \"application/json\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X PATCH 'https://api.parcel-events.example/v1/shipments/string' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"delivery_instructions\":\"string\",\"metadata\":{\"additionalProp1\":\"string\"}}'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tbody := strings.NewReader(`{\"delivery_instructions\":\"string\",\"metadata\":{\"additionalProp1\":\"string\"}}`)\n\treq, err := http.NewRequestWithContext(ctx, \"PATCH\", \"https://api.parcel-events.example/v1/shipments/string\", body)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/shipments/string\"))\n    .method(\"PATCH\", HttpRequest.BodyPublishers.noBody())\n    .header(\"Content-Type\", \"application/json\")\n    .method(\"PATCH\", HttpRequest.BodyPublishers.ofString(\"{\\\"delivery_instructions\\\":\\\"string\\\",\\\"metadata\\\":{\\\"additionalProp1\\\":\\\"string\\\"}}\"))\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/shipments/string', {\n  method: 'PATCH',\n  headers: { 'Content-Type': 'application/json' },\n  body: JSON.stringify({\"delivery_instructions\":\"string\",\"metadata\":{\"additionalProp1\":\"string\"}}),\n});\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/shipments/string', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: \"{\\\"delivery_instructions\\\":\\\"string\\\",\\\"metadata\\\":{\\\"additionalProp1\\\":\\\"string\\\"}}\" });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/shipments/string\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_setopt($request, CURLOPT_POSTFIELDS, \"{\\\"delivery_instructions\\\":\\\"string\\\",\\\"metadata\\\":{\\\"additionalProp1\\\":\\\"string\\\"}}\");\ncurl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\n    \"PATCH\",\n    \"https://api.parcel-events.example/v1/shipments/string\",\n    headers={\"Content-Type\": \"application/json\"},\n    data='{\"delivery_instructions\":\"string\",\"metadata\":{\"additionalProp1\":\"string\"}}',\n)\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/shipments/string\")\nrequest = Net::HTTPGenericRequest.new(\"PATCH\", true, true, uri)\nrequest['Content-Type'] = 'application/json'\nrequest.body = \"{\\\"delivery_instructions\\\":\\\"string\\\",\\\"metadata\\\":{\\\"additionalProp1\\\":\\\"string\\\"}}\"\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]}},"/v1/shipments/{shipment_id}/events":{"get":{"operationId":"listShipmentEvents","parameters":[{"$ref":"#/components/parameters/Cursor"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingEventPage"}}},"description":"A page of immutable tracking events"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"List tracking events for a shipment","tags":["Tracking"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X GET 'https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\treq, err := http.NewRequestWithContext(ctx, \"GET\", \"https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25\", nil)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25\"))\n    .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25', { method: 'GET' });\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25', { method: 'GET' });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"GET\");\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\"GET\", \"https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25\")\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25\")\nrequest = Net::HTTPGenericRequest.new(\"GET\", false, true, uri)\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]},"parameters":[{"$ref":"#/components/parameters/ShipmentId"}]},"/v1/tracking/{tracking_number}":{"get":{"operationId":"retrieveTrackingTimeline","parameters":[{"in":"path","name":"tracking_number","required":true,"schema":{"pattern":"^PE-[A-Z0-9]{12}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingTimeline"}}},"description":"Tracking timeline"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[],"summary":"Retrieve a public tracking timeline","tags":["Tracking"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.parcel-events.example/v1/tracking/string\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X GET 'https://api.parcel-events.example/v1/tracking/string'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\treq, err := http.NewRequestWithContext(ctx, \"GET\", \"https://api.parcel-events.example/v1/tracking/string\", nil)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/tracking/string\"))\n    .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/tracking/string', { method: 'GET' });\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/tracking/string', { method: 'GET' });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/tracking/string\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"GET\");\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\"GET\", \"https://api.parcel-events.example/v1/tracking/string\")\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/tracking/string\")\nrequest = Net::HTTPGenericRequest.new(\"GET\", false, true, uri)\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]}},"/v1/webhook-endpoints":{"get":{"operationId":"listWebhookEndpoints","parameters":[{"$ref":"#/components/parameters/Cursor"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointPage"}}},"description":"A page of webhook endpoints"}},"summary":"List webhook endpoints","tags":["Webhook endpoints"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X GET 'https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\treq, err := http.NewRequestWithContext(ctx, \"GET\", \"https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25\", nil)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25\"))\n    .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25', { method: 'GET' });\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25', { method: 'GET' });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"GET\");\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\"GET\", \"https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25\")\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25\")\nrequest = Net::HTTPGenericRequest.new(\"GET\", false, true, uri)\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]},"post":{"operationId":"createWebhookEndpoint","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookEndpointRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}},"description":"Webhook endpoint registered"},"422":{"$ref":"#/components/responses/ValidationFailed"}},"summary":"Register a webhook endpoint","tags":["Webhook endpoints"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.parcel-events.example/v1/webhook-endpoints\");\nrequest.Content = new StringContent(\"{\\\"description\\\":\\\"string\\\",\\\"events\\\":[\\\"pickup.completed\\\"],\\\"url\\\":\\\"https://hooks.parcel-events.example/events\\\"}\", Encoding.UTF8, \"application/json\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X POST 'https://api.parcel-events.example/v1/webhook-endpoints' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"description\":\"string\",\"events\":[\"pickup.completed\"],\"url\":\"https://hooks.parcel-events.example/events\"}'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tbody := strings.NewReader(`{\"description\":\"string\",\"events\":[\"pickup.completed\"],\"url\":\"https://hooks.parcel-events.example/events\"}`)\n\treq, err := http.NewRequestWithContext(ctx, \"POST\", \"https://api.parcel-events.example/v1/webhook-endpoints\", body)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/webhook-endpoints\"))\n    .method(\"POST\", HttpRequest.BodyPublishers.noBody())\n    .header(\"Content-Type\", \"application/json\")\n    .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"description\\\":\\\"string\\\",\\\"events\\\":[\\\"pickup.completed\\\"],\\\"url\\\":\\\"https://hooks.parcel-events.example/events\\\"}\"))\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/webhook-endpoints', {\n  method: 'POST',\n  headers: { 'Content-Type': 'application/json' },\n  body: JSON.stringify({\"description\":\"string\",\"events\":[\"pickup.completed\"],\"url\":\"https://hooks.parcel-events.example/events\"}),\n});\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/webhook-endpoints', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: \"{\\\"description\\\":\\\"string\\\",\\\"events\\\":[\\\"pickup.completed\\\"],\\\"url\\\":\\\"https://hooks.parcel-events.example/events\\\"}\" });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/webhook-endpoints\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_setopt($request, CURLOPT_POSTFIELDS, \"{\\\"description\\\":\\\"string\\\",\\\"events\\\":[\\\"pickup.completed\\\"],\\\"url\\\":\\\"https://hooks.parcel-events.example/events\\\"}\");\ncurl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\n    \"POST\",\n    \"https://api.parcel-events.example/v1/webhook-endpoints\",\n    headers={\"Content-Type\": \"application/json\"},\n    data='{\"description\":\"string\",\"events\":[\"pickup.completed\"],\"url\":\"https://hooks.parcel-events.example/events\"}',\n)\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/webhook-endpoints\")\nrequest = Net::HTTPGenericRequest.new(\"POST\", true, true, uri)\nrequest['Content-Type'] = 'application/json'\nrequest.body = \"{\\\"description\\\":\\\"string\\\",\\\"events\\\":[\\\"pickup.completed\\\"],\\\"url\\\":\\\"https://hooks.parcel-events.example/events\\\"}\"\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]}},"/v1/webhook-endpoints/{endpoint_id}":{"delete":{"operationId":"deleteWebhookEndpoint","responses":{"204":{"description":"Endpoint deleted"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Delete a webhook endpoint","tags":["Webhook endpoints"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Delete, \"https://api.parcel-events.example/v1/webhook-endpoints/string\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X DELETE 'https://api.parcel-events.example/v1/webhook-endpoints/string'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\treq, err := http.NewRequestWithContext(ctx, \"DELETE\", \"https://api.parcel-events.example/v1/webhook-endpoints/string\", nil)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/webhook-endpoints/string\"))\n    .method(\"DELETE\", HttpRequest.BodyPublishers.noBody())\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/webhook-endpoints/string', { method: 'DELETE' });\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/webhook-endpoints/string', { method: 'DELETE' });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/webhook-endpoints/string\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"DELETE\");\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\"DELETE\", \"https://api.parcel-events.example/v1/webhook-endpoints/string\")\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/webhook-endpoints/string\")\nrequest = Net::HTTPGenericRequest.new(\"DELETE\", false, true, uri)\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]},"parameters":[{"$ref":"#/components/parameters/WebhookEndpointId"}],"patch":{"operationId":"updateWebhookEndpoint","requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookEndpointRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}},"description":"Updated endpoint"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Update a webhook endpoint","tags":["Webhook endpoints"],"x-codeSamples":[{"lang":"csharp","source":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Patch, \"https://api.parcel-events.example/v1/webhook-endpoints/string\");\nrequest.Content = new StringContent(\"{\\\"enabled\\\":true,\\\"events\\\":[\\\"pickup.completed\\\"],\\\"url\\\":\\\"https://example.com\\\"}\", Encoding.UTF8, \"application/json\");\nusing var response = await client.SendAsync(request);"},{"lang":"curl","source":"curl -X PATCH 'https://api.parcel-events.example/v1/webhook-endpoints/string' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"enabled\":true,\"events\":[\"pickup.completed\"],\"url\":\"https://example.com\"}'"},{"lang":"go","source":"package main\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tbody := strings.NewReader(`{\"enabled\":true,\"events\":[\"pickup.completed\"],\"url\":\"https://example.com\"}`)\n\treq, err := http.NewRequestWithContext(ctx, \"PATCH\", \"https://api.parcel-events.example/v1/webhook-endpoints/string\", body)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n}"},{"lang":"java","source":"var request = HttpRequest.newBuilder(URI.create(\"https://api.parcel-events.example/v1/webhook-endpoints/string\"))\n    .method(\"PATCH\", HttpRequest.BodyPublishers.noBody())\n    .header(\"Content-Type\", \"application/json\")\n    .method(\"PATCH\", HttpRequest.BodyPublishers.ofString(\"{\\\"enabled\\\":true,\\\"events\\\":[\\\"pickup.completed\\\"],\\\"url\\\":\\\"https://example.com\\\"}\"))\n    .build();\nvar response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());"},{"lang":"javascript-fetch","source":"const response = await fetch('https://api.parcel-events.example/v1/webhook-endpoints/string', {\n  method: 'PATCH',\n  headers: { 'Content-Type': 'application/json' },\n  body: JSON.stringify({\"enabled\":true,\"events\":[\"pickup.completed\"],\"url\":\"https://example.com\"}),\n});\nconst data = await response.json();"},{"lang":"node","source":"const response = await fetch('https://api.parcel-events.example/v1/webhook-endpoints/string', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: \"{\\\"enabled\\\":true,\\\"events\\\":[\\\"pickup.completed\\\"],\\\"url\\\":\\\"https://example.com\\\"}\" });\nconsole.log(await response.json());"},{"lang":"php","source":"<?php\n$request = curl_init(\"https://api.parcel-events.example/v1/webhook-endpoints/string\");\ncurl_setopt($request, CURLOPT_CUSTOMREQUEST, \"PATCH\");\ncurl_setopt($request, CURLOPT_POSTFIELDS, \"{\\\"enabled\\\":true,\\\"events\\\":[\\\"pickup.completed\\\"],\\\"url\\\":\\\"https://example.com\\\"}\");\ncurl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);\n$response = curl_exec($request);\ncurl_close($request);"},{"lang":"python","source":"import requests\n\nresponse = requests.request(\n    \"PATCH\",\n    \"https://api.parcel-events.example/v1/webhook-endpoints/string\",\n    headers={\"Content-Type\": \"application/json\"},\n    data='{\"enabled\":true,\"events\":[\"pickup.completed\"],\"url\":\"https://example.com\"}',\n)\nprint(response.json())"},{"lang":"ruby","source":"require 'net/http'\n\nuri = URI(\"https://api.parcel-events.example/v1/webhook-endpoints/string\")\nrequest = Net::HTTPGenericRequest.new(\"PATCH\", true, true, uri)\nrequest['Content-Type'] = 'application/json'\nrequest.body = \"{\\\"enabled\\\":true,\\\"events\\\":[\\\"pickup.completed\\\"],\\\"url\\\":\\\"https://example.com\\\"}\"\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }"}]}}},"security":[{"ApiKey":[]},{"BearerToken":[]}],"servers":[{"description":"Synthetic production","url":"https://api.parcel-events.example"},{"description":"Synthetic test environment","url":"https://sandbox.parcel-events.example"}],"tags":[{"name":"Shipments"},{"name":"Tracking"},{"name":"Labels"},{"name":"Pickups"},{"name":"Rates"},{"name":"Webhook endpoints"}],"webhooks":{"shipmentStatusChanged":{"post":{"operationId":"shipmentStatusChanged","parameters":[{"in":"header","name":"Parcel-Event-Id","required":true,"schema":{"type":"string"}},{"in":"header","name":"Parcel-Event-Signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentStatusEvent"}}},"required":true},"responses":{"204":{"description":"Event accepted"}},"summary":"Shipment status changed"}}}}