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