[{"data":1,"prerenderedAt":888},["ShallowReactive",2],{"docs-page-\u002Fen\u002Ffaq\u002Fapi":3,"nav-docs_en-api_en":212,"surround-\u002Fen\u002Ffaq\u002Fapi":885},{"document":4,"collection":210,"isFallback":211,"defaultLocalePath":194},{"id":5,"title":6,"audience":7,"body":8,"boost":180,"date":180,"description":168,"extension":181,"keywords":182,"meta":192,"navigation":193,"path":194,"question_examples":195,"related":196,"seo":197,"slug":180,"stem":198,"summary":199,"synonyms":200,"__hash__":209},"docs_en\u002Fen\u002F3.faq\u002F5.api.md","API and integration","faq",{"type":9,"value":10,"toc":167},"minimark",[11,16,37,46,50,58,65,69,72,79,83,90,97,101,108,113,117,120,127,135,160],[12,13,15],"h2",{"id":14},"where-do-i-find-my-api-key","Where do I find my API key?",[17,18,19,20,24,25,28,29,32,33,36],"p",{},"In the Safecube web application, open ",[21,22,23],"strong",{},"Developers"," in the sidebar, then the ",[21,26,27],{},"API Credentials"," tab, open to Admins and Owners on every plan. ",[21,30,31],{},"Copy key"," copies the key, even while it is masked. A workspace has a single key: ",[21,34,35],{},"Rotate API key"," replaces it, and the old key stops working at once.",[17,38,39,40,45],{},"The tab is described in ",[41,42,44],"a",{"href":43},"\u002Fen\u002Fplatform\u002Fdevelopers\u002Fapi-credentials","API credentials",".",[12,47,49],{"id":48},"what-is-the-api-rate-limit","What is the API rate limit?",[17,51,52,53,57],{},"The current limit is 10 requests per 10 seconds per API key, counted across every endpoint, and it is subject to change. A request above it receives ",[54,55,56],"code",{},"429 Too Many Requests"," and can be retried once the 10-second window has moved on. To track many containers, webhooks avoid polling the API for each one.",[17,59,60,61,45],{},"The limit is described in ",[41,62,64],{"href":63},"\u002Fen\u002Fapi\u002Fgetting-started\u002Frate-limits","Rate limits",[12,66,68],{"id":67},"should-i-poll-the-api-or-use-webhooks","Should I poll the API or use webhooks?",[17,70,71],{},"The Container Tracking API, which your application calls on demand, suits low volumes and occasional queries. The Webhooks API suits high volumes: you add your shipments to a tracking list once, and Safecube sends an event to your endpoint when new tracking data is available. For larger applications, Safecube recommends webhooks.",[17,73,74,75,45],{},"Both approaches are compared in ",[41,76,78],{"href":77},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fsync-vs-async","Synchronous and asynchronous tracking",[12,80,82],{"id":81},"do-shipments-created-through-the-api-appear-in-the-app","Do shipments created through the API appear in the app?",[17,84,85,86,89],{},"Shipments created with the Shipment Management API do: ",[54,87,88],{},"POST \u002Fpublic\u002Fshipments"," creates them in your Safecube workspace, asynchronously, and an email gives the creation status and any errors once the process is complete. The same API deletes shipments and returns their public sharing links.",[17,91,92,93,45],{},"The API is described in ",[41,94,96],{"href":95},"\u002Fen\u002Fapi\u002Fshipment-management\u002Fguides\u002Fgetting-started","Getting started with the Shipment Management API",[12,98,100],{"id":99},"is-the-shipment-management-api-included-in-my-plan","Is the Shipment Management API included in my plan?",[17,102,103,104,107],{},"Yes. The Shipment Management API is included in every Safecube plan, with no access to request, and is authenticated with the workspace's API key in the ",[54,105,106],{},"API_KEY"," header. Only iframe embedding of a public sharing link stays on request.",[17,109,110,111,45],{},"Access is described in ",[41,112,96],{"href":95},[12,114,116],{"id":115},"can-i-embed-the-tracking-in-an-iframe","Can I embed the tracking in an iframe?",[17,118,119],{},"Yes, on request. Iframe embedding is part of the white label pack: Safecube must authorize the domain of the pages that embed the iframe, so the request to the Safecube team names that domain. The embedded page is the public sharing link of a shipment, returned by the Shipment Management API: read-only, with no login, in a full view or a details, map or event list view.",[17,121,122,123,45],{},"The request and the integration are described in ",[41,124,126],{"href":125},"\u002Fen\u002Fapi\u002Fshipment-management\u002Fguides\u002Fiframe-embed","Embed a shipment in an iframe",[12,128,130,131,134],{"id":129},"what-does-auto_cant_find_info-mean","What does ",[54,132,133],{},"AUTO_CANT_FIND_INFO"," mean?",[17,136,137,138,141,142,144,145,148,149,152,153,155,156,159],{},"The Container Tracking API answers ",[54,139,140],{},"400"," with ",[54,143,133],{}," when no information could be autodetected for the shipment number. Retry the request with both the ",[54,146,147],{},"sealine"," parameter, the SCAC code of the carrier, and the ",[54,150,151],{},"shipmentType"," parameter. A request ending in a ",[54,154,140],{}," or a ",[54,157,158],{},"500"," error is not charged.",[17,161,162,163,45],{},"Every error is listed in ",[41,164,166],{"href":165},"\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Ferror-codes","Error codes",{"title":168,"searchDepth":169,"depth":169,"links":170},"",3,[171,173,174,175,176,177,178],{"id":14,"depth":172,"text":15},2,{"id":48,"depth":172,"text":49},{"id":67,"depth":172,"text":68},{"id":81,"depth":172,"text":82},{"id":99,"depth":172,"text":100},{"id":115,"depth":172,"text":116},{"id":129,"depth":172,"text":179},"What does AUTO_CANT_FIND_INFO mean?",null,"md",[183,184,185,186,187,188,189,190,191,133],"api key","rate limit",429,"webhooks","polling","shipment management api","iframe","embed","error codes",{},true,"\u002Fen\u002Ffaq\u002Fapi",[],[43,63,77,95,125,165],{"title":6,"description":168},"en\u002F3.faq\u002F5.api","Short answers to the questions asked most often about the Safecube API, from the API key and the rate limit to polling or webhooks, the Shipment Management API, iframe embedding and the AUTO_CANT_FIND_INFO error, each one linking to its reference page.",[201,202,203,204,205,206,207,208],"api token","request limit","push or pull","sync vs async","api access","premium api","embed tracking","api error","UQ_hhzsT8im-lduQnLhb08WXNIvd3rdW8Tm3pykLAjw","docs_en",false,{"platform":213,"api":385,"faq":741,"changelog":763},[214,236,265,286,303,316,345,362,372],{"title":215,"path":216,"stem":217,"children":218,"page":211},"Getting Started","\u002Fen\u002Fplatform\u002Fgetting-started","en\u002F1.platform\u002F1.getting-started",[219,224,228,232],{"title":220,"path":221,"stem":222,"audience":223},"Creating an account","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fcreating-an-account","en\u002F1.platform\u002F1.getting-started\u002F1.creating-an-account","platform",{"title":225,"path":226,"stem":227,"audience":223},"Adding shipments","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fadding-shipments","en\u002F1.platform\u002F1.getting-started\u002F2.adding-shipments",{"title":229,"path":230,"stem":231,"audience":223},"Supported sealines","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fsupported-sealines","en\u002F1.platform\u002F1.getting-started\u002F3.supported-sealines",{"title":233,"path":234,"stem":235,"audience":223},"Navigating the platform","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fnavigating-the-platform","en\u002F1.platform\u002F1.getting-started\u002F4.navigating-the-platform",{"title":237,"path":238,"stem":239,"children":240,"page":211},"Container Tracking","\u002Fen\u002Fplatform\u002Fcontainer-tracking","en\u002F1.platform\u002F2.container-tracking",[241,245,249,253,257,261],{"title":242,"path":243,"stem":244,"audience":223},"Shipment details","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipment-details","en\u002F1.platform\u002F2.container-tracking\u002F1.shipment-details",{"title":246,"path":247,"stem":248,"audience":223},"Shipping statuses","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipping-statuses","en\u002F1.platform\u002F2.container-tracking\u002F2.shipping-statuses",{"title":250,"path":251,"stem":252,"audience":223},"Update frequency","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fupdate-frequency","en\u002F1.platform\u002F2.container-tracking\u002F3.update-frequency",{"title":254,"path":255,"stem":256,"audience":223},"Tracking issues","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Ftracking-issues","en\u002F1.platform\u002F2.container-tracking\u002F4.tracking-issues",{"title":258,"path":259,"stem":260,"audience":223},"Sharing and export","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fsharing-and-export","en\u002F1.platform\u002F2.container-tracking\u002F5.sharing-and-export",{"title":262,"path":263,"stem":264,"audience":223},"Shipment archiving","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipment-archiving","en\u002F1.platform\u002F2.container-tracking\u002F6.shipment-archiving",{"title":266,"path":267,"stem":268,"children":269,"page":211},"Shipment Views","\u002Fen\u002Fplatform\u002Fshipment-views","en\u002F1.platform\u002F3.shipment-views",[270,274,278,282],{"title":271,"path":272,"stem":273,"audience":223},"Shipment list","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fshipment-list","en\u002F1.platform\u002F3.shipment-views\u002F1.shipment-list",{"title":275,"path":276,"stem":277,"audience":223},"Shipment list columns","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fshipment-list-columns","en\u002F1.platform\u002F3.shipment-views\u002F2.shipment-list-columns",{"title":279,"path":280,"stem":281,"audience":223},"Kanban","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fkanban","en\u002F1.platform\u002F3.shipment-views\u002F3.kanban",{"title":283,"path":284,"stem":285,"audience":223},"Calendar","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fcalendar","en\u002F1.platform\u002F3.shipment-views\u002F4.calendar",{"title":287,"path":288,"stem":289,"children":290,"page":211},"Alerts","\u002Fen\u002Fplatform\u002Falerts","en\u002F1.platform\u002F4.alerts",[291,295,299],{"title":292,"path":293,"stem":294,"audience":223},"Alerts page","\u002Fen\u002Fplatform\u002Falerts\u002Falerts-page","en\u002F1.platform\u002F4.alerts\u002F1.alerts-page",{"title":296,"path":297,"stem":298,"audience":223},"Alert management","\u002Fen\u002Fplatform\u002Falerts\u002Falert-management","en\u002F1.platform\u002F4.alerts\u002F2.alert-management",{"title":300,"path":301,"stem":302,"audience":223},"Notifications and reports","\u002Fen\u002Fplatform\u002Falerts\u002Fnotifications-and-reports","en\u002F1.platform\u002F4.alerts\u002F3.notifications-and-reports",{"title":304,"path":305,"stem":306,"children":307,"page":211},"Analytics","\u002Fen\u002Fplatform\u002Fanalytics","en\u002F1.platform\u002F5.analytics",[308,312],{"title":309,"path":310,"stem":311,"audience":223},"Performance analytics","\u002Fen\u002Fplatform\u002Fanalytics\u002Fperformance","en\u002F1.platform\u002F5.analytics\u002F1.performance",{"title":313,"path":314,"stem":315,"audience":223},"Sustainability","\u002Fen\u002Fplatform\u002Fanalytics\u002Fsustainability","en\u002F1.platform\u002F5.analytics\u002F2.sustainability",{"title":317,"path":318,"stem":319,"children":320,"page":211},"Workspace","\u002Fen\u002Fplatform\u002Fworkspace","en\u002F1.platform\u002F6.workspace",[321,325,329,333,337,341],{"title":322,"path":323,"stem":324,"audience":223},"Users and roles","\u002Fen\u002Fplatform\u002Fworkspace\u002Fusers-and-roles","en\u002F1.platform\u002F6.workspace\u002F1.users-and-roles",{"title":326,"path":327,"stem":328,"audience":223},"Teams","\u002Fen\u002Fplatform\u002Fworkspace\u002Fteams","en\u002F1.platform\u002F6.workspace\u002F2.teams",{"title":330,"path":331,"stem":332,"audience":223},"Documents","\u002Fen\u002Fplatform\u002Fworkspace\u002Fdocuments","en\u002F1.platform\u002F6.workspace\u002F3.documents",{"title":334,"path":335,"stem":336,"audience":223},"Workspace settings","\u002Fen\u002Fplatform\u002Fworkspace\u002Fworkspace-settings","en\u002F1.platform\u002F6.workspace\u002F4.workspace-settings",{"title":338,"path":339,"stem":340,"audience":223},"White label","\u002Fen\u002Fplatform\u002Fworkspace\u002Fwhite-label","en\u002F1.platform\u002F6.workspace\u002F5.white-label",{"title":342,"path":343,"stem":344,"audience":223},"Account settings","\u002Fen\u002Fplatform\u002Fworkspace\u002Faccount-settings","en\u002F1.platform\u002F6.workspace\u002F6.account-settings",{"title":346,"path":347,"stem":348,"children":349,"page":211},"Billing","\u002Fen\u002Fplatform\u002Fbilling","en\u002F1.platform\u002F7.billing",[350,354,358],{"title":351,"path":352,"stem":353,"audience":223},"Billing and payment","\u002Fen\u002Fplatform\u002Fbilling\u002Fbilling-and-payment","en\u002F1.platform\u002F7.billing\u002F1.billing-and-payment",{"title":355,"path":356,"stem":357,"audience":223},"Shipment billing","\u002Fen\u002Fplatform\u002Fbilling\u002Fshipment-billing","en\u002F1.platform\u002F7.billing\u002F2.shipment-billing",{"title":359,"path":360,"stem":361,"audience":223},"Free trial","\u002Fen\u002Fplatform\u002Fbilling\u002Ffree-trial","en\u002F1.platform\u002F7.billing\u002F3.free-trial",{"title":23,"path":363,"stem":364,"children":365,"page":211},"\u002Fen\u002Fplatform\u002Fdevelopers","en\u002F1.platform\u002F8.developers",[366,368],{"title":44,"path":43,"stem":367,"audience":223},"en\u002F1.platform\u002F8.developers\u002F1.api-credentials",{"title":369,"path":370,"stem":371,"audience":223},"Webhooks console","\u002Fen\u002Fplatform\u002Fdevelopers\u002Fwebhooks-console","en\u002F1.platform\u002F8.developers\u002F2.webhooks-console",{"title":373,"path":374,"stem":375,"children":376,"page":211},"Integrations","\u002Fen\u002Fplatform\u002Fintegrations","en\u002F1.platform\u002F9.integrations",[377,381],{"title":378,"path":379,"stem":380,"audience":223},"Salesforce installation","\u002Fen\u002Fplatform\u002Fintegrations\u002Fsalesforce-installation","en\u002F1.platform\u002F9.integrations\u002F1.salesforce-installation",{"title":382,"path":383,"stem":384,"audience":223},"Salesforce user guide","\u002Fen\u002Fplatform\u002Fintegrations\u002Fsalesforce-user-guide","en\u002F1.platform\u002F9.integrations\u002F2.salesforce-user-guide",[386,401,471,637,668,700],{"title":215,"path":387,"stem":388,"children":389,"page":211},"\u002Fen\u002Fapi\u002Fgetting-started","en\u002F2.api\u002F1.getting-started",[390,395,399],{"title":391,"path":392,"stem":393,"audience":394},"API overview","\u002Fen\u002Fapi\u002Fgetting-started\u002Foverview","en\u002F2.api\u002F1.getting-started\u002F1.overview","api",{"title":396,"path":397,"stem":398,"audience":394},"Authentication","\u002Fen\u002Fapi\u002Fgetting-started\u002Fauthentication","en\u002F2.api\u002F1.getting-started\u002F2.authentication",{"title":64,"path":63,"stem":400,"audience":394},"en\u002F2.api\u002F1.getting-started\u002F3.rate-limits",{"title":237,"path":402,"stem":403,"children":404,"page":211},"\u002Fen\u002Fapi\u002Fcontainer-tracking","en\u002F2.api\u002F2.container-tracking",[405,440],{"title":406,"path":407,"stem":408,"children":409,"page":211},"Guides","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides","en\u002F2.api\u002F2.container-tracking\u002F1.guides",[410,414,418,422,426,428,432,436],{"title":411,"path":412,"stem":413,"audience":394},"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":415,"path":416,"stem":417,"audience":394},"Shipment location","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fshipment-location","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F2.shipment-location",{"title":419,"path":420,"stem":421,"audience":394},"Shipment route","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fshipment-route","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F3.shipment-route",{"title":423,"path":424,"stem":425,"audience":394},"Demurrage risk","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fdemurrage-risk","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F4.demurrage-risk",{"title":166,"path":165,"stem":427,"audience":394},"en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F5.error-codes",{"title":429,"path":430,"stem":431,"audience":394},"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":433,"path":434,"stem":435,"audience":394},"Supported shipping lines","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fsupported-sealines","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F7.supported-sealines",{"title":437,"path":438,"stem":439,"audience":394},"Sandbox and test shipments","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fsandbox","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F8.sandbox",{"title":441,"path":442,"stem":443,"children":444,"page":211},"Reference","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference","en\u002F2.api\u002F2.container-tracking\u002F2.reference",[445,451,456,461,466],{"title":446,"path":447,"stem":448,"method":449,"endpoint":450},"Retrieve shipment tracking data","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fget-shipment-detail","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F1.get-shipment-detail","GET","\u002Fshipment",{"title":452,"path":453,"stem":454,"method":449,"endpoint":455},"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":457,"path":458,"stem":459,"method":449,"endpoint":460},"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":462,"path":463,"stem":464,"method":449,"endpoint":465},"Retrieve your monthly usages","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fretrieve-usages","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F4.retrieve-usages","\u002Fusages",{"title":467,"path":468,"stem":469,"method":449,"endpoint":470},"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":472,"path":473,"stem":474,"children":475,"page":211},"Webhooks","\u002Fen\u002Fapi\u002Fwebhooks","en\u002F2.api\u002F3.webhooks",[476,513],{"title":406,"path":477,"stem":478,"children":479,"page":211},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides","en\u002F2.api\u002F3.webhooks\u002F1.guides",[480,484,486,490,493,497,501,505,509],{"title":481,"path":482,"stem":483,"audience":394},"Getting started with webhooks","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fgetting-started","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F1.getting-started",{"title":78,"path":77,"stem":485,"audience":394},"en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F2.sync-vs-async",{"title":487,"path":488,"stem":489,"audience":394},"Using webhooks as a push API","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fpush-api","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F3.push-api",{"title":225,"path":491,"stem":492,"audience":394},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fadding-shipments","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F4.adding-shipments",{"title":494,"path":495,"stem":496,"audience":394},"Testing your webhook endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Ftesting-your-endpoint","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F5.testing-your-endpoint",{"title":498,"path":499,"stem":500,"audience":394},"Detecting and recovering webhook failures","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Ffailure-recovery","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F6.failure-recovery",{"title":502,"path":503,"stem":504,"audience":394},"Shipment usage","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fshipment-usage","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F7.shipment-usage",{"title":506,"path":507,"stem":508,"audience":394},"Webhook events","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fevents","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F8.events",{"title":510,"path":511,"stem":512,"audience":394},"Auto-removal policy","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fauto-removal-policy","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F9.auto-removal-policy",{"title":441,"path":514,"stem":515,"children":516,"page":211},"\u002Fen\u002Fapi\u002Fwebhooks\u002Freference","en\u002F2.api\u002F3.webhooks\u002F2.reference",[517,595,618,628],{"title":518,"path":519,"stem":520,"children":521,"page":211},"Endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints",[522,528,532,537,542,547,552,557,562,567,572,577,582,586,590],{"title":523,"path":524,"stem":525,"method":526,"endpoint":527},"Create Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-create","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F1.endpoint-create","POST","\u002Fendpoint",{"title":529,"path":530,"stem":531,"method":449,"endpoint":527},"List Endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-list","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F2.endpoint-list",{"title":533,"path":534,"stem":535,"method":449,"endpoint":536},"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":538,"path":539,"stem":540,"method":541,"endpoint":536},"Update Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-update","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F4.endpoint-update","PUT",{"title":543,"path":544,"stem":545,"method":546,"endpoint":536},"Delete Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-delete","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F5.endpoint-delete","DELETE",{"title":548,"path":549,"stem":550,"method":551,"endpoint":536},"Patch Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-patch","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F6.endpoint-patch","PATCH",{"title":553,"path":554,"stem":555,"method":449,"endpoint":556},"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":558,"path":559,"stem":560,"method":526,"endpoint":561},"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":563,"path":564,"stem":565,"method":449,"endpoint":566},"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":568,"path":569,"stem":570,"method":526,"endpoint":571},"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":573,"path":574,"stem":575,"method":526,"endpoint":576},"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":578,"path":579,"stem":580,"method":449,"endpoint":581},"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":583,"path":584,"stem":585,"method":541,"endpoint":581},"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":587,"path":588,"stem":589,"method":551,"endpoint":581},"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":591,"path":592,"stem":593,"method":526,"endpoint":594},"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":596,"path":597,"stem":598,"children":599,"page":211},"Easy Shipment","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment",[600,605,610,614],{"title":601,"path":602,"stem":603,"method":526,"endpoint":604},"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":606,"path":607,"stem":608,"method":449,"endpoint":609},"Get the list of shipments for all your endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment\u002Feasy-shipment-get","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment\u002F2.easy-shipment-get","\u002Feasy-shipment",{"title":611,"path":612,"stem":613,"method":541,"endpoint":609},"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":615,"path":616,"stem":617,"method":546,"endpoint":609},"Delete shipments to endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment\u002Feasy-shipment-delete","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment\u002F4.easy-shipment-delete",{"title":619,"path":620,"stem":621,"children":622,"page":211},"Application","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fapplication","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F3.application",[623],{"title":624,"path":625,"stem":626,"method":449,"endpoint":627},"Get dashboard url","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fapplication\u002Fapplication-dashboard","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F3.application\u002F1.application-dashboard","\u002Fdashboard",{"title":629,"path":630,"stem":631,"children":632,"page":211},"Usages","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fusages","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F4.usages",[633],{"title":634,"path":635,"stem":636,"method":449,"endpoint":470},"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":638,"path":639,"stem":640,"children":641,"page":211},"Shipment Management","\u002Fen\u002Fapi\u002Fshipment-management","en\u002F2.api\u002F4.shipment-management",[642,650],{"title":406,"path":643,"stem":644,"children":645,"page":211},"\u002Fen\u002Fapi\u002Fshipment-management\u002Fguides","en\u002F2.api\u002F4.shipment-management\u002F1.guides",[646,648],{"title":96,"path":95,"stem":647,"audience":394},"en\u002F2.api\u002F4.shipment-management\u002F1.guides\u002F1.getting-started",{"title":126,"path":125,"stem":649,"audience":394},"en\u002F2.api\u002F4.shipment-management\u002F1.guides\u002F2.iframe-embed",{"title":441,"path":651,"stem":652,"children":653,"page":211},"\u002Fen\u002Fapi\u002Fshipment-management\u002Freference","en\u002F2.api\u002F4.shipment-management\u002F2.reference",[654,659,663],{"title":655,"path":656,"stem":657,"method":526,"endpoint":658},"Create shipments","\u002Fen\u002Fapi\u002Fshipment-management\u002Freference\u002Fcreate-shipments","en\u002F2.api\u002F4.shipment-management\u002F2.reference\u002F1.create-shipments","\u002Fpublic\u002Fshipments",{"title":660,"path":661,"stem":662,"method":546,"endpoint":658},"Delete multiple shipments","\u002Fen\u002Fapi\u002Fshipment-management\u002Freference\u002Fdelete-shipments","en\u002F2.api\u002F4.shipment-management\u002F2.reference\u002F2.delete-shipments",{"title":664,"path":665,"stem":666,"method":526,"endpoint":667},"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":669,"path":670,"stem":671,"children":672,"page":211},"Ports Intelligence","\u002Fen\u002Fapi\u002Fports-intelligence","en\u002F2.api\u002F5.ports-intelligence",[673,681],{"title":406,"path":674,"stem":675,"children":676,"page":211},"\u002Fen\u002Fapi\u002Fports-intelligence\u002Fguides","en\u002F2.api\u002F5.ports-intelligence\u002F1.guides",[677],{"title":678,"path":679,"stem":680,"audience":394},"Port occupation","\u002Fen\u002Fapi\u002Fports-intelligence\u002Fguides\u002Fport-occupation","en\u002F2.api\u002F5.ports-intelligence\u002F1.guides\u002F1.port-occupation",{"title":441,"path":682,"stem":683,"children":684,"page":211},"\u002Fen\u002Fapi\u002Fports-intelligence\u002Freference","en\u002F2.api\u002F5.ports-intelligence\u002F2.reference",[685,690,695],{"title":686,"path":687,"stem":688,"method":449,"endpoint":689},"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":691,"path":692,"stem":693,"method":449,"endpoint":694},"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":696,"path":697,"stem":698,"method":449,"endpoint":699},"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":701,"path":702,"stem":703,"children":704,"page":211},"Congestion","\u002Fen\u002Fapi\u002Fcongestion","en\u002F2.api\u002F6.congestion",[705,717],{"title":406,"path":706,"stem":707,"children":708,"page":211},"\u002Fen\u002Fapi\u002Fcongestion\u002Fguides","en\u002F2.api\u002F6.congestion\u002F1.guides",[709,713],{"title":710,"path":711,"stem":712,"audience":394},"Getting started with the Congestion API","\u002Fen\u002Fapi\u002Fcongestion\u002Fguides\u002Fgetting-started","en\u002F2.api\u002F6.congestion\u002F1.guides\u002F1.getting-started",{"title":714,"path":715,"stem":716,"audience":394},"Congestion API coverage","\u002Fen\u002Fapi\u002Fcongestion\u002Fguides\u002Fcoverage","en\u002F2.api\u002F6.congestion\u002F1.guides\u002F2.coverage",{"title":441,"path":718,"stem":719,"children":720,"page":211},"\u002Fen\u002Fapi\u002Fcongestion\u002Freference","en\u002F2.api\u002F6.congestion\u002F2.reference",[721,726,731,736],{"title":722,"path":723,"stem":724,"method":449,"endpoint":725},"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":727,"path":728,"stem":729,"method":526,"endpoint":730},"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":732,"path":733,"stem":734,"method":449,"endpoint":735},"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":737,"path":738,"stem":739,"method":449,"endpoint":740},"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",[742,746,750,754,758,759],{"title":743,"path":744,"stem":745,"audience":7},"Getting started and scope","\u002Fen\u002Ffaq\u002Fgetting-started","en\u002F3.faq\u002F1.getting-started",{"title":747,"path":748,"stem":749,"audience":7},"Tracking","\u002Fen\u002Ffaq\u002Ftracking","en\u002F3.faq\u002F2.tracking",{"title":751,"path":752,"stem":753,"audience":7},"Billing and plans","\u002Fen\u002Ffaq\u002Fbilling","en\u002F3.faq\u002F3.billing",{"title":755,"path":756,"stem":757,"audience":7},"Account and workspace","\u002Fen\u002Ffaq\u002Faccount","en\u002F3.faq\u002F4.account",{"title":6,"path":194,"stem":198,"audience":7},{"title":760,"path":761,"stem":762,"audience":7},"Security and legal","\u002Fen\u002Ffaq\u002Fsecurity-and-legal","en\u002F3.faq\u002F6.security-and-legal",[764,769,773,777,781,785,789,793,797,801,805,809,813,817,821,825,829,833,837,841,845,849,853,857,861,865,869,873,877,881],{"title":765,"path":766,"stem":767,"audience":768},"November 2026","\u002Fen\u002Fchangelog\u002F2026-11-09","en\u002F4.changelog\u002F2026-11-09","changelog",{"title":770,"path":771,"stem":772,"audience":768},"October 2026","\u002Fen\u002Fchangelog\u002F2026-10-21","en\u002F4.changelog\u002F2026-10-21",{"title":774,"path":775,"stem":776,"audience":768},"September 2026","\u002Fen\u002Fchangelog\u002F2026-09-09","en\u002F4.changelog\u002F2026-09-09",{"title":778,"path":779,"stem":780,"audience":768},"August 2026","\u002Fen\u002Fchangelog\u002F2026-08-19","en\u002F4.changelog\u002F2026-08-19",{"title":782,"path":783,"stem":784,"audience":768},"July 2026","\u002Fen\u002Fchangelog\u002F2026-07-30","en\u002F4.changelog\u002F2026-07-30",{"title":786,"path":787,"stem":788,"audience":768},"June 2026","\u002Fen\u002Fchangelog\u002F2026-06-16","en\u002F4.changelog\u002F2026-06-16",{"title":790,"path":791,"stem":792,"audience":768},"April 2026","\u002Fen\u002Fchangelog\u002F2026-04-29","en\u002F4.changelog\u002F2026-04-29",{"title":794,"path":795,"stem":796,"audience":768},"March 2026","\u002Fen\u002Fchangelog\u002F2026-03-31","en\u002F4.changelog\u002F2026-03-31",{"title":798,"path":799,"stem":800,"audience":768},"February 2026","\u002Fen\u002Fchangelog\u002F2026-02-25","en\u002F4.changelog\u002F2026-02-25",{"title":802,"path":803,"stem":804,"audience":768},"January 2026","\u002Fen\u002Fchangelog\u002F2026-01-27","en\u002F4.changelog\u002F2026-01-27",{"title":806,"path":807,"stem":808,"audience":768},"December 2025","\u002Fen\u002Fchangelog\u002F2025-12-15","en\u002F4.changelog\u002F2025-12-15",{"title":810,"path":811,"stem":812,"audience":768},"November 2025","\u002Fen\u002Fchangelog\u002F2025-11-28","en\u002F4.changelog\u002F2025-11-28",{"title":814,"path":815,"stem":816,"audience":768},"September 2025","\u002Fen\u002Fchangelog\u002F2025-09-04","en\u002F4.changelog\u002F2025-09-04",{"title":818,"path":819,"stem":820,"audience":768},"August 2025","\u002Fen\u002Fchangelog\u002F2025-08-20","en\u002F4.changelog\u002F2025-08-20",{"title":822,"path":823,"stem":824,"audience":768},"July 2025","\u002Fen\u002Fchangelog\u002F2025-07-21","en\u002F4.changelog\u002F2025-07-21",{"title":826,"path":827,"stem":828,"audience":768},"June 2025","\u002Fen\u002Fchangelog\u002F2025-06-23","en\u002F4.changelog\u002F2025-06-23",{"title":830,"path":831,"stem":832,"audience":768},"May 2025","\u002Fen\u002Fchangelog\u002F2025-05-26","en\u002F4.changelog\u002F2025-05-26",{"title":834,"path":835,"stem":836,"audience":768},"April 2025","\u002Fen\u002Fchangelog\u002F2025-04-28","en\u002F4.changelog\u002F2025-04-28",{"title":838,"path":839,"stem":840,"audience":768},"March 2025","\u002Fen\u002Fchangelog\u002F2025-03-31","en\u002F4.changelog\u002F2025-03-31",{"title":842,"path":843,"stem":844,"audience":768},"February 2025","\u002Fen\u002Fchangelog\u002F2025-02-26","en\u002F4.changelog\u002F2025-02-26",{"title":846,"path":847,"stem":848,"audience":768},"January 2025","\u002Fen\u002Fchangelog\u002F2025-01-30","en\u002F4.changelog\u002F2025-01-30",{"title":850,"path":851,"stem":852,"audience":768},"December 2024","\u002Fen\u002Fchangelog\u002F2024-12-19","en\u002F4.changelog\u002F2024-12-19",{"title":854,"path":855,"stem":856,"audience":768},"November 2024","\u002Fen\u002Fchangelog\u002F2024-11-28","en\u002F4.changelog\u002F2024-11-28",{"title":858,"path":859,"stem":860,"audience":768},"October 2024","\u002Fen\u002Fchangelog\u002F2024-10-30","en\u002F4.changelog\u002F2024-10-30",{"title":862,"path":863,"stem":864,"audience":768},"September 2024","\u002Fen\u002Fchangelog\u002F2024-09-23","en\u002F4.changelog\u002F2024-09-23",{"title":866,"path":867,"stem":868,"audience":768},"August 2024","\u002Fen\u002Fchangelog\u002F2024-08-30","en\u002F4.changelog\u002F2024-08-30",{"title":870,"path":871,"stem":872,"audience":768},"July 2024","\u002Fen\u002Fchangelog\u002F2024-07-29","en\u002F4.changelog\u002F2024-07-29",{"title":874,"path":875,"stem":876,"audience":768},"June 2024","\u002Fen\u002Fchangelog\u002F2024-06-25","en\u002F4.changelog\u002F2024-06-25",{"title":878,"path":879,"stem":880,"audience":768},"May 2024","\u002Fen\u002Fchangelog\u002F2024-05-31","en\u002F4.changelog\u002F2024-05-31",{"title":882,"path":883,"stem":884,"audience":768},"April 2024","\u002Fen\u002Fchangelog\u002F2024-04-30","en\u002F4.changelog\u002F2024-04-30",[886,887],{"title":755,"path":756,"stem":757,"children":-1},{"title":760,"path":761,"stem":762,"children":-1},1794931464666]