[{"data":1,"prerenderedAt":1100},["ShallowReactive",2],{"docs-page-\u002Fen\u002Fapi\u002Fcongestion\u002Freference\u002Fretrieve-consumption-periods":3,"nav-docs_en-api_en":415,"surround-\u002Fen\u002Fapi\u002Fcongestion\u002Freference\u002Fretrieve-consumption-periods":1098},{"document":4,"collection":413,"isFallback":414,"defaultLocalePath":395},{"id":5,"title":6,"audience":7,"base_url":8,"body":9,"boost":385,"date":385,"description":386,"endpoint":387,"extension":388,"keywords":389,"meta":392,"method":393,"navigation":394,"path":395,"playground":396,"question_examples":406,"related":407,"seo":408,"slug":385,"stem":409,"summary":410,"synonyms":411,"__hash__":412},"api_en\u002Fen\u002F2.api\u002F6.congestion\u002F2.reference\u002F4.retrieve-consumption-periods.md","Retrieve all credit consumption periods","api","https:\u002F\u002Fapi.sinay.ai\u002Fcongestion\u002Fapi\u002Fv1",{"type":10,"value":11,"toc":379},"minimark",[12,23,28,155,236,308],[13,14,15,19,20,22],"p",{},[16,17,18],"code",{},"GET \u002Fconsumption\u002Fperiods"," on the Congestion API. Base URL: ",[16,21,8],{},".",[24,25,27],"h2",{"id":26},"responses","Responses",[29,30,33,40],"api-response",{"description":31,"status":32},"The consumption periods","200",[13,34,35,36,39],{},"Body: ",[16,37,38],{},"application\u002Fjson",", array of object.",[41,42,43,62],"table",{},[44,45,46],"thead",{},[47,48,49,53,56,59],"tr",{},[50,51,52],"th",{},"Field",[50,54,55],{},"Type",[50,57,58],{},"Required",[50,60,61],{},"Description",[63,64,65,82,97,111,126,140],"tbody",{},[47,66,67,73,76,79],{},[68,69,70],"td",{},[16,71,72],{},"[].id",[68,74,75],{},"string (uuid)",[68,77,78],{},"Yes",[68,80,81],{},"Unique identifier of the consumption period.",[47,83,84,89,92,94],{},[68,85,86],{},[16,87,88],{},"[].credits",[68,90,91],{},"integer",[68,93,78],{},[68,95,96],{},"Remaining credits.",[47,98,99,104,106,108],{},[68,100,101],{},[16,102,103],{},"[].creditsInitial",[68,105,91],{},[68,107,78],{},[68,109,110],{},"Credits allocated at the start of the period.",[47,112,113,118,121,123],{},[68,114,115],{},[16,116,117],{},"[].periodStart",[68,119,120],{},"string (date-time)",[68,122,78],{},[68,124,125],{},"Start of the period.",[47,127,128,133,135,137],{},[68,129,130],{},[16,131,132],{},"[].periodEnd",[68,134,120],{},[68,136,78],{},[68,138,139],{},"End of the period.",[47,141,142,147,150,152],{},[68,143,144],{},[16,145,146],{},"[].expired",[68,148,149],{},"boolean",[68,151,78],{},[68,153,154],{},"Whether this period has expired.",[29,156,159,164],{"description":157,"status":158},"The authentication failed","401",[13,160,35,161,163],{},[16,162,38],{},", object.",[41,165,166,178],{},[44,167,168],{},[47,169,170,172,174,176],{},[50,171,52],{},[50,173,55],{},[50,175,58],{},[50,177,61],{},[63,179,180,195,209,223],{},[47,181,182,187,190,192],{},[68,183,184],{},[16,185,186],{},"errorCode",[68,188,189],{},"integer (int32)",[68,191,78],{},[68,193,194],{},"—",[47,196,197,202,205,207],{},[68,198,199],{},[16,200,201],{},"message",[68,203,204],{},"string",[68,206,78],{},[68,208,194],{},[47,210,211,216,219,221],{},[68,212,213],{},[16,214,215],{},"details",[68,217,218],{},"array of string",[68,220,78],{},[68,222,194],{},[47,224,225,230,232,234],{},[68,226,227],{},[16,228,229],{},"time",[68,231,120],{},[68,233,78],{},[68,235,194],{},[29,237,240,244],{"description":238,"status":239},"An error occurend on server side","500",[13,241,35,242,163],{},[16,243,38],{},[41,245,246,258],{},[44,247,248],{},[47,249,250,252,254,256],{},[50,251,52],{},[50,253,55],{},[50,255,58],{},[50,257,61],{},[63,259,260,272,284,296],{},[47,261,262,266,268,270],{},[68,263,264],{},[16,265,186],{},[68,267,189],{},[68,269,78],{},[68,271,194],{},[47,273,274,278,280,282],{},[68,275,276],{},[16,277,201],{},[68,279,204],{},[68,281,78],{},[68,283,194],{},[47,285,286,290,292,294],{},[68,287,288],{},[16,289,215],{},[68,291,218],{},[68,293,78],{},[68,295,194],{},[47,297,298,302,304,306],{},[68,299,300],{},[16,301,229],{},[68,303,120],{},[68,305,78],{},[68,307,194],{},[29,309,311,315],{"description":310,"status":310},"default",[13,312,35,313,163],{},[16,314,38],{},[41,316,317,329],{},[44,318,319],{},[47,320,321,323,325,327],{},[50,322,52],{},[50,324,55],{},[50,326,58],{},[50,328,61],{},[63,330,331,343,355,367],{},[47,332,333,337,339,341],{},[68,334,335],{},[16,336,186],{},[68,338,189],{},[68,340,78],{},[68,342,194],{},[47,344,345,349,351,353],{},[68,346,347],{},[16,348,201],{},[68,350,204],{},[68,352,78],{},[68,354,194],{},[47,356,357,361,363,365],{},[68,358,359],{},[16,360,215],{},[68,362,218],{},[68,364,78],{},[68,366,194],{},[47,368,369,373,375,377],{},[68,370,371],{},[16,372,229],{},[68,374,120],{},[68,376,78],{},[68,378,194],{},{"title":380,"searchDepth":381,"depth":381,"links":382},"",3,[383],{"id":26,"depth":384,"text":27},2,null,"GET \u002Fconsumption\u002Fperiods on the Congestion API. Base URL: https:\u002F\u002Fapi.sinay.ai\u002Fcongestion\u002Fapi\u002Fv1.","\u002Fconsumption\u002Fperiods","md",[390,18,391],"Congestion","retrieveConsumptionPeriods",{},"GET",true,"\u002Fen\u002Fapi\u002Fcongestion\u002Freference\u002Fretrieve-consumption-periods",{"path_params":397,"query_params":398,"responses":399},[],[],[400,402,404,405],{"status":32,"description":31,"body":401},"[\n  {\n    \"id\": \"091c4dc8-e979-4607-b9ca-78260ab48dfe\",\n    \"credits\": 3,\n    \"creditsInitial\": 3,\n    \"periodStart\": \"2024-10-21T11:20:17Z\",\n    \"periodEnd\": \"2224-10-21T11:20:17Z\",\n    \"expired\": false\n  }\n]",{"status":158,"description":157,"body":403},"{\n  \"errorCode\": 0,\n  \"message\": \"string\",\n  \"details\": [\n    \"string\"\n  ],\n  \"time\": \"2026-01-01T00:00:00Z\"\n}",{"status":239,"description":238,"body":403},{"status":310,"description":310,"body":403},[],[],{"title":6,"description":386},"en\u002F2.api\u002F6.congestion\u002F2.reference\u002F4.retrieve-consumption-periods","Congestion API, GET \u002Fconsumption\u002Fperiods: Retrieve all credit consumption periods.",[],"2Za-3EVs18a-p7kZilgSSi2wQZkGWsL00Ua8eFnVKss","api_en",false,{"platform":416,"api":591,"faq":950,"changelog":976},[417,439,468,489,506,519,548,565,578],{"title":418,"path":419,"stem":420,"children":421,"page":414},"Getting Started","\u002Fen\u002Fplatform\u002Fgetting-started","en\u002F1.platform\u002F1.getting-started",[422,427,431,435],{"title":423,"path":424,"stem":425,"audience":426},"Creating an account","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fcreating-an-account","en\u002F1.platform\u002F1.getting-started\u002F1.creating-an-account","platform",{"title":428,"path":429,"stem":430,"audience":426},"Adding shipments","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fadding-shipments","en\u002F1.platform\u002F1.getting-started\u002F2.adding-shipments",{"title":432,"path":433,"stem":434,"audience":426},"Supported sealines","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fsupported-sealines","en\u002F1.platform\u002F1.getting-started\u002F3.supported-sealines",{"title":436,"path":437,"stem":438,"audience":426},"Navigating the platform","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fnavigating-the-platform","en\u002F1.platform\u002F1.getting-started\u002F4.navigating-the-platform",{"title":440,"path":441,"stem":442,"children":443,"page":414},"Container Tracking","\u002Fen\u002Fplatform\u002Fcontainer-tracking","en\u002F1.platform\u002F2.container-tracking",[444,448,452,456,460,464],{"title":445,"path":446,"stem":447,"audience":426},"Shipment details","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipment-details","en\u002F1.platform\u002F2.container-tracking\u002F1.shipment-details",{"title":449,"path":450,"stem":451,"audience":426},"Shipping statuses","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipping-statuses","en\u002F1.platform\u002F2.container-tracking\u002F2.shipping-statuses",{"title":453,"path":454,"stem":455,"audience":426},"Update frequency","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fupdate-frequency","en\u002F1.platform\u002F2.container-tracking\u002F3.update-frequency",{"title":457,"path":458,"stem":459,"audience":426},"Tracking issues","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Ftracking-issues","en\u002F1.platform\u002F2.container-tracking\u002F4.tracking-issues",{"title":461,"path":462,"stem":463,"audience":426},"Sharing and export","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fsharing-and-export","en\u002F1.platform\u002F2.container-tracking\u002F5.sharing-and-export",{"title":465,"path":466,"stem":467,"audience":426},"Shipment archiving","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipment-archiving","en\u002F1.platform\u002F2.container-tracking\u002F6.shipment-archiving",{"title":469,"path":470,"stem":471,"children":472,"page":414},"Shipment Views","\u002Fen\u002Fplatform\u002Fshipment-views","en\u002F1.platform\u002F3.shipment-views",[473,477,481,485],{"title":474,"path":475,"stem":476,"audience":426},"Shipment list","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fshipment-list","en\u002F1.platform\u002F3.shipment-views\u002F1.shipment-list",{"title":478,"path":479,"stem":480,"audience":426},"Shipment list columns","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fshipment-list-columns","en\u002F1.platform\u002F3.shipment-views\u002F2.shipment-list-columns",{"title":482,"path":483,"stem":484,"audience":426},"Kanban","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fkanban","en\u002F1.platform\u002F3.shipment-views\u002F3.kanban",{"title":486,"path":487,"stem":488,"audience":426},"Calendar","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fcalendar","en\u002F1.platform\u002F3.shipment-views\u002F4.calendar",{"title":490,"path":491,"stem":492,"children":493,"page":414},"Alerts","\u002Fen\u002Fplatform\u002Falerts","en\u002F1.platform\u002F4.alerts",[494,498,502],{"title":495,"path":496,"stem":497,"audience":426},"Alerts page","\u002Fen\u002Fplatform\u002Falerts\u002Falerts-page","en\u002F1.platform\u002F4.alerts\u002F1.alerts-page",{"title":499,"path":500,"stem":501,"audience":426},"Alert management","\u002Fen\u002Fplatform\u002Falerts\u002Falert-management","en\u002F1.platform\u002F4.alerts\u002F2.alert-management",{"title":503,"path":504,"stem":505,"audience":426},"Notifications and reports","\u002Fen\u002Fplatform\u002Falerts\u002Fnotifications-and-reports","en\u002F1.platform\u002F4.alerts\u002F3.notifications-and-reports",{"title":507,"path":508,"stem":509,"children":510,"page":414},"Analytics","\u002Fen\u002Fplatform\u002Fanalytics","en\u002F1.platform\u002F5.analytics",[511,515],{"title":512,"path":513,"stem":514,"audience":426},"Performance analytics","\u002Fen\u002Fplatform\u002Fanalytics\u002Fperformance","en\u002F1.platform\u002F5.analytics\u002F1.performance",{"title":516,"path":517,"stem":518,"audience":426},"Sustainability","\u002Fen\u002Fplatform\u002Fanalytics\u002Fsustainability","en\u002F1.platform\u002F5.analytics\u002F2.sustainability",{"title":520,"path":521,"stem":522,"children":523,"page":414},"Workspace","\u002Fen\u002Fplatform\u002Fworkspace","en\u002F1.platform\u002F6.workspace",[524,528,532,536,540,544],{"title":525,"path":526,"stem":527,"audience":426},"Users and roles","\u002Fen\u002Fplatform\u002Fworkspace\u002Fusers-and-roles","en\u002F1.platform\u002F6.workspace\u002F1.users-and-roles",{"title":529,"path":530,"stem":531,"audience":426},"Teams","\u002Fen\u002Fplatform\u002Fworkspace\u002Fteams","en\u002F1.platform\u002F6.workspace\u002F2.teams",{"title":533,"path":534,"stem":535,"audience":426},"Documents","\u002Fen\u002Fplatform\u002Fworkspace\u002Fdocuments","en\u002F1.platform\u002F6.workspace\u002F3.documents",{"title":537,"path":538,"stem":539,"audience":426},"Workspace settings","\u002Fen\u002Fplatform\u002Fworkspace\u002Fworkspace-settings","en\u002F1.platform\u002F6.workspace\u002F4.workspace-settings",{"title":541,"path":542,"stem":543,"audience":426},"White label","\u002Fen\u002Fplatform\u002Fworkspace\u002Fwhite-label","en\u002F1.platform\u002F6.workspace\u002F5.white-label",{"title":545,"path":546,"stem":547,"audience":426},"Account settings","\u002Fen\u002Fplatform\u002Fworkspace\u002Faccount-settings","en\u002F1.platform\u002F6.workspace\u002F6.account-settings",{"title":549,"path":550,"stem":551,"children":552,"page":414},"Billing","\u002Fen\u002Fplatform\u002Fbilling","en\u002F1.platform\u002F7.billing",[553,557,561],{"title":554,"path":555,"stem":556,"audience":426},"Billing and payment","\u002Fen\u002Fplatform\u002Fbilling\u002Fbilling-and-payment","en\u002F1.platform\u002F7.billing\u002F1.billing-and-payment",{"title":558,"path":559,"stem":560,"audience":426},"Shipment billing","\u002Fen\u002Fplatform\u002Fbilling\u002Fshipment-billing","en\u002F1.platform\u002F7.billing\u002F2.shipment-billing",{"title":562,"path":563,"stem":564,"audience":426},"Free trial","\u002Fen\u002Fplatform\u002Fbilling\u002Ffree-trial","en\u002F1.platform\u002F7.billing\u002F3.free-trial",{"title":566,"path":567,"stem":568,"children":569,"page":414},"Developers","\u002Fen\u002Fplatform\u002Fdevelopers","en\u002F1.platform\u002F8.developers",[570,574],{"title":571,"path":572,"stem":573,"audience":426},"API credentials","\u002Fen\u002Fplatform\u002Fdevelopers\u002Fapi-credentials","en\u002F1.platform\u002F8.developers\u002F1.api-credentials",{"title":575,"path":576,"stem":577,"audience":426},"Webhooks console","\u002Fen\u002Fplatform\u002Fdevelopers\u002Fwebhooks-console","en\u002F1.platform\u002F8.developers\u002F2.webhooks-console",{"title":579,"path":580,"stem":581,"children":582,"page":414},"Integrations","\u002Fen\u002Fplatform\u002Fintegrations","en\u002F1.platform\u002F9.integrations",[583,587],{"title":584,"path":585,"stem":586,"audience":426},"Salesforce installation","\u002Fen\u002Fplatform\u002Fintegrations\u002Fsalesforce-installation","en\u002F1.platform\u002F9.integrations\u002F1.salesforce-installation",{"title":588,"path":589,"stem":590,"audience":426},"Salesforce user guide","\u002Fen\u002Fplatform\u002Fintegrations\u002Fsalesforce-user-guide","en\u002F1.platform\u002F9.integrations\u002F2.salesforce-user-guide",[592,608,679,847,882,914],{"title":418,"path":593,"stem":594,"children":595,"page":414},"\u002Fen\u002Fapi\u002Fgetting-started","en\u002F2.api\u002F1.getting-started",[596,600,604],{"title":597,"path":598,"stem":599,"audience":7},"API overview","\u002Fen\u002Fapi\u002Fgetting-started\u002Foverview","en\u002F2.api\u002F1.getting-started\u002F1.overview",{"title":601,"path":602,"stem":603,"audience":7},"Authentication","\u002Fen\u002Fapi\u002Fgetting-started\u002Fauthentication","en\u002F2.api\u002F1.getting-started\u002F2.authentication",{"title":605,"path":606,"stem":607,"audience":7},"Rate limits","\u002Fen\u002Fapi\u002Fgetting-started\u002Frate-limits","en\u002F2.api\u002F1.getting-started\u002F3.rate-limits",{"title":440,"path":609,"stem":610,"children":611,"page":414},"\u002Fen\u002Fapi\u002Fcontainer-tracking","en\u002F2.api\u002F2.container-tracking",[612,649],{"title":613,"path":614,"stem":615,"children":616,"page":414},"Guides","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides","en\u002F2.api\u002F2.container-tracking\u002F1.guides",[617,621,625,629,633,637,641,645],{"title":618,"path":619,"stem":620,"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":622,"path":623,"stem":624,"audience":7},"Shipment location","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fshipment-location","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F2.shipment-location",{"title":626,"path":627,"stem":628,"audience":7},"Shipment route","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fshipment-route","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F3.shipment-route",{"title":630,"path":631,"stem":632,"audience":7},"Demurrage risk","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fdemurrage-risk","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F4.demurrage-risk",{"title":634,"path":635,"stem":636,"audience":7},"Error codes","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Ferror-codes","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F5.error-codes",{"title":638,"path":639,"stem":640,"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":642,"path":643,"stem":644,"audience":7},"Supported shipping lines","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fsupported-sealines","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F7.supported-sealines",{"title":646,"path":647,"stem":648,"audience":7},"Sandbox and test shipments","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fsandbox","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F8.sandbox",{"title":650,"path":651,"stem":652,"children":653,"page":414},"Reference","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference","en\u002F2.api\u002F2.container-tracking\u002F2.reference",[654,659,664,669,674],{"title":655,"path":656,"stem":657,"method":393,"endpoint":658},"Retrieve shipment tracking data","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fget-shipment-detail","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F1.get-shipment-detail","\u002Fshipment",{"title":660,"path":661,"stem":662,"method":393,"endpoint":663},"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":665,"path":666,"stem":667,"method":393,"endpoint":668},"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":670,"path":671,"stem":672,"method":393,"endpoint":673},"Retrieve your monthly usages","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fretrieve-usages","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F4.retrieve-usages","\u002Fusages",{"title":675,"path":676,"stem":677,"method":393,"endpoint":678},"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":680,"path":681,"stem":682,"children":683,"page":414},"Webhooks","\u002Fen\u002Fapi\u002Fwebhooks","en\u002F2.api\u002F3.webhooks",[684,723],{"title":613,"path":685,"stem":686,"children":687,"page":414},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides","en\u002F2.api\u002F3.webhooks\u002F1.guides",[688,692,696,700,703,707,711,715,719],{"title":689,"path":690,"stem":691,"audience":7},"Getting started with webhooks","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fgetting-started","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F1.getting-started",{"title":693,"path":694,"stem":695,"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":697,"path":698,"stem":699,"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":428,"path":701,"stem":702,"audience":7},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fadding-shipments","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F4.adding-shipments",{"title":704,"path":705,"stem":706,"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":708,"path":709,"stem":710,"audience":7},"Detecting and recovering webhook failures","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Ffailure-recovery","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F6.failure-recovery",{"title":712,"path":713,"stem":714,"audience":7},"Shipment usage","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fshipment-usage","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F7.shipment-usage",{"title":716,"path":717,"stem":718,"audience":7},"Webhook events","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fevents","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F8.events",{"title":720,"path":721,"stem":722,"audience":7},"Auto-removal policy","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fauto-removal-policy","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F9.auto-removal-policy",{"title":650,"path":724,"stem":725,"children":726,"page":414},"\u002Fen\u002Fapi\u002Fwebhooks\u002Freference","en\u002F2.api\u002F3.webhooks\u002F2.reference",[727,805,828,838],{"title":728,"path":729,"stem":730,"children":731,"page":414},"Endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints",[732,738,742,747,752,757,762,767,772,777,782,787,792,796,800],{"title":733,"path":734,"stem":735,"method":736,"endpoint":737},"Create Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-create","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F1.endpoint-create","POST","\u002Fendpoint",{"title":739,"path":740,"stem":741,"method":393,"endpoint":737},"List Endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-list","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F2.endpoint-list",{"title":743,"path":744,"stem":745,"method":393,"endpoint":746},"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":748,"path":749,"stem":750,"method":751,"endpoint":746},"Update Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-update","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F4.endpoint-update","PUT",{"title":753,"path":754,"stem":755,"method":756,"endpoint":746},"Delete Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-delete","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F5.endpoint-delete","DELETE",{"title":758,"path":759,"stem":760,"method":761,"endpoint":746},"Patch Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-patch","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F6.endpoint-patch","PATCH",{"title":763,"path":764,"stem":765,"method":393,"endpoint":766},"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":768,"path":769,"stem":770,"method":736,"endpoint":771},"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":773,"path":774,"stem":775,"method":393,"endpoint":776},"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":778,"path":779,"stem":780,"method":736,"endpoint":781},"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":783,"path":784,"stem":785,"method":736,"endpoint":786},"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":788,"path":789,"stem":790,"method":393,"endpoint":791},"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":793,"path":794,"stem":795,"method":751,"endpoint":791},"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":797,"path":798,"stem":799,"method":761,"endpoint":791},"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":801,"path":802,"stem":803,"method":736,"endpoint":804},"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":806,"path":807,"stem":808,"children":809,"page":414},"Easy Shipment","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment",[810,815,820,824],{"title":811,"path":812,"stem":813,"method":736,"endpoint":814},"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":816,"path":817,"stem":818,"method":393,"endpoint":819},"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":821,"path":822,"stem":823,"method":751,"endpoint":819},"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":825,"path":826,"stem":827,"method":756,"endpoint":819},"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":829,"path":830,"stem":831,"children":832,"page":414},"Application","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fapplication","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F3.application",[833],{"title":834,"path":835,"stem":836,"method":393,"endpoint":837},"Get dashboard url","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fapplication\u002Fapplication-dashboard","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F3.application\u002F1.application-dashboard","\u002Fdashboard",{"title":839,"path":840,"stem":841,"children":842,"page":414},"Usages","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fusages","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F4.usages",[843],{"title":844,"path":845,"stem":846,"method":393,"endpoint":678},"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":848,"path":849,"stem":850,"children":851,"page":414},"Shipment Management","\u002Fen\u002Fapi\u002Fshipment-management","en\u002F2.api\u002F4.shipment-management",[852,864],{"title":613,"path":853,"stem":854,"children":855,"page":414},"\u002Fen\u002Fapi\u002Fshipment-management\u002Fguides","en\u002F2.api\u002F4.shipment-management\u002F1.guides",[856,860],{"title":857,"path":858,"stem":859,"audience":7},"Getting started with the Shipment Management API","\u002Fen\u002Fapi\u002Fshipment-management\u002Fguides\u002Fgetting-started","en\u002F2.api\u002F4.shipment-management\u002F1.guides\u002F1.getting-started",{"title":861,"path":862,"stem":863,"audience":7},"Embed a shipment in an iframe","\u002Fen\u002Fapi\u002Fshipment-management\u002Fguides\u002Fiframe-embed","en\u002F2.api\u002F4.shipment-management\u002F1.guides\u002F2.iframe-embed",{"title":650,"path":865,"stem":866,"children":867,"page":414},"\u002Fen\u002Fapi\u002Fshipment-management\u002Freference","en\u002F2.api\u002F4.shipment-management\u002F2.reference",[868,873,877],{"title":869,"path":870,"stem":871,"method":736,"endpoint":872},"Create shipments","\u002Fen\u002Fapi\u002Fshipment-management\u002Freference\u002Fcreate-shipments","en\u002F2.api\u002F4.shipment-management\u002F2.reference\u002F1.create-shipments","\u002Fpublic\u002Fshipments",{"title":874,"path":875,"stem":876,"method":756,"endpoint":872},"Delete multiple shipments","\u002Fen\u002Fapi\u002Fshipment-management\u002Freference\u002Fdelete-shipments","en\u002F2.api\u002F4.shipment-management\u002F2.reference\u002F2.delete-shipments",{"title":878,"path":879,"stem":880,"method":736,"endpoint":881},"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":883,"path":884,"stem":885,"children":886,"page":414},"Ports Intelligence","\u002Fen\u002Fapi\u002Fports-intelligence","en\u002F2.api\u002F5.ports-intelligence",[887,895],{"title":613,"path":888,"stem":889,"children":890,"page":414},"\u002Fen\u002Fapi\u002Fports-intelligence\u002Fguides","en\u002F2.api\u002F5.ports-intelligence\u002F1.guides",[891],{"title":892,"path":893,"stem":894,"audience":7},"Port occupation","\u002Fen\u002Fapi\u002Fports-intelligence\u002Fguides\u002Fport-occupation","en\u002F2.api\u002F5.ports-intelligence\u002F1.guides\u002F1.port-occupation",{"title":650,"path":896,"stem":897,"children":898,"page":414},"\u002Fen\u002Fapi\u002Fports-intelligence\u002Freference","en\u002F2.api\u002F5.ports-intelligence\u002F2.reference",[899,904,909],{"title":900,"path":901,"stem":902,"method":393,"endpoint":903},"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":905,"path":906,"stem":907,"method":393,"endpoint":908},"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":910,"path":911,"stem":912,"method":393,"endpoint":913},"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":390,"path":915,"stem":916,"children":917,"page":414},"\u002Fen\u002Fapi\u002Fcongestion","en\u002F2.api\u002F6.congestion",[918,930],{"title":613,"path":919,"stem":920,"children":921,"page":414},"\u002Fen\u002Fapi\u002Fcongestion\u002Fguides","en\u002F2.api\u002F6.congestion\u002F1.guides",[922,926],{"title":923,"path":924,"stem":925,"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":927,"path":928,"stem":929,"audience":7},"Congestion API coverage","\u002Fen\u002Fapi\u002Fcongestion\u002Fguides\u002Fcoverage","en\u002F2.api\u002F6.congestion\u002F1.guides\u002F2.coverage",{"title":650,"path":931,"stem":932,"children":933,"page":414},"\u002Fen\u002Fapi\u002Fcongestion\u002Freference","en\u002F2.api\u002F6.congestion\u002F2.reference",[934,939,944,949],{"title":935,"path":936,"stem":937,"method":393,"endpoint":938},"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":940,"path":941,"stem":942,"method":736,"endpoint":943},"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":945,"path":946,"stem":947,"method":393,"endpoint":948},"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":6,"path":395,"stem":409,"method":393,"endpoint":387},[951,956,960,964,968,972],{"title":952,"path":953,"stem":954,"audience":955},"Getting started and scope","\u002Fen\u002Ffaq\u002Fgetting-started","en\u002F3.faq\u002F1.getting-started","faq",{"title":957,"path":958,"stem":959,"audience":955},"Tracking","\u002Fen\u002Ffaq\u002Ftracking","en\u002F3.faq\u002F2.tracking",{"title":961,"path":962,"stem":963,"audience":955},"Billing and plans","\u002Fen\u002Ffaq\u002Fbilling","en\u002F3.faq\u002F3.billing",{"title":965,"path":966,"stem":967,"audience":955},"Account and workspace","\u002Fen\u002Ffaq\u002Faccount","en\u002F3.faq\u002F4.account",{"title":969,"path":970,"stem":971,"audience":955},"API and integration","\u002Fen\u002Ffaq\u002Fapi","en\u002F3.faq\u002F5.api",{"title":973,"path":974,"stem":975,"audience":955},"Security and legal","\u002Fen\u002Ffaq\u002Fsecurity-and-legal","en\u002F3.faq\u002F6.security-and-legal",[977,982,986,990,994,998,1002,1006,1010,1014,1018,1022,1026,1030,1034,1038,1042,1046,1050,1054,1058,1062,1066,1070,1074,1078,1082,1086,1090,1094],{"title":978,"path":979,"stem":980,"audience":981},"November 2026","\u002Fen\u002Fchangelog\u002F2026-11-09","en\u002F4.changelog\u002F2026-11-09","changelog",{"title":983,"path":984,"stem":985,"audience":981},"October 2026","\u002Fen\u002Fchangelog\u002F2026-10-21","en\u002F4.changelog\u002F2026-10-21",{"title":987,"path":988,"stem":989,"audience":981},"September 2026","\u002Fen\u002Fchangelog\u002F2026-09-09","en\u002F4.changelog\u002F2026-09-09",{"title":991,"path":992,"stem":993,"audience":981},"August 2026","\u002Fen\u002Fchangelog\u002F2026-08-19","en\u002F4.changelog\u002F2026-08-19",{"title":995,"path":996,"stem":997,"audience":981},"July 2026","\u002Fen\u002Fchangelog\u002F2026-07-30","en\u002F4.changelog\u002F2026-07-30",{"title":999,"path":1000,"stem":1001,"audience":981},"June 2026","\u002Fen\u002Fchangelog\u002F2026-06-16","en\u002F4.changelog\u002F2026-06-16",{"title":1003,"path":1004,"stem":1005,"audience":981},"April 2026","\u002Fen\u002Fchangelog\u002F2026-04-29","en\u002F4.changelog\u002F2026-04-29",{"title":1007,"path":1008,"stem":1009,"audience":981},"March 2026","\u002Fen\u002Fchangelog\u002F2026-03-31","en\u002F4.changelog\u002F2026-03-31",{"title":1011,"path":1012,"stem":1013,"audience":981},"February 2026","\u002Fen\u002Fchangelog\u002F2026-02-25","en\u002F4.changelog\u002F2026-02-25",{"title":1015,"path":1016,"stem":1017,"audience":981},"January 2026","\u002Fen\u002Fchangelog\u002F2026-01-27","en\u002F4.changelog\u002F2026-01-27",{"title":1019,"path":1020,"stem":1021,"audience":981},"December 2025","\u002Fen\u002Fchangelog\u002F2025-12-15","en\u002F4.changelog\u002F2025-12-15",{"title":1023,"path":1024,"stem":1025,"audience":981},"November 2025","\u002Fen\u002Fchangelog\u002F2025-11-28","en\u002F4.changelog\u002F2025-11-28",{"title":1027,"path":1028,"stem":1029,"audience":981},"September 2025","\u002Fen\u002Fchangelog\u002F2025-09-04","en\u002F4.changelog\u002F2025-09-04",{"title":1031,"path":1032,"stem":1033,"audience":981},"August 2025","\u002Fen\u002Fchangelog\u002F2025-08-20","en\u002F4.changelog\u002F2025-08-20",{"title":1035,"path":1036,"stem":1037,"audience":981},"July 2025","\u002Fen\u002Fchangelog\u002F2025-07-21","en\u002F4.changelog\u002F2025-07-21",{"title":1039,"path":1040,"stem":1041,"audience":981},"June 2025","\u002Fen\u002Fchangelog\u002F2025-06-23","en\u002F4.changelog\u002F2025-06-23",{"title":1043,"path":1044,"stem":1045,"audience":981},"May 2025","\u002Fen\u002Fchangelog\u002F2025-05-26","en\u002F4.changelog\u002F2025-05-26",{"title":1047,"path":1048,"stem":1049,"audience":981},"April 2025","\u002Fen\u002Fchangelog\u002F2025-04-28","en\u002F4.changelog\u002F2025-04-28",{"title":1051,"path":1052,"stem":1053,"audience":981},"March 2025","\u002Fen\u002Fchangelog\u002F2025-03-31","en\u002F4.changelog\u002F2025-03-31",{"title":1055,"path":1056,"stem":1057,"audience":981},"February 2025","\u002Fen\u002Fchangelog\u002F2025-02-26","en\u002F4.changelog\u002F2025-02-26",{"title":1059,"path":1060,"stem":1061,"audience":981},"January 2025","\u002Fen\u002Fchangelog\u002F2025-01-30","en\u002F4.changelog\u002F2025-01-30",{"title":1063,"path":1064,"stem":1065,"audience":981},"December 2024","\u002Fen\u002Fchangelog\u002F2024-12-19","en\u002F4.changelog\u002F2024-12-19",{"title":1067,"path":1068,"stem":1069,"audience":981},"November 2024","\u002Fen\u002Fchangelog\u002F2024-11-28","en\u002F4.changelog\u002F2024-11-28",{"title":1071,"path":1072,"stem":1073,"audience":981},"October 2024","\u002Fen\u002Fchangelog\u002F2024-10-30","en\u002F4.changelog\u002F2024-10-30",{"title":1075,"path":1076,"stem":1077,"audience":981},"September 2024","\u002Fen\u002Fchangelog\u002F2024-09-23","en\u002F4.changelog\u002F2024-09-23",{"title":1079,"path":1080,"stem":1081,"audience":981},"August 2024","\u002Fen\u002Fchangelog\u002F2024-08-30","en\u002F4.changelog\u002F2024-08-30",{"title":1083,"path":1084,"stem":1085,"audience":981},"July 2024","\u002Fen\u002Fchangelog\u002F2024-07-29","en\u002F4.changelog\u002F2024-07-29",{"title":1087,"path":1088,"stem":1089,"audience":981},"June 2024","\u002Fen\u002Fchangelog\u002F2024-06-25","en\u002F4.changelog\u002F2024-06-25",{"title":1091,"path":1092,"stem":1093,"audience":981},"May 2024","\u002Fen\u002Fchangelog\u002F2024-05-31","en\u002F4.changelog\u002F2024-05-31",{"title":1095,"path":1096,"stem":1097,"audience":981},"April 2024","\u002Fen\u002Fchangelog\u002F2024-04-30","en\u002F4.changelog\u002F2024-04-30",[1099,385],{"title":945,"path":946,"stem":947,"children":-1},1794931524152]