[{"data":1,"prerenderedAt":998},["ShallowReactive",2],{"docs-page-\u002Fen\u002Fplatform\u002Fdevelopers\u002Fapi-credentials":3,"nav-docs_en-api_en":319,"surround-\u002Fen\u002Fplatform\u002Fdevelopers\u002Fapi-credentials":995},{"document":4,"collection":317,"isFallback":318,"defaultLocalePath":299},{"id":5,"title":6,"audience":7,"body":8,"boost":287,"date":287,"description":288,"extension":289,"keywords":290,"meta":297,"navigation":298,"path":299,"question_examples":300,"related":304,"seo":306,"slug":287,"stem":307,"summary":308,"synonyms":309,"__hash__":316},"docs_en\u002Fen\u002F1.platform\u002F8.developers\u002F1.api-credentials.md","API credentials","platform",{"type":9,"value":10,"toc":276},"minimark",[11,24,29,87,104,108,135,146,151,154,160,175,179,182,185,188,211,215,218,229,233,253,260,264],[12,13,14,15,19,20,23],"p",{},"The ",[16,17,18],"strong",{},"API Credentials"," tab of the ",[16,21,22],{},"Developers"," page shows the API key of your workspace. Your applications, your ERP or TMS, and the Salesforce integration send this key with every request to the Safecube API. A workspace has a single key: the tab shows it, copies it and replaces it.",[25,26,28],"h2",{"id":27},"who-can-open-api-credentials","Who can open API Credentials",[30,31,32,48],"table",{},[33,34,35],"thead",{},[36,37,38,42,45],"tr",{},[39,40,41],"th",{},"Gesture",[39,43,44],{},"Minimum role",[39,46,47],{},"Plan",[49,50,51,69,78],"tbody",{},[36,52,53,63,66],{},[54,55,56,57,59,60,62],"td",{},"Open ",[16,58,22],{}," and the ",[16,61,18],{}," tab",[54,64,65],{},"Admin",[54,67,68],{},"Every plan",[36,70,71,74,76],{},[54,72,73],{},"View and copy the key",[54,75,65],{},[54,77,68],{},[36,79,80,83,85],{},[54,81,82],{},"Rotate the key",[54,84,65],{},[54,86,68],{},[12,88,89,90,92,93,97,98,103],{},"An Editor or a Viewer does not see ",[16,91,22],{}," in the sidebar, and a link to ",[94,95,96],"code",{},"\u002Fapi\u002Fcredentials"," takes them to the access denied page. Roles are described in ",[99,100,102],"a",{"href":101},"\u002Fen\u002Fplatform\u002Fworkspace\u002Fusers-and-roles","Users and roles",".",[25,105,107],{"id":106},"open-api-credentials","Open API Credentials",[109,110,111,121],"ol",{},[112,113,114,115,117,118,103],"li",{},"Select ",[16,116,22],{}," in the sidebar. When the sidebar is collapsed, its icon reads ",[16,119,120],{},"API Access",[112,122,123,124,126,127,130,131,103],{},"The page opens on the ",[16,125,18],{}," tab. The ",[16,128,129],{},"Webhooks"," tab next to it is described in ",[99,132,134],{"href":133},"\u002Fen\u002Fplatform\u002Fdevelopers\u002Fwebhooks-console","Webhooks console",[12,136,137,138,141,142,145],{},"The address ",[94,139,140],{},"https:\u002F\u002Fapp.safecube.ai\u002Fapi\u002Fcredentials"," opens the tab directly, and any other address under ",[94,143,144],{},"\u002Fapi"," leads to it. When the key cannot be loaded, the toast \"Failed to retrieve API credentials. Please try again later.\" appears and the app shows an error page.",[147,148],"screenshot",{"alt":149,"id":150},"API Credentials tab with the masked API key, the Rotate API key button and the two documentation cards","shared\u002Fapi-credentials--default",[25,152,73],{"id":153},"view-and-copy-the-key",[12,155,14,156,159],{},[16,157,158],{},"API Key"," card reads \"This key must be kept confidential\". The key is masked by default.",[109,161,162,169],{},[112,163,164,165,168],{},"Select the eye button, ",[16,166,167],{},"Display key",", to show the key in clear. Select it again to mask it.",[112,170,114,171,174],{},[16,172,173],{},"Copy key"," to copy the key to the clipboard. The button copies the full key even while it is masked, and shows no confirmation message.",[147,176],{"alt":177,"id":178},"API Key card with the key displayed in clear after selecting Display key","shared\u002Fapi-credentials--key-visible",[12,180,181],{},"The key gives access to the data of your whole workspace. Keep it on your servers, never in a web page, a shared document or a public code repository.",[25,183,82],{"id":184},"rotate-the-key",[12,186,187],{},"Rotating replaces the key with a new one. The current key is invalidated at once, with no grace period: every application, script or integration that still sends it, Salesforce included, stops working until you give it the new key. Webhooks already set up keep delivering their events.",[109,189,190,195,201],{},[112,191,114,192,103],{},[16,193,194],{},"Rotate API key",[112,196,14,197,200],{},[16,198,199],{},"Warning: API Key Rotation"," dialog reads \"This action is irreversible. Your current API key will be permanently invalidated and any application still using it will stop working immediately.\".",[112,202,114,203,206,207,210],{},[16,204,205],{},"Rotate"," to confirm, or ",[16,208,209],{},"Cancel"," to keep the current key.",[147,212],{"alt":213,"id":214},"Warning: API Key Rotation dialog with the Cancel and Rotate buttons","shared\u002Fmodal-rotate-api--default",[12,216,217],{},"On success, the dialog closes, the toast \"Your API key has been rotated successfully.\" appears and the card shows the new key. Copy it and update every application that used the old one.",[12,219,220,221,224,225,228],{},"On failure, the toast \"Failed to rotate API key. Please try again later.\" appears and the dialog shows ",[16,222,223],{},"Server error"," with ",[16,226,227],{},"Retry",". The current key stays valid.",[25,230,232],{"id":231},"use-the-key","Use the key",[12,234,235,236,239,240,244,245,248,249,252],{},"The tab does not test the key. How to send it with a request, in the ",[94,237,238],{},"API_KEY"," header, is described in the ",[99,241,243],{"href":242},"\u002Fen\u002Fapi\u002Fgetting-started\u002Fauthentication","Authentication"," guide of the API documentation. The ",[16,246,247],{},"Reference documentation"," and ",[16,250,251],{},"Quick start guide"," cards of the tab open the API documentation in a new tab.",[12,254,255,256,103],{},"Short answers to frequent API questions, such as the rate limit or the choice between polling and webhooks, are in the ",[99,257,259],{"href":258},"\u002Fen\u002Ffaq\u002Fapi","API and integration FAQ",[25,261,263],{"id":262},"limits","Limits",[265,266,267,270,273],"ul",{},[112,268,269],{},"A workspace has one key: the tab does not create a second key, name a key or show its creation date.",[112,271,272],{},"The tab keeps no history of the previous keys, and a rotated key cannot be restored.",[112,274,275],{},"Rotating does not update the key in your applications or in Salesforce: paste the new key there yourself.",{"title":277,"searchDepth":278,"depth":278,"links":279},"",3,[280,282,283,284,285,286],{"id":27,"depth":281,"text":28},2,{"id":106,"depth":281,"text":107},{"id":153,"depth":281,"text":73},{"id":184,"depth":281,"text":82},{"id":231,"depth":281,"text":232},{"id":262,"depth":281,"text":263},null,"The API Credentials tab of the Developers page shows the API key of your workspace. Your applications, your ERP or TMS, and the Salesforce integration send this key with every request to the Safecube API. A workspace has a single key: the tab shows it, copies it and replaces it.","md",[291,292,293,294,295,296],"api key","api credentials","rotate api key","copy api key","developers","regenerate key",{},true,"\u002Fen\u002Fplatform\u002Fdevelopers\u002Fapi-credentials",[301,302,303],"Where do I find my Safecube API key?","What happens to my integrations when I rotate the API key?","Why can't I see the Developers page?",[242,133,305,101],"\u002Fen\u002Fplatform\u002Fintegrations\u002Fsalesforce-installation",{"title":6,"description":288},"en\u002F1.platform\u002F8.developers\u002F1.api-credentials","The API Credentials tab of the Developers page shows the single API key of a Safecube workspace to Admins and Owners, who can copy it or rotate it, the old key stopping working at once.",[310,311,312,313,314,315],"api token","access key","secret key","new api key","reset api key","api access","eGh3jId4LXXNqkLQfZ52AhjbP1bA1iBgtRjqw2sC3Bc","docs_en",false,{"platform":320,"api":485,"faq":848,"changelog":873},[321,342,371,392,409,422,449,466,473],{"title":322,"path":323,"stem":324,"children":325,"page":318},"Getting Started","\u002Fen\u002Fplatform\u002Fgetting-started","en\u002F1.platform\u002F1.getting-started",[326,330,334,338],{"title":327,"path":328,"stem":329,"audience":7},"Creating an account","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fcreating-an-account","en\u002F1.platform\u002F1.getting-started\u002F1.creating-an-account",{"title":331,"path":332,"stem":333,"audience":7},"Adding shipments","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fadding-shipments","en\u002F1.platform\u002F1.getting-started\u002F2.adding-shipments",{"title":335,"path":336,"stem":337,"audience":7},"Supported sealines","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fsupported-sealines","en\u002F1.platform\u002F1.getting-started\u002F3.supported-sealines",{"title":339,"path":340,"stem":341,"audience":7},"Navigating the platform","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fnavigating-the-platform","en\u002F1.platform\u002F1.getting-started\u002F4.navigating-the-platform",{"title":343,"path":344,"stem":345,"children":346,"page":318},"Container Tracking","\u002Fen\u002Fplatform\u002Fcontainer-tracking","en\u002F1.platform\u002F2.container-tracking",[347,351,355,359,363,367],{"title":348,"path":349,"stem":350,"audience":7},"Shipment details","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipment-details","en\u002F1.platform\u002F2.container-tracking\u002F1.shipment-details",{"title":352,"path":353,"stem":354,"audience":7},"Shipping statuses","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipping-statuses","en\u002F1.platform\u002F2.container-tracking\u002F2.shipping-statuses",{"title":356,"path":357,"stem":358,"audience":7},"Update frequency","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fupdate-frequency","en\u002F1.platform\u002F2.container-tracking\u002F3.update-frequency",{"title":360,"path":361,"stem":362,"audience":7},"Tracking issues","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Ftracking-issues","en\u002F1.platform\u002F2.container-tracking\u002F4.tracking-issues",{"title":364,"path":365,"stem":366,"audience":7},"Sharing and export","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fsharing-and-export","en\u002F1.platform\u002F2.container-tracking\u002F5.sharing-and-export",{"title":368,"path":369,"stem":370,"audience":7},"Shipment archiving","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipment-archiving","en\u002F1.platform\u002F2.container-tracking\u002F6.shipment-archiving",{"title":372,"path":373,"stem":374,"children":375,"page":318},"Shipment Views","\u002Fen\u002Fplatform\u002Fshipment-views","en\u002F1.platform\u002F3.shipment-views",[376,380,384,388],{"title":377,"path":378,"stem":379,"audience":7},"Shipment list","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fshipment-list","en\u002F1.platform\u002F3.shipment-views\u002F1.shipment-list",{"title":381,"path":382,"stem":383,"audience":7},"Shipment list columns","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fshipment-list-columns","en\u002F1.platform\u002F3.shipment-views\u002F2.shipment-list-columns",{"title":385,"path":386,"stem":387,"audience":7},"Kanban","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fkanban","en\u002F1.platform\u002F3.shipment-views\u002F3.kanban",{"title":389,"path":390,"stem":391,"audience":7},"Calendar","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fcalendar","en\u002F1.platform\u002F3.shipment-views\u002F4.calendar",{"title":393,"path":394,"stem":395,"children":396,"page":318},"Alerts","\u002Fen\u002Fplatform\u002Falerts","en\u002F1.platform\u002F4.alerts",[397,401,405],{"title":398,"path":399,"stem":400,"audience":7},"Alerts page","\u002Fen\u002Fplatform\u002Falerts\u002Falerts-page","en\u002F1.platform\u002F4.alerts\u002F1.alerts-page",{"title":402,"path":403,"stem":404,"audience":7},"Alert management","\u002Fen\u002Fplatform\u002Falerts\u002Falert-management","en\u002F1.platform\u002F4.alerts\u002F2.alert-management",{"title":406,"path":407,"stem":408,"audience":7},"Notifications and reports","\u002Fen\u002Fplatform\u002Falerts\u002Fnotifications-and-reports","en\u002F1.platform\u002F4.alerts\u002F3.notifications-and-reports",{"title":410,"path":411,"stem":412,"children":413,"page":318},"Analytics","\u002Fen\u002Fplatform\u002Fanalytics","en\u002F1.platform\u002F5.analytics",[414,418],{"title":415,"path":416,"stem":417,"audience":7},"Performance analytics","\u002Fen\u002Fplatform\u002Fanalytics\u002Fperformance","en\u002F1.platform\u002F5.analytics\u002F1.performance",{"title":419,"path":420,"stem":421,"audience":7},"Sustainability","\u002Fen\u002Fplatform\u002Fanalytics\u002Fsustainability","en\u002F1.platform\u002F5.analytics\u002F2.sustainability",{"title":423,"path":424,"stem":425,"children":426,"page":318},"Workspace","\u002Fen\u002Fplatform\u002Fworkspace","en\u002F1.platform\u002F6.workspace",[427,429,433,437,441,445],{"title":102,"path":101,"stem":428,"audience":7},"en\u002F1.platform\u002F6.workspace\u002F1.users-and-roles",{"title":430,"path":431,"stem":432,"audience":7},"Teams","\u002Fen\u002Fplatform\u002Fworkspace\u002Fteams","en\u002F1.platform\u002F6.workspace\u002F2.teams",{"title":434,"path":435,"stem":436,"audience":7},"Documents","\u002Fen\u002Fplatform\u002Fworkspace\u002Fdocuments","en\u002F1.platform\u002F6.workspace\u002F3.documents",{"title":438,"path":439,"stem":440,"audience":7},"Workspace settings","\u002Fen\u002Fplatform\u002Fworkspace\u002Fworkspace-settings","en\u002F1.platform\u002F6.workspace\u002F4.workspace-settings",{"title":442,"path":443,"stem":444,"audience":7},"White label","\u002Fen\u002Fplatform\u002Fworkspace\u002Fwhite-label","en\u002F1.platform\u002F6.workspace\u002F5.white-label",{"title":446,"path":447,"stem":448,"audience":7},"Account settings","\u002Fen\u002Fplatform\u002Fworkspace\u002Faccount-settings","en\u002F1.platform\u002F6.workspace\u002F6.account-settings",{"title":450,"path":451,"stem":452,"children":453,"page":318},"Billing","\u002Fen\u002Fplatform\u002Fbilling","en\u002F1.platform\u002F7.billing",[454,458,462],{"title":455,"path":456,"stem":457,"audience":7},"Billing and payment","\u002Fen\u002Fplatform\u002Fbilling\u002Fbilling-and-payment","en\u002F1.platform\u002F7.billing\u002F1.billing-and-payment",{"title":459,"path":460,"stem":461,"audience":7},"Shipment billing","\u002Fen\u002Fplatform\u002Fbilling\u002Fshipment-billing","en\u002F1.platform\u002F7.billing\u002F2.shipment-billing",{"title":463,"path":464,"stem":465,"audience":7},"Free trial","\u002Fen\u002Fplatform\u002Fbilling\u002Ffree-trial","en\u002F1.platform\u002F7.billing\u002F3.free-trial",{"title":22,"path":467,"stem":468,"children":469,"page":318},"\u002Fen\u002Fplatform\u002Fdevelopers","en\u002F1.platform\u002F8.developers",[470,471],{"title":6,"path":299,"stem":307,"audience":7},{"title":134,"path":133,"stem":472,"audience":7},"en\u002F1.platform\u002F8.developers\u002F2.webhooks-console",{"title":474,"path":475,"stem":476,"children":477,"page":318},"Integrations","\u002Fen\u002Fplatform\u002Fintegrations","en\u002F1.platform\u002F9.integrations",[478,481],{"title":479,"path":305,"stem":480,"audience":7},"Salesforce installation","en\u002F1.platform\u002F9.integrations\u002F1.salesforce-installation",{"title":482,"path":483,"stem":484,"audience":7},"Salesforce user guide","\u002Fen\u002Fplatform\u002Fintegrations\u002Fsalesforce-user-guide","en\u002F1.platform\u002F9.integrations\u002F2.salesforce-user-guide",[486,501,573,740,775,807],{"title":322,"path":487,"stem":488,"children":489,"page":318},"\u002Fen\u002Fapi\u002Fgetting-started","en\u002F2.api\u002F1.getting-started",[490,495,497],{"title":491,"path":492,"stem":493,"audience":494},"API overview","\u002Fen\u002Fapi\u002Fgetting-started\u002Foverview","en\u002F2.api\u002F1.getting-started\u002F1.overview","api",{"title":243,"path":242,"stem":496,"audience":494},"en\u002F2.api\u002F1.getting-started\u002F2.authentication",{"title":498,"path":499,"stem":500,"audience":494},"Rate limits","\u002Fen\u002Fapi\u002Fgetting-started\u002Frate-limits","en\u002F2.api\u002F1.getting-started\u002F3.rate-limits",{"title":343,"path":502,"stem":503,"children":504,"page":318},"\u002Fen\u002Fapi\u002Fcontainer-tracking","en\u002F2.api\u002F2.container-tracking",[505,542],{"title":506,"path":507,"stem":508,"children":509,"page":318},"Guides","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides","en\u002F2.api\u002F2.container-tracking\u002F1.guides",[510,514,518,522,526,530,534,538],{"title":511,"path":512,"stem":513,"audience":494},"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":515,"path":516,"stem":517,"audience":494},"Shipment location","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fshipment-location","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F2.shipment-location",{"title":519,"path":520,"stem":521,"audience":494},"Shipment route","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fshipment-route","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F3.shipment-route",{"title":523,"path":524,"stem":525,"audience":494},"Demurrage risk","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fdemurrage-risk","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F4.demurrage-risk",{"title":527,"path":528,"stem":529,"audience":494},"Error codes","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Ferror-codes","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F5.error-codes",{"title":531,"path":532,"stem":533,"audience":494},"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":535,"path":536,"stem":537,"audience":494},"Supported shipping lines","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fsupported-sealines","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F7.supported-sealines",{"title":539,"path":540,"stem":541,"audience":494},"Sandbox and test shipments","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fsandbox","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F8.sandbox",{"title":543,"path":544,"stem":545,"children":546,"page":318},"Reference","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference","en\u002F2.api\u002F2.container-tracking\u002F2.reference",[547,553,558,563,568],{"title":548,"path":549,"stem":550,"method":551,"endpoint":552},"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":554,"path":555,"stem":556,"method":551,"endpoint":557},"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":559,"path":560,"stem":561,"method":551,"endpoint":562},"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":564,"path":565,"stem":566,"method":551,"endpoint":567},"Retrieve your monthly usages","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fretrieve-usages","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F4.retrieve-usages","\u002Fusages",{"title":569,"path":570,"stem":571,"method":551,"endpoint":572},"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":129,"path":574,"stem":575,"children":576,"page":318},"\u002Fen\u002Fapi\u002Fwebhooks","en\u002F2.api\u002F3.webhooks",[577,616],{"title":506,"path":578,"stem":579,"children":580,"page":318},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides","en\u002F2.api\u002F3.webhooks\u002F1.guides",[581,585,589,593,596,600,604,608,612],{"title":582,"path":583,"stem":584,"audience":494},"Getting started with webhooks","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fgetting-started","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F1.getting-started",{"title":586,"path":587,"stem":588,"audience":494},"Synchronous and asynchronous tracking","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fsync-vs-async","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F2.sync-vs-async",{"title":590,"path":591,"stem":592,"audience":494},"Using webhooks as a push API","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fpush-api","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F3.push-api",{"title":331,"path":594,"stem":595,"audience":494},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fadding-shipments","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F4.adding-shipments",{"title":597,"path":598,"stem":599,"audience":494},"Testing your webhook endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Ftesting-your-endpoint","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F5.testing-your-endpoint",{"title":601,"path":602,"stem":603,"audience":494},"Detecting and recovering webhook failures","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Ffailure-recovery","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F6.failure-recovery",{"title":605,"path":606,"stem":607,"audience":494},"Shipment usage","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fshipment-usage","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F7.shipment-usage",{"title":609,"path":610,"stem":611,"audience":494},"Webhook events","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fevents","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F8.events",{"title":613,"path":614,"stem":615,"audience":494},"Auto-removal policy","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fauto-removal-policy","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F9.auto-removal-policy",{"title":543,"path":617,"stem":618,"children":619,"page":318},"\u002Fen\u002Fapi\u002Fwebhooks\u002Freference","en\u002F2.api\u002F3.webhooks\u002F2.reference",[620,698,721,731],{"title":621,"path":622,"stem":623,"children":624,"page":318},"Endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints",[625,631,635,640,645,650,655,660,665,670,675,680,685,689,693],{"title":626,"path":627,"stem":628,"method":629,"endpoint":630},"Create Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-create","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F1.endpoint-create","POST","\u002Fendpoint",{"title":632,"path":633,"stem":634,"method":551,"endpoint":630},"List Endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-list","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F2.endpoint-list",{"title":636,"path":637,"stem":638,"method":551,"endpoint":639},"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":641,"path":642,"stem":643,"method":644,"endpoint":639},"Update Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-update","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F4.endpoint-update","PUT",{"title":646,"path":647,"stem":648,"method":649,"endpoint":639},"Delete Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-delete","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F5.endpoint-delete","DELETE",{"title":651,"path":652,"stem":653,"method":654,"endpoint":639},"Patch Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-patch","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F6.endpoint-patch","PATCH",{"title":656,"path":657,"stem":658,"method":551,"endpoint":659},"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":661,"path":662,"stem":663,"method":629,"endpoint":664},"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":666,"path":667,"stem":668,"method":551,"endpoint":669},"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":671,"path":672,"stem":673,"method":629,"endpoint":674},"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":676,"path":677,"stem":678,"method":629,"endpoint":679},"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":681,"path":682,"stem":683,"method":551,"endpoint":684},"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":686,"path":687,"stem":688,"method":644,"endpoint":684},"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":690,"path":691,"stem":692,"method":654,"endpoint":684},"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":694,"path":695,"stem":696,"method":629,"endpoint":697},"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":699,"path":700,"stem":701,"children":702,"page":318},"Easy Shipment","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment",[703,708,713,717],{"title":704,"path":705,"stem":706,"method":629,"endpoint":707},"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":709,"path":710,"stem":711,"method":551,"endpoint":712},"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":714,"path":715,"stem":716,"method":644,"endpoint":712},"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":718,"path":719,"stem":720,"method":649,"endpoint":712},"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":722,"path":723,"stem":724,"children":725,"page":318},"Application","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fapplication","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F3.application",[726],{"title":727,"path":728,"stem":729,"method":551,"endpoint":730},"Get dashboard url","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fapplication\u002Fapplication-dashboard","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F3.application\u002F1.application-dashboard","\u002Fdashboard",{"title":732,"path":733,"stem":734,"children":735,"page":318},"Usages","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fusages","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F4.usages",[736],{"title":737,"path":738,"stem":739,"method":551,"endpoint":572},"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":741,"path":742,"stem":743,"children":744,"page":318},"Shipment Management","\u002Fen\u002Fapi\u002Fshipment-management","en\u002F2.api\u002F4.shipment-management",[745,757],{"title":506,"path":746,"stem":747,"children":748,"page":318},"\u002Fen\u002Fapi\u002Fshipment-management\u002Fguides","en\u002F2.api\u002F4.shipment-management\u002F1.guides",[749,753],{"title":750,"path":751,"stem":752,"audience":494},"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":754,"path":755,"stem":756,"audience":494},"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":543,"path":758,"stem":759,"children":760,"page":318},"\u002Fen\u002Fapi\u002Fshipment-management\u002Freference","en\u002F2.api\u002F4.shipment-management\u002F2.reference",[761,766,770],{"title":762,"path":763,"stem":764,"method":629,"endpoint":765},"Create shipments","\u002Fen\u002Fapi\u002Fshipment-management\u002Freference\u002Fcreate-shipments","en\u002F2.api\u002F4.shipment-management\u002F2.reference\u002F1.create-shipments","\u002Fpublic\u002Fshipments",{"title":767,"path":768,"stem":769,"method":649,"endpoint":765},"Delete multiple shipments","\u002Fen\u002Fapi\u002Fshipment-management\u002Freference\u002Fdelete-shipments","en\u002F2.api\u002F4.shipment-management\u002F2.reference\u002F2.delete-shipments",{"title":771,"path":772,"stem":773,"method":629,"endpoint":774},"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":776,"path":777,"stem":778,"children":779,"page":318},"Ports Intelligence","\u002Fen\u002Fapi\u002Fports-intelligence","en\u002F2.api\u002F5.ports-intelligence",[780,788],{"title":506,"path":781,"stem":782,"children":783,"page":318},"\u002Fen\u002Fapi\u002Fports-intelligence\u002Fguides","en\u002F2.api\u002F5.ports-intelligence\u002F1.guides",[784],{"title":785,"path":786,"stem":787,"audience":494},"Port occupation","\u002Fen\u002Fapi\u002Fports-intelligence\u002Fguides\u002Fport-occupation","en\u002F2.api\u002F5.ports-intelligence\u002F1.guides\u002F1.port-occupation",{"title":543,"path":789,"stem":790,"children":791,"page":318},"\u002Fen\u002Fapi\u002Fports-intelligence\u002Freference","en\u002F2.api\u002F5.ports-intelligence\u002F2.reference",[792,797,802],{"title":793,"path":794,"stem":795,"method":551,"endpoint":796},"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":798,"path":799,"stem":800,"method":551,"endpoint":801},"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":803,"path":804,"stem":805,"method":551,"endpoint":806},"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":808,"path":809,"stem":810,"children":811,"page":318},"Congestion","\u002Fen\u002Fapi\u002Fcongestion","en\u002F2.api\u002F6.congestion",[812,824],{"title":506,"path":813,"stem":814,"children":815,"page":318},"\u002Fen\u002Fapi\u002Fcongestion\u002Fguides","en\u002F2.api\u002F6.congestion\u002F1.guides",[816,820],{"title":817,"path":818,"stem":819,"audience":494},"Getting started with the Congestion API","\u002Fen\u002Fapi\u002Fcongestion\u002Fguides\u002Fgetting-started","en\u002F2.api\u002F6.congestion\u002F1.guides\u002F1.getting-started",{"title":821,"path":822,"stem":823,"audience":494},"Congestion API coverage","\u002Fen\u002Fapi\u002Fcongestion\u002Fguides\u002Fcoverage","en\u002F2.api\u002F6.congestion\u002F1.guides\u002F2.coverage",{"title":543,"path":825,"stem":826,"children":827,"page":318},"\u002Fen\u002Fapi\u002Fcongestion\u002Freference","en\u002F2.api\u002F6.congestion\u002F2.reference",[828,833,838,843],{"title":829,"path":830,"stem":831,"method":551,"endpoint":832},"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":834,"path":835,"stem":836,"method":629,"endpoint":837},"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":839,"path":840,"stem":841,"method":551,"endpoint":842},"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":844,"path":845,"stem":846,"method":551,"endpoint":847},"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",[849,854,858,862,866,869],{"title":850,"path":851,"stem":852,"audience":853},"Getting started and scope","\u002Fen\u002Ffaq\u002Fgetting-started","en\u002F3.faq\u002F1.getting-started","faq",{"title":855,"path":856,"stem":857,"audience":853},"Tracking","\u002Fen\u002Ffaq\u002Ftracking","en\u002F3.faq\u002F2.tracking",{"title":859,"path":860,"stem":861,"audience":853},"Billing and plans","\u002Fen\u002Ffaq\u002Fbilling","en\u002F3.faq\u002F3.billing",{"title":863,"path":864,"stem":865,"audience":853},"Account and workspace","\u002Fen\u002Ffaq\u002Faccount","en\u002F3.faq\u002F4.account",{"title":867,"path":258,"stem":868,"audience":853},"API and integration","en\u002F3.faq\u002F5.api",{"title":870,"path":871,"stem":872,"audience":853},"Security and legal","\u002Fen\u002Ffaq\u002Fsecurity-and-legal","en\u002F3.faq\u002F6.security-and-legal",[874,879,883,887,891,895,899,903,907,911,915,919,923,927,931,935,939,943,947,951,955,959,963,967,971,975,979,983,987,991],{"title":875,"path":876,"stem":877,"audience":878},"November 2026","\u002Fen\u002Fchangelog\u002F2026-11-09","en\u002F4.changelog\u002F2026-11-09","changelog",{"title":880,"path":881,"stem":882,"audience":878},"October 2026","\u002Fen\u002Fchangelog\u002F2026-10-21","en\u002F4.changelog\u002F2026-10-21",{"title":884,"path":885,"stem":886,"audience":878},"September 2026","\u002Fen\u002Fchangelog\u002F2026-09-09","en\u002F4.changelog\u002F2026-09-09",{"title":888,"path":889,"stem":890,"audience":878},"August 2026","\u002Fen\u002Fchangelog\u002F2026-08-19","en\u002F4.changelog\u002F2026-08-19",{"title":892,"path":893,"stem":894,"audience":878},"July 2026","\u002Fen\u002Fchangelog\u002F2026-07-30","en\u002F4.changelog\u002F2026-07-30",{"title":896,"path":897,"stem":898,"audience":878},"June 2026","\u002Fen\u002Fchangelog\u002F2026-06-16","en\u002F4.changelog\u002F2026-06-16",{"title":900,"path":901,"stem":902,"audience":878},"April 2026","\u002Fen\u002Fchangelog\u002F2026-04-29","en\u002F4.changelog\u002F2026-04-29",{"title":904,"path":905,"stem":906,"audience":878},"March 2026","\u002Fen\u002Fchangelog\u002F2026-03-31","en\u002F4.changelog\u002F2026-03-31",{"title":908,"path":909,"stem":910,"audience":878},"February 2026","\u002Fen\u002Fchangelog\u002F2026-02-25","en\u002F4.changelog\u002F2026-02-25",{"title":912,"path":913,"stem":914,"audience":878},"January 2026","\u002Fen\u002Fchangelog\u002F2026-01-27","en\u002F4.changelog\u002F2026-01-27",{"title":916,"path":917,"stem":918,"audience":878},"December 2025","\u002Fen\u002Fchangelog\u002F2025-12-15","en\u002F4.changelog\u002F2025-12-15",{"title":920,"path":921,"stem":922,"audience":878},"November 2025","\u002Fen\u002Fchangelog\u002F2025-11-28","en\u002F4.changelog\u002F2025-11-28",{"title":924,"path":925,"stem":926,"audience":878},"September 2025","\u002Fen\u002Fchangelog\u002F2025-09-04","en\u002F4.changelog\u002F2025-09-04",{"title":928,"path":929,"stem":930,"audience":878},"August 2025","\u002Fen\u002Fchangelog\u002F2025-08-20","en\u002F4.changelog\u002F2025-08-20",{"title":932,"path":933,"stem":934,"audience":878},"July 2025","\u002Fen\u002Fchangelog\u002F2025-07-21","en\u002F4.changelog\u002F2025-07-21",{"title":936,"path":937,"stem":938,"audience":878},"June 2025","\u002Fen\u002Fchangelog\u002F2025-06-23","en\u002F4.changelog\u002F2025-06-23",{"title":940,"path":941,"stem":942,"audience":878},"May 2025","\u002Fen\u002Fchangelog\u002F2025-05-26","en\u002F4.changelog\u002F2025-05-26",{"title":944,"path":945,"stem":946,"audience":878},"April 2025","\u002Fen\u002Fchangelog\u002F2025-04-28","en\u002F4.changelog\u002F2025-04-28",{"title":948,"path":949,"stem":950,"audience":878},"March 2025","\u002Fen\u002Fchangelog\u002F2025-03-31","en\u002F4.changelog\u002F2025-03-31",{"title":952,"path":953,"stem":954,"audience":878},"February 2025","\u002Fen\u002Fchangelog\u002F2025-02-26","en\u002F4.changelog\u002F2025-02-26",{"title":956,"path":957,"stem":958,"audience":878},"January 2025","\u002Fen\u002Fchangelog\u002F2025-01-30","en\u002F4.changelog\u002F2025-01-30",{"title":960,"path":961,"stem":962,"audience":878},"December 2024","\u002Fen\u002Fchangelog\u002F2024-12-19","en\u002F4.changelog\u002F2024-12-19",{"title":964,"path":965,"stem":966,"audience":878},"November 2024","\u002Fen\u002Fchangelog\u002F2024-11-28","en\u002F4.changelog\u002F2024-11-28",{"title":968,"path":969,"stem":970,"audience":878},"October 2024","\u002Fen\u002Fchangelog\u002F2024-10-30","en\u002F4.changelog\u002F2024-10-30",{"title":972,"path":973,"stem":974,"audience":878},"September 2024","\u002Fen\u002Fchangelog\u002F2024-09-23","en\u002F4.changelog\u002F2024-09-23",{"title":976,"path":977,"stem":978,"audience":878},"August 2024","\u002Fen\u002Fchangelog\u002F2024-08-30","en\u002F4.changelog\u002F2024-08-30",{"title":980,"path":981,"stem":982,"audience":878},"July 2024","\u002Fen\u002Fchangelog\u002F2024-07-29","en\u002F4.changelog\u002F2024-07-29",{"title":984,"path":985,"stem":986,"audience":878},"June 2024","\u002Fen\u002Fchangelog\u002F2024-06-25","en\u002F4.changelog\u002F2024-06-25",{"title":988,"path":989,"stem":990,"audience":878},"May 2024","\u002Fen\u002Fchangelog\u002F2024-05-31","en\u002F4.changelog\u002F2024-05-31",{"title":992,"path":993,"stem":994,"audience":878},"April 2024","\u002Fen\u002Fchangelog\u002F2024-04-30","en\u002F4.changelog\u002F2024-04-30",[996,997],{"title":463,"path":464,"stem":465,"children":-1},{"title":134,"path":133,"stem":472,"children":-1},1794931478438]