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