[{"data":1,"prerenderedAt":898},["ShallowReactive",2],{"docs-page-\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fshipment-usage":3,"nav-docs_en-api_en":217,"surround-\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fshipment-usage":895},{"document":4,"collection":215,"isFallback":216,"defaultLocalePath":199},{"id":5,"title":6,"audience":7,"body":8,"boost":185,"date":185,"description":186,"extension":187,"keywords":188,"meta":197,"navigation":198,"path":199,"question_examples":200,"related":204,"seo":205,"slug":185,"stem":206,"summary":207,"synonyms":208,"__hash__":214},"docs_en\u002Fen\u002F2.api\u002F3.webhooks\u002F1.guides\u002F7.shipment-usage.md","Shipment usage","api",{"type":9,"value":10,"toc":176},"minimark",[11,21,26,29,42,53,63,77,81,88,100,120,124,127,133,144,148,151],[12,13,14,15,20],"p",{},"The Safecube webhook monitoring system tracks a shipment from the moment it is added to an endpoint until it is removed, either by you or automatically under the ",[16,17,19],"a",{"href":18},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fauto-removal-policy","auto-removal policy",". Every monitored shipment is charged. Check the list of monitored shipments regularly to avoid overcharging; the practices below help.",[22,23,25],"h2",{"id":24},"remove-old-shipments","Remove old shipments",[12,27,28],{},"Monitor a shipment only as long as you need updates for it. Depending on your use case, stop after:",[30,31,32,36,39],"ul",{},[33,34,35],"li",{},"its arrival at the port of discharge;",[33,37,38],{},"its gate out;",[33,40,41],{},"the moment you are certain no further movement will occur.",[12,43,44,45,52],{},"To remove shipments from the monitored list, use ",[16,46,48],{"href":47},"\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment\u002Feasy-shipment-delete",[49,50,51],"code",{},"DELETE \u002Feasy-shipment",".",[12,54,55,56,62],{},"Deleting the endpoint itself, with ",[16,57,59],{"href":58},"\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-delete",[49,60,61],{},"DELETE \u002Fendpoint\u002F{endpoint_id}",", also removes every shipment attached to it from the monitored list.",[64,65,67],"callout",{"type":66},"warning",[12,68,69,70,76],{},"Disabling an endpoint, with ",[16,71,73],{"href":72},"\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-patch",[49,74,75],{},"PATCH \u002Fendpoint\u002F{endpoint_id}",", pauses the notifications but does not stop the tracking: Safecube keeps tracking its shipments, and you no longer receive their updates.",[22,78,80],{"id":79},"remove-useless-shipments","Remove useless shipments",[12,82,83,84,87],{},"Safecube starts monitoring a shipment as soon as it is added to an endpoint, and sends the ",[49,85,86],{},"shipment.added.to.endpoint"," event when it receives the first tracking information. For some shipments, no information ever arrives: the shipping line cannot be autodetected (retry with the shipping line specified), the number is incorrect, or the shipping line is not supported. As long as these shipments stay in the endpoint list, Safecube keeps trying to monitor them, and they are charged.",[12,89,90,91,94,95,99],{},"Safecube sends the ",[49,92,93],{},"shipment.in.error"," event when the first attempt to retrieve information for a shipment fails. The ",[16,96,98],{"href":97},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fadding-shipments","Adding shipments"," page details each error code.",[64,101,103,109],{"type":102},"info",[12,104,105,106,108],{},"Subscribe to ",[49,107,93],{},". When you receive it, read the error message and decide whether to:",[30,110,111,114,117],{},[33,112,113],{},"keep monitoring the shipment — not recommended, as such a shipment may never be found nor auto-removed;",[33,115,116],{},"delete the shipment;",[33,118,119],{},"delete the shipment and add it again with added or corrected data, such as a corrected number or the shipping line.",[22,121,123],{"id":122},"check-the-validity-of-new-shipments","Check the validity of new shipments",[12,125,126],{},"Container numbers are reused periodically. After a reuse, the tracking information received may belong to a new voyage instead of the expected one, and be misleading or useless.",[12,128,129,130,132],{},"Specifying the shipping line makes sure the data comes from the right source. When you receive the ",[49,131,86],{}," event, also check the data against your own records, for example:",[30,134,135,138,141],{},[33,136,137],{},"the shipping line is the expected one;",[33,139,140],{},"the date of the first event matches your internal records;",[33,142,143],{},"the port of delivery is the expected one.",[22,145,147],{"id":146},"clean-up-monthly","Clean up monthly",[12,149,150],{},"Shipments are charged by month. A monthly check at the end of each month makes sure you pay only for useful data:",[152,153,154,163,173],"ol",{},[33,155,156,157,52],{},"Retrieve every shipment of every endpoint with ",[16,158,160],{"href":159},"\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment\u002Feasy-shipment-get",[49,161,162],{},"GET \u002Feasy-shipment",[33,164,165,166,172],{},"Send a Container Tracking API request, ",[16,167,169],{"href":168},"\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fget-shipment-detail",[49,170,171],{},"GET \u002Fshipment",", for each shipment — this incurs no extra charge. Remove the shipments that return an error.",[33,174,175],{},"Check that the data of each shipment is still accurate, for example by comparing the date of the first event or the POD location, and remove the shipments that are not.",{"title":177,"searchDepth":178,"depth":178,"links":179},"",3,[180,182,183,184],{"id":24,"depth":181,"text":25},2,{"id":79,"depth":181,"text":80},{"id":122,"depth":181,"text":123},{"id":146,"depth":181,"text":147},null,"The Safecube webhook monitoring system tracks a shipment from the moment it is added to an endpoint until it is removed, either by you or automatically under the auto-removal policy. Every monitored shipment is charged. Check the list of monitored shipments regularly to avoid overcharging; the practices below help.","md",[189,190,191,192,193,194,195,93,196],"shipment usage","billing","overage","remove shipment","delete easy-shipment","disable endpoint","monthly clean up","reused container number",{},true,"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fshipment-usage",[201,202,203],"How do I stop being charged for a shipment monitored by webhooks?","Does disabling a webhook endpoint stop the tracking of its shipments?","How do I avoid webhook overages on shipments that can never be tracked?",[18,97,47,159,58],{"title":6,"description":186},"en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F7.shipment-usage","Safecube charges every shipment monitored by a webhook endpoint, by month, until it is removed — remove delivered and untrackable shipments, check the validity of new ones and clean up monthly to avoid overages.",[209,210,211,212,213],"webhook billing","tracking cost","avoid overcharging","unsubscribe shipment","stop tracking","3rLjLzIP2G90PxcHhVtUUVa1b-eH-Vxlzi1esOEb4vY","docs_en",false,{"platform":218,"api":392,"faq":747,"changelog":773},[219,240,269,290,307,320,349,366,379],{"title":220,"path":221,"stem":222,"children":223,"page":216},"Getting Started","\u002Fen\u002Fplatform\u002Fgetting-started","en\u002F1.platform\u002F1.getting-started",[224,229,232,236],{"title":225,"path":226,"stem":227,"audience":228},"Creating an account","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fcreating-an-account","en\u002F1.platform\u002F1.getting-started\u002F1.creating-an-account","platform",{"title":98,"path":230,"stem":231,"audience":228},"\u002Fen\u002Fplatform\u002Fgetting-started\u002Fadding-shipments","en\u002F1.platform\u002F1.getting-started\u002F2.adding-shipments",{"title":233,"path":234,"stem":235,"audience":228},"Supported sealines","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fsupported-sealines","en\u002F1.platform\u002F1.getting-started\u002F3.supported-sealines",{"title":237,"path":238,"stem":239,"audience":228},"Navigating the platform","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fnavigating-the-platform","en\u002F1.platform\u002F1.getting-started\u002F4.navigating-the-platform",{"title":241,"path":242,"stem":243,"children":244,"page":216},"Container Tracking","\u002Fen\u002Fplatform\u002Fcontainer-tracking","en\u002F1.platform\u002F2.container-tracking",[245,249,253,257,261,265],{"title":246,"path":247,"stem":248,"audience":228},"Shipment details","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipment-details","en\u002F1.platform\u002F2.container-tracking\u002F1.shipment-details",{"title":250,"path":251,"stem":252,"audience":228},"Shipping statuses","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipping-statuses","en\u002F1.platform\u002F2.container-tracking\u002F2.shipping-statuses",{"title":254,"path":255,"stem":256,"audience":228},"Update frequency","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fupdate-frequency","en\u002F1.platform\u002F2.container-tracking\u002F3.update-frequency",{"title":258,"path":259,"stem":260,"audience":228},"Tracking issues","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Ftracking-issues","en\u002F1.platform\u002F2.container-tracking\u002F4.tracking-issues",{"title":262,"path":263,"stem":264,"audience":228},"Sharing and export","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fsharing-and-export","en\u002F1.platform\u002F2.container-tracking\u002F5.sharing-and-export",{"title":266,"path":267,"stem":268,"audience":228},"Shipment archiving","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipment-archiving","en\u002F1.platform\u002F2.container-tracking\u002F6.shipment-archiving",{"title":270,"path":271,"stem":272,"children":273,"page":216},"Shipment Views","\u002Fen\u002Fplatform\u002Fshipment-views","en\u002F1.platform\u002F3.shipment-views",[274,278,282,286],{"title":275,"path":276,"stem":277,"audience":228},"Shipment list","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fshipment-list","en\u002F1.platform\u002F3.shipment-views\u002F1.shipment-list",{"title":279,"path":280,"stem":281,"audience":228},"Shipment list columns","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fshipment-list-columns","en\u002F1.platform\u002F3.shipment-views\u002F2.shipment-list-columns",{"title":283,"path":284,"stem":285,"audience":228},"Kanban","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fkanban","en\u002F1.platform\u002F3.shipment-views\u002F3.kanban",{"title":287,"path":288,"stem":289,"audience":228},"Calendar","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fcalendar","en\u002F1.platform\u002F3.shipment-views\u002F4.calendar",{"title":291,"path":292,"stem":293,"children":294,"page":216},"Alerts","\u002Fen\u002Fplatform\u002Falerts","en\u002F1.platform\u002F4.alerts",[295,299,303],{"title":296,"path":297,"stem":298,"audience":228},"Alerts page","\u002Fen\u002Fplatform\u002Falerts\u002Falerts-page","en\u002F1.platform\u002F4.alerts\u002F1.alerts-page",{"title":300,"path":301,"stem":302,"audience":228},"Alert management","\u002Fen\u002Fplatform\u002Falerts\u002Falert-management","en\u002F1.platform\u002F4.alerts\u002F2.alert-management",{"title":304,"path":305,"stem":306,"audience":228},"Notifications and reports","\u002Fen\u002Fplatform\u002Falerts\u002Fnotifications-and-reports","en\u002F1.platform\u002F4.alerts\u002F3.notifications-and-reports",{"title":308,"path":309,"stem":310,"children":311,"page":216},"Analytics","\u002Fen\u002Fplatform\u002Fanalytics","en\u002F1.platform\u002F5.analytics",[312,316],{"title":313,"path":314,"stem":315,"audience":228},"Performance analytics","\u002Fen\u002Fplatform\u002Fanalytics\u002Fperformance","en\u002F1.platform\u002F5.analytics\u002F1.performance",{"title":317,"path":318,"stem":319,"audience":228},"Sustainability","\u002Fen\u002Fplatform\u002Fanalytics\u002Fsustainability","en\u002F1.platform\u002F5.analytics\u002F2.sustainability",{"title":321,"path":322,"stem":323,"children":324,"page":216},"Workspace","\u002Fen\u002Fplatform\u002Fworkspace","en\u002F1.platform\u002F6.workspace",[325,329,333,337,341,345],{"title":326,"path":327,"stem":328,"audience":228},"Users and roles","\u002Fen\u002Fplatform\u002Fworkspace\u002Fusers-and-roles","en\u002F1.platform\u002F6.workspace\u002F1.users-and-roles",{"title":330,"path":331,"stem":332,"audience":228},"Teams","\u002Fen\u002Fplatform\u002Fworkspace\u002Fteams","en\u002F1.platform\u002F6.workspace\u002F2.teams",{"title":334,"path":335,"stem":336,"audience":228},"Documents","\u002Fen\u002Fplatform\u002Fworkspace\u002Fdocuments","en\u002F1.platform\u002F6.workspace\u002F3.documents",{"title":338,"path":339,"stem":340,"audience":228},"Workspace settings","\u002Fen\u002Fplatform\u002Fworkspace\u002Fworkspace-settings","en\u002F1.platform\u002F6.workspace\u002F4.workspace-settings",{"title":342,"path":343,"stem":344,"audience":228},"White label","\u002Fen\u002Fplatform\u002Fworkspace\u002Fwhite-label","en\u002F1.platform\u002F6.workspace\u002F5.white-label",{"title":346,"path":347,"stem":348,"audience":228},"Account settings","\u002Fen\u002Fplatform\u002Fworkspace\u002Faccount-settings","en\u002F1.platform\u002F6.workspace\u002F6.account-settings",{"title":350,"path":351,"stem":352,"children":353,"page":216},"Billing","\u002Fen\u002Fplatform\u002Fbilling","en\u002F1.platform\u002F7.billing",[354,358,362],{"title":355,"path":356,"stem":357,"audience":228},"Billing and payment","\u002Fen\u002Fplatform\u002Fbilling\u002Fbilling-and-payment","en\u002F1.platform\u002F7.billing\u002F1.billing-and-payment",{"title":359,"path":360,"stem":361,"audience":228},"Shipment billing","\u002Fen\u002Fplatform\u002Fbilling\u002Fshipment-billing","en\u002F1.platform\u002F7.billing\u002F2.shipment-billing",{"title":363,"path":364,"stem":365,"audience":228},"Free trial","\u002Fen\u002Fplatform\u002Fbilling\u002Ffree-trial","en\u002F1.platform\u002F7.billing\u002F3.free-trial",{"title":367,"path":368,"stem":369,"children":370,"page":216},"Developers","\u002Fen\u002Fplatform\u002Fdevelopers","en\u002F1.platform\u002F8.developers",[371,375],{"title":372,"path":373,"stem":374,"audience":228},"API credentials","\u002Fen\u002Fplatform\u002Fdevelopers\u002Fapi-credentials","en\u002F1.platform\u002F8.developers\u002F1.api-credentials",{"title":376,"path":377,"stem":378,"audience":228},"Webhooks console","\u002Fen\u002Fplatform\u002Fdevelopers\u002Fwebhooks-console","en\u002F1.platform\u002F8.developers\u002F2.webhooks-console",{"title":380,"path":381,"stem":382,"children":383,"page":216},"Integrations","\u002Fen\u002Fplatform\u002Fintegrations","en\u002F1.platform\u002F9.integrations",[384,388],{"title":385,"path":386,"stem":387,"audience":228},"Salesforce installation","\u002Fen\u002Fplatform\u002Fintegrations\u002Fsalesforce-installation","en\u002F1.platform\u002F9.integrations\u002F1.salesforce-installation",{"title":389,"path":390,"stem":391,"audience":228},"Salesforce user guide","\u002Fen\u002Fplatform\u002Fintegrations\u002Fsalesforce-user-guide","en\u002F1.platform\u002F9.integrations\u002F2.salesforce-user-guide",[393,409,480,639,674,706],{"title":220,"path":394,"stem":395,"children":396,"page":216},"\u002Fen\u002Fapi\u002Fgetting-started","en\u002F2.api\u002F1.getting-started",[397,401,405],{"title":398,"path":399,"stem":400,"audience":7},"API overview","\u002Fen\u002Fapi\u002Fgetting-started\u002Foverview","en\u002F2.api\u002F1.getting-started\u002F1.overview",{"title":402,"path":403,"stem":404,"audience":7},"Authentication","\u002Fen\u002Fapi\u002Fgetting-started\u002Fauthentication","en\u002F2.api\u002F1.getting-started\u002F2.authentication",{"title":406,"path":407,"stem":408,"audience":7},"Rate limits","\u002Fen\u002Fapi\u002Fgetting-started\u002Frate-limits","en\u002F2.api\u002F1.getting-started\u002F3.rate-limits",{"title":241,"path":410,"stem":411,"children":412,"page":216},"\u002Fen\u002Fapi\u002Fcontainer-tracking","en\u002F2.api\u002F2.container-tracking",[413,450],{"title":414,"path":415,"stem":416,"children":417,"page":216},"Guides","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides","en\u002F2.api\u002F2.container-tracking\u002F1.guides",[418,422,426,430,434,438,442,446],{"title":419,"path":420,"stem":421,"audience":7},"Getting started with the Container Tracking API","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fgetting-started","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F1.getting-started",{"title":423,"path":424,"stem":425,"audience":7},"Shipment location","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fshipment-location","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F2.shipment-location",{"title":427,"path":428,"stem":429,"audience":7},"Shipment route","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fshipment-route","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F3.shipment-route",{"title":431,"path":432,"stem":433,"audience":7},"Demurrage risk","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fdemurrage-risk","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F4.demurrage-risk",{"title":435,"path":436,"stem":437,"audience":7},"Error codes","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Ferror-codes","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F5.error-codes",{"title":439,"path":440,"stem":441,"audience":7},"Status and event codes","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fstatus-and-event-codes","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F6.status-and-event-codes",{"title":443,"path":444,"stem":445,"audience":7},"Supported shipping lines","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fsupported-sealines","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F7.supported-sealines",{"title":447,"path":448,"stem":449,"audience":7},"Sandbox and test shipments","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fsandbox","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F8.sandbox",{"title":451,"path":452,"stem":453,"children":454,"page":216},"Reference","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference","en\u002F2.api\u002F2.container-tracking\u002F2.reference",[455,460,465,470,475],{"title":456,"path":168,"stem":457,"method":458,"endpoint":459},"Retrieve shipment tracking data","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F1.get-shipment-detail","GET","\u002Fshipment",{"title":461,"path":462,"stem":463,"method":458,"endpoint":464},"Retrieve shipment tracking data in a Searates-compatible format","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fget-shipment-searates-format","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F2.get-shipment-searates-format","\u002Fshipment-format\u002Fsearates",{"title":466,"path":467,"stem":468,"method":458,"endpoint":469},"Retrieve available sealines","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fget-sea-line-details","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F3.get-sea-line-details","\u002Fsealines",{"title":471,"path":472,"stem":473,"method":458,"endpoint":474},"Retrieve your monthly usages","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fretrieve-usages","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F4.retrieve-usages","\u002Fusages",{"title":476,"path":477,"stem":478,"method":458,"endpoint":479},"Retrieve list of shipments called with the API, that usages have a minimum resolution of a month (you cant select the usage for one  week for example, the usage will automatically be for the month of the week provided)","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fretrieve-shipment-usages","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F5.retrieve-shipment-usages","\u002Fshipment-usage",{"title":481,"path":482,"stem":483,"children":484,"page":216},"Webhooks","\u002Fen\u002Fapi\u002Fwebhooks","en\u002F2.api\u002F3.webhooks",[485,519],{"title":414,"path":486,"stem":487,"children":488,"page":216},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides","en\u002F2.api\u002F3.webhooks\u002F1.guides",[489,493,497,501,503,507,511,512,516],{"title":490,"path":491,"stem":492,"audience":7},"Getting started with webhooks","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fgetting-started","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F1.getting-started",{"title":494,"path":495,"stem":496,"audience":7},"Synchronous and asynchronous tracking","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fsync-vs-async","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F2.sync-vs-async",{"title":498,"path":499,"stem":500,"audience":7},"Using webhooks as a push API","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fpush-api","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F3.push-api",{"title":98,"path":97,"stem":502,"audience":7},"en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F4.adding-shipments",{"title":504,"path":505,"stem":506,"audience":7},"Testing your webhook endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Ftesting-your-endpoint","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F5.testing-your-endpoint",{"title":508,"path":509,"stem":510,"audience":7},"Detecting and recovering webhook failures","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Ffailure-recovery","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F6.failure-recovery",{"title":6,"path":199,"stem":206,"audience":7},{"title":513,"path":514,"stem":515,"audience":7},"Webhook events","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fevents","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F8.events",{"title":517,"path":18,"stem":518,"audience":7},"Auto-removal policy","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F9.auto-removal-policy",{"title":451,"path":520,"stem":521,"children":522,"page":216},"\u002Fen\u002Fapi\u002Fwebhooks\u002Freference","en\u002F2.api\u002F3.webhooks\u002F2.reference",[523,599,620,630],{"title":524,"path":525,"stem":526,"children":527,"page":216},"Endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints",[528,534,538,543,548,552,556,561,566,571,576,581,586,590,594],{"title":529,"path":530,"stem":531,"method":532,"endpoint":533},"Create Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-create","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F1.endpoint-create","POST","\u002Fendpoint",{"title":535,"path":536,"stem":537,"method":458,"endpoint":533},"List Endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-list","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F2.endpoint-list",{"title":539,"path":540,"stem":541,"method":458,"endpoint":542},"Get Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-get","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F3.endpoint-get","\u002Fendpoint\u002F{endpoint_id}",{"title":544,"path":545,"stem":546,"method":547,"endpoint":542},"Update Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-update","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F4.endpoint-update","PUT",{"title":549,"path":58,"stem":550,"method":551,"endpoint":542},"Delete Endpoint","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F5.endpoint-delete","DELETE",{"title":553,"path":72,"stem":554,"method":555,"endpoint":542},"Patch Endpoint","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F6.endpoint-patch","PATCH",{"title":557,"path":558,"stem":559,"method":458,"endpoint":560},"Get Endpoint Secret","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-get-secret","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F7.endpoint-get-secret","\u002Fendpoint\u002F{endpoint_id}\u002Fsecret",{"title":562,"path":563,"stem":564,"method":532,"endpoint":565},"Rotate Endpoint Secret","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-rotate-secret","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F8.endpoint-rotate-secret","\u002Fendpoint\u002F{endpoint_id}\u002Fsecret\u002Frotate",{"title":567,"path":568,"stem":569,"method":458,"endpoint":570},"Endpoint Stats","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-get-stats","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F9.endpoint-get-stats","\u002Fendpoint\u002F{endpoint_id}\u002Fstats",{"title":572,"path":573,"stem":574,"method":532,"endpoint":575},"Recover Failed Webhooks","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-recover","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F10.endpoint-recover","\u002Fendpoint\u002F{endpoint_id}\u002Frecover",{"title":577,"path":578,"stem":579,"method":532,"endpoint":580},"Replay Missing Webhooks","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-replay","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F11.endpoint-replay","\u002Fendpoint\u002F{endpoint_id}\u002Freplay-missing",{"title":582,"path":583,"stem":584,"method":458,"endpoint":585},"Get Endpoint Headers","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-get-headers","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F12.endpoint-get-headers","\u002Fendpoint\u002F{endpoint_id}\u002Fheaders",{"title":587,"path":588,"stem":589,"method":547,"endpoint":585},"Update Endpoint Headers","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-update-headers","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F13.endpoint-update-headers",{"title":591,"path":592,"stem":593,"method":555,"endpoint":585},"Patch Endpoint Headers","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-patch-headers","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F14.endpoint-patch-headers",{"title":595,"path":596,"stem":597,"method":532,"endpoint":598},"Send Event Type Example Message","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-send-example","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F15.endpoint-send-example","\u002Fendpoint\u002F{endpoint_id}\u002Fsend-example",{"title":600,"path":601,"stem":602,"children":603,"page":216},"Easy Shipment","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment",[604,609,613,617],{"title":605,"path":606,"stem":607,"method":532,"endpoint":608},"Add shipments asynchronously","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment\u002Feasy-shipment-add-async","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment\u002F1.easy-shipment-add-async","\u002Feasy-shipment-asynchronous",{"title":610,"path":159,"stem":611,"method":458,"endpoint":612},"Get the list of shipments for all your endpoints","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment\u002F2.easy-shipment-get","\u002Feasy-shipment",{"title":614,"path":615,"stem":616,"method":547,"endpoint":612},"Update shipments to endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment\u002Feasy-shipment-update","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment\u002F3.easy-shipment-update",{"title":618,"path":47,"stem":619,"method":551,"endpoint":612},"Delete shipments to endpoints","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment\u002F4.easy-shipment-delete",{"title":621,"path":622,"stem":623,"children":624,"page":216},"Application","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fapplication","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F3.application",[625],{"title":626,"path":627,"stem":628,"method":458,"endpoint":629},"Get dashboard url","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fapplication\u002Fapplication-dashboard","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F3.application\u002F1.application-dashboard","\u002Fdashboard",{"title":631,"path":632,"stem":633,"children":634,"page":216},"Usages","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fusages","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F4.usages",[635],{"title":636,"path":637,"stem":638,"method":458,"endpoint":479},"Retrieve list of shipments called with the API","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fusages\u002Fretrieve-shipment-usages","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F4.usages\u002F1.retrieve-shipment-usages",{"title":640,"path":641,"stem":642,"children":643,"page":216},"Shipment Management","\u002Fen\u002Fapi\u002Fshipment-management","en\u002F2.api\u002F4.shipment-management",[644,656],{"title":414,"path":645,"stem":646,"children":647,"page":216},"\u002Fen\u002Fapi\u002Fshipment-management\u002Fguides","en\u002F2.api\u002F4.shipment-management\u002F1.guides",[648,652],{"title":649,"path":650,"stem":651,"audience":7},"Getting started with the Shipment Management API","\u002Fen\u002Fapi\u002Fshipment-management\u002Fguides\u002Fgetting-started","en\u002F2.api\u002F4.shipment-management\u002F1.guides\u002F1.getting-started",{"title":653,"path":654,"stem":655,"audience":7},"Embed a shipment in an iframe","\u002Fen\u002Fapi\u002Fshipment-management\u002Fguides\u002Fiframe-embed","en\u002F2.api\u002F4.shipment-management\u002F1.guides\u002F2.iframe-embed",{"title":451,"path":657,"stem":658,"children":659,"page":216},"\u002Fen\u002Fapi\u002Fshipment-management\u002Freference","en\u002F2.api\u002F4.shipment-management\u002F2.reference",[660,665,669],{"title":661,"path":662,"stem":663,"method":532,"endpoint":664},"Create shipments","\u002Fen\u002Fapi\u002Fshipment-management\u002Freference\u002Fcreate-shipments","en\u002F2.api\u002F4.shipment-management\u002F2.reference\u002F1.create-shipments","\u002Fpublic\u002Fshipments",{"title":666,"path":667,"stem":668,"method":551,"endpoint":664},"Delete multiple shipments","\u002Fen\u002Fapi\u002Fshipment-management\u002Freference\u002Fdelete-shipments","en\u002F2.api\u002F4.shipment-management\u002F2.reference\u002F2.delete-shipments",{"title":670,"path":671,"stem":672,"method":532,"endpoint":673},"Get multiple shipments","\u002Fen\u002Fapi\u002Fshipment-management\u002Freference\u002Fsearch-shipments","en\u002F2.api\u002F4.shipment-management\u002F2.reference\u002F3.search-shipments","\u002Fpublic\u002Fshipments\u002Fsearch",{"title":675,"path":676,"stem":677,"children":678,"page":216},"Ports Intelligence","\u002Fen\u002Fapi\u002Fports-intelligence","en\u002F2.api\u002F5.ports-intelligence",[679,687],{"title":414,"path":680,"stem":681,"children":682,"page":216},"\u002Fen\u002Fapi\u002Fports-intelligence\u002Fguides","en\u002F2.api\u002F5.ports-intelligence\u002F1.guides",[683],{"title":684,"path":685,"stem":686,"audience":7},"Port occupation","\u002Fen\u002Fapi\u002Fports-intelligence\u002Fguides\u002Fport-occupation","en\u002F2.api\u002F5.ports-intelligence\u002F1.guides\u002F1.port-occupation",{"title":451,"path":688,"stem":689,"children":690,"page":216},"\u002Fen\u002Fapi\u002Fports-intelligence\u002Freference","en\u002F2.api\u002F5.ports-intelligence\u002F2.reference",[691,696,701],{"title":692,"path":693,"stem":694,"method":458,"endpoint":695},"Search Port Details by its name or unlocode","\u002Fen\u002Fapi\u002Fports-intelligence\u002Freference\u002Fsearch-port-details","en\u002F2.api\u002F5.ports-intelligence\u002F2.reference\u002F1.search-port-details","\u002Fports\u002Fsearch",{"title":697,"path":698,"stem":699,"method":458,"endpoint":700},"Get Port Details by unlocode","\u002Fen\u002Fapi\u002Fports-intelligence\u002Freference\u002Fget-port-details","en\u002F2.api\u002F5.ports-intelligence\u002F2.reference\u002F2.get-port-details","\u002Fports\u002F{unlocode}",{"title":702,"path":703,"stem":704,"method":458,"endpoint":705},"Get Vessels in port","\u002Fen\u002Fapi\u002Fports-intelligence\u002Freference\u002Fget-vessels-in-port","en\u002F2.api\u002F5.ports-intelligence\u002F2.reference\u002F3.get-vessels-in-port","\u002Fports\u002F{unlocode}\u002Fvessels-in-port",{"title":707,"path":708,"stem":709,"children":710,"page":216},"Congestion","\u002Fen\u002Fapi\u002Fcongestion","en\u002F2.api\u002F6.congestion",[711,723],{"title":414,"path":712,"stem":713,"children":714,"page":216},"\u002Fen\u002Fapi\u002Fcongestion\u002Fguides","en\u002F2.api\u002F6.congestion\u002F1.guides",[715,719],{"title":716,"path":717,"stem":718,"audience":7},"Getting started with the Congestion API","\u002Fen\u002Fapi\u002Fcongestion\u002Fguides\u002Fgetting-started","en\u002F2.api\u002F6.congestion\u002F1.guides\u002F1.getting-started",{"title":720,"path":721,"stem":722,"audience":7},"Congestion API coverage","\u002Fen\u002Fapi\u002Fcongestion\u002Fguides\u002Fcoverage","en\u002F2.api\u002F6.congestion\u002F1.guides\u002F2.coverage",{"title":451,"path":724,"stem":725,"children":726,"page":216},"\u002Fen\u002Fapi\u002Fcongestion\u002Freference","en\u002F2.api\u002F6.congestion\u002F2.reference",[727,732,737,742],{"title":728,"path":729,"stem":730,"method":458,"endpoint":731},"Retrieve aggregated congestion data for a port","\u002Fen\u002Fapi\u002Fcongestion\u002Freference\u002Fretrieve-congestion-aggregate","en\u002F2.api\u002F6.congestion\u002F2.reference\u002F1.retrieve-congestion-aggregate","\u002Fcongestion\u002F{portCode}",{"title":733,"path":734,"stem":735,"method":532,"endpoint":736},"Retrieve aggregated congestion data for multiple ports","\u002Fen\u002Fapi\u002Fcongestion\u002Freference\u002Fretrieve-congestion-aggregate-batch","en\u002F2.api\u002F6.congestion\u002F2.reference\u002F2.retrieve-congestion-aggregate-batch","\u002Fcongestion\u002Fbatch",{"title":738,"path":739,"stem":740,"method":458,"endpoint":741},"Retrieve the current credit consumption period","\u002Fen\u002Fapi\u002Fcongestion\u002Freference\u002Fretrieve-current-consumption-period","en\u002F2.api\u002F6.congestion\u002F2.reference\u002F3.retrieve-current-consumption-period","\u002Fconsumption\u002Fcurrent-period",{"title":743,"path":744,"stem":745,"method":458,"endpoint":746},"Retrieve all credit consumption periods","\u002Fen\u002Fapi\u002Fcongestion\u002Freference\u002Fretrieve-consumption-periods","en\u002F2.api\u002F6.congestion\u002F2.reference\u002F4.retrieve-consumption-periods","\u002Fconsumption\u002Fperiods",[748,753,757,761,765,769],{"title":749,"path":750,"stem":751,"audience":752},"Getting started and scope","\u002Fen\u002Ffaq\u002Fgetting-started","en\u002F3.faq\u002F1.getting-started","faq",{"title":754,"path":755,"stem":756,"audience":752},"Tracking","\u002Fen\u002Ffaq\u002Ftracking","en\u002F3.faq\u002F2.tracking",{"title":758,"path":759,"stem":760,"audience":752},"Billing and plans","\u002Fen\u002Ffaq\u002Fbilling","en\u002F3.faq\u002F3.billing",{"title":762,"path":763,"stem":764,"audience":752},"Account and workspace","\u002Fen\u002Ffaq\u002Faccount","en\u002F3.faq\u002F4.account",{"title":766,"path":767,"stem":768,"audience":752},"API and integration","\u002Fen\u002Ffaq\u002Fapi","en\u002F3.faq\u002F5.api",{"title":770,"path":771,"stem":772,"audience":752},"Security and legal","\u002Fen\u002Ffaq\u002Fsecurity-and-legal","en\u002F3.faq\u002F6.security-and-legal",[774,779,783,787,791,795,799,803,807,811,815,819,823,827,831,835,839,843,847,851,855,859,863,867,871,875,879,883,887,891],{"title":775,"path":776,"stem":777,"audience":778},"November 2026","\u002Fen\u002Fchangelog\u002F2026-11-09","en\u002F4.changelog\u002F2026-11-09","changelog",{"title":780,"path":781,"stem":782,"audience":778},"October 2026","\u002Fen\u002Fchangelog\u002F2026-10-21","en\u002F4.changelog\u002F2026-10-21",{"title":784,"path":785,"stem":786,"audience":778},"September 2026","\u002Fen\u002Fchangelog\u002F2026-09-09","en\u002F4.changelog\u002F2026-09-09",{"title":788,"path":789,"stem":790,"audience":778},"August 2026","\u002Fen\u002Fchangelog\u002F2026-08-19","en\u002F4.changelog\u002F2026-08-19",{"title":792,"path":793,"stem":794,"audience":778},"July 2026","\u002Fen\u002Fchangelog\u002F2026-07-30","en\u002F4.changelog\u002F2026-07-30",{"title":796,"path":797,"stem":798,"audience":778},"June 2026","\u002Fen\u002Fchangelog\u002F2026-06-16","en\u002F4.changelog\u002F2026-06-16",{"title":800,"path":801,"stem":802,"audience":778},"April 2026","\u002Fen\u002Fchangelog\u002F2026-04-29","en\u002F4.changelog\u002F2026-04-29",{"title":804,"path":805,"stem":806,"audience":778},"March 2026","\u002Fen\u002Fchangelog\u002F2026-03-31","en\u002F4.changelog\u002F2026-03-31",{"title":808,"path":809,"stem":810,"audience":778},"February 2026","\u002Fen\u002Fchangelog\u002F2026-02-25","en\u002F4.changelog\u002F2026-02-25",{"title":812,"path":813,"stem":814,"audience":778},"January 2026","\u002Fen\u002Fchangelog\u002F2026-01-27","en\u002F4.changelog\u002F2026-01-27",{"title":816,"path":817,"stem":818,"audience":778},"December 2025","\u002Fen\u002Fchangelog\u002F2025-12-15","en\u002F4.changelog\u002F2025-12-15",{"title":820,"path":821,"stem":822,"audience":778},"November 2025","\u002Fen\u002Fchangelog\u002F2025-11-28","en\u002F4.changelog\u002F2025-11-28",{"title":824,"path":825,"stem":826,"audience":778},"September 2025","\u002Fen\u002Fchangelog\u002F2025-09-04","en\u002F4.changelog\u002F2025-09-04",{"title":828,"path":829,"stem":830,"audience":778},"August 2025","\u002Fen\u002Fchangelog\u002F2025-08-20","en\u002F4.changelog\u002F2025-08-20",{"title":832,"path":833,"stem":834,"audience":778},"July 2025","\u002Fen\u002Fchangelog\u002F2025-07-21","en\u002F4.changelog\u002F2025-07-21",{"title":836,"path":837,"stem":838,"audience":778},"June 2025","\u002Fen\u002Fchangelog\u002F2025-06-23","en\u002F4.changelog\u002F2025-06-23",{"title":840,"path":841,"stem":842,"audience":778},"May 2025","\u002Fen\u002Fchangelog\u002F2025-05-26","en\u002F4.changelog\u002F2025-05-26",{"title":844,"path":845,"stem":846,"audience":778},"April 2025","\u002Fen\u002Fchangelog\u002F2025-04-28","en\u002F4.changelog\u002F2025-04-28",{"title":848,"path":849,"stem":850,"audience":778},"March 2025","\u002Fen\u002Fchangelog\u002F2025-03-31","en\u002F4.changelog\u002F2025-03-31",{"title":852,"path":853,"stem":854,"audience":778},"February 2025","\u002Fen\u002Fchangelog\u002F2025-02-26","en\u002F4.changelog\u002F2025-02-26",{"title":856,"path":857,"stem":858,"audience":778},"January 2025","\u002Fen\u002Fchangelog\u002F2025-01-30","en\u002F4.changelog\u002F2025-01-30",{"title":860,"path":861,"stem":862,"audience":778},"December 2024","\u002Fen\u002Fchangelog\u002F2024-12-19","en\u002F4.changelog\u002F2024-12-19",{"title":864,"path":865,"stem":866,"audience":778},"November 2024","\u002Fen\u002Fchangelog\u002F2024-11-28","en\u002F4.changelog\u002F2024-11-28",{"title":868,"path":869,"stem":870,"audience":778},"October 2024","\u002Fen\u002Fchangelog\u002F2024-10-30","en\u002F4.changelog\u002F2024-10-30",{"title":872,"path":873,"stem":874,"audience":778},"September 2024","\u002Fen\u002Fchangelog\u002F2024-09-23","en\u002F4.changelog\u002F2024-09-23",{"title":876,"path":877,"stem":878,"audience":778},"August 2024","\u002Fen\u002Fchangelog\u002F2024-08-30","en\u002F4.changelog\u002F2024-08-30",{"title":880,"path":881,"stem":882,"audience":778},"July 2024","\u002Fen\u002Fchangelog\u002F2024-07-29","en\u002F4.changelog\u002F2024-07-29",{"title":884,"path":885,"stem":886,"audience":778},"June 2024","\u002Fen\u002Fchangelog\u002F2024-06-25","en\u002F4.changelog\u002F2024-06-25",{"title":888,"path":889,"stem":890,"audience":778},"May 2024","\u002Fen\u002Fchangelog\u002F2024-05-31","en\u002F4.changelog\u002F2024-05-31",{"title":892,"path":893,"stem":894,"audience":778},"April 2024","\u002Fen\u002Fchangelog\u002F2024-04-30","en\u002F4.changelog\u002F2024-04-30",[896,897],{"title":508,"path":509,"stem":510,"children":-1},{"title":513,"path":514,"stem":515,"children":-1},1794931507107]