{"items":[{"type":"link","fsPath":"index.page.tsx","metadata":{},"label":"Welcome","link":"/","routeSlug":"/"},{"type":"separator","separatorLine":true},{"type":"separator","label":"APIS"},{"type":"group","fsPath":"connect/consignments-api/index.md","metadata":{"type":"markdown"},"label":"Consignments","link":"/connect/consignments-api","routeSlug":"/connect/consignments-api","items":[{"type":"link","label":"Scurri Platform API","link":"/connect/consignments-api/versions/1.0.0/openapi","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi"},{"type":"link","label":"Authentication","link":"/connect/consignments-api/versions/1.0.0/openapi/section/authentication","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/section/authentication"},{"type":"link","label":"API Token","link":"/connect/consignments-api/versions/1.0.0/openapi/section/api-token","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/section/api-token"},{"type":"link","label":"Basic Auth","link":"/connect/consignments-api/versions/1.0.0/openapi/section/basic-auth","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/section/basic-auth"},{"type":"group","label":"Carriers","link":"/connect/consignments-api/versions/1.0.0/openapi/carriers","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/carriers","items":[{"label":"List Available Carriers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/consignments-api/versions/1.0.0/openapi/carriers/list_available_carriers","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/carriers/list_available_carriers","metadata":{"seo":{"title":"List Available Carriers","description":"List all the carriers for the logged in user"}},"httpPath":"/_api/v1/company/{company_slug}/carriers/"}]},{"type":"group","label":"Carrier Services","link":"/connect/consignments-api/versions/1.0.0/openapi/carrier-services","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/carrier-services","items":[{"label":"List Available Carrier Services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/consignments-api/versions/1.0.0/openapi/carrier-services/list_available_carrier_services","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/carrier-services/list_available_carrier_services","metadata":{"seo":{"title":"List Available Carrier Services","description":"List all the carrier services for the logged in user"}},"httpPath":"/_api/v1/company/{company_slug}/carrierservices/"}]},{"type":"group","label":"Warehouses","link":"/connect/consignments-api/versions/1.0.0/openapi/warehouses","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/warehouses","items":[{"label":"List Available Warehouses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/consignments-api/versions/1.0.0/openapi/warehouses/list_available_warehouses","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/warehouses/list_available_warehouses","metadata":{"seo":{"title":"List Available Warehouses","description":"List Available Warehouses"}},"httpPath":"/_api/v1/company/{company_slug}/warehouses/"}]},{"type":"group","label":"Consignments","link":"/connect/consignments-api/versions/1.0.0/openapi/consignments","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/consignments","items":[{"label":"List all consignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/consignments-api/versions/1.0.0/openapi/consignments/listconsignments","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/consignments/listconsignments","metadata":{"seo":{"title":"List all consignments","description":"You can use this API call to retrieve the list of consignments in Scurri."}},"httpPath":"/_api/v1/company/{company_slug}/consignments/"},{"label":"Import a new consignment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/consignments-api/versions/1.0.0/openapi/consignments/importconsignment","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/consignments/importconsignment","metadata":{"seo":{"title":"Import a new consignment","description":"Creates a new consignment (shipment) for the company. The consignment can be allocated or unallocated, domestic or international."}},"httpPath":"/_api/v1/company/{company_slug}/consignments/"},{"label":"Get consignment details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/consignments-api/versions/1.0.0/openapi/consignments/getconsignmentdetails","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/consignments/getconsignmentdetails","metadata":{"seo":{"title":"Get consignment details","description":"Retrieves details of a specific consignment (shipment)."}},"httpPath":"/_api/v1/company/{company_slug}/consignment/{shipmentIdentifier}/"},{"label":"Update a consignment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/consignments-api/versions/1.0.0/openapi/consignments/updateconsignment","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/consignments/updateconsignment","metadata":{"seo":{"title":"Update a consignment","description":"Updates a consignment. Can be used to allocate or unallocate the consignment."}},"httpPath":"/_api/v1/company/{company_slug}/consignment/{shipmentIdentifier}/"},{"label":"Cancel a consignment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/consignments-api/versions/1.0.0/openapi/consignments/cancelconsignment","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/consignments/cancelconsignment","metadata":{"seo":{"title":"Cancel a consignment","description":"Cancels a consignment, taking any necessary actions on the carrier side"}},"httpPath":"/_api/v1/company/{company_slug}/consignment/{shipmentIdentifier}/"}]},{"type":"group","label":"Consignment Documents","link":"/connect/consignments-api/versions/1.0.0/openapi/consignment-documents","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/consignment-documents","items":[{"type":"link","label":"Available label formats","link":"/connect/consignments-api/versions/1.0.0/openapi/consignment-documents/available-label-formats","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/consignment-documents/available-label-formats"},{"type":"link","label":"Customs Invoice Documents","link":"/connect/consignments-api/versions/1.0.0/openapi/consignment-documents/customs-invoice-documents","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/consignment-documents/customs-invoice-documents"},{"type":"link","label":"Natively Supported ZPL Carriers","link":"/connect/consignments-api/versions/1.0.0/openapi/consignment-documents/natively-supported-zpl-carriers","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/consignment-documents/natively-supported-zpl-carriers"},{"label":"Get consignment documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/consignments-api/versions/1.0.0/openapi/consignment-documents/getconsignmentdocuments","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/consignment-documents/getconsignmentdocuments","metadata":{"seo":{"title":"Get consignment documents","description":"Retrieves documents (e.g., labels) for a consignment. Supports filtering by document type and invoice quantity."}},"httpPath":"/_api/v1/company/{company_slug}/consignment/{shipmentIdentifier}/documents/"}]},{"type":"group","label":"Manifests","link":"/connect/consignments-api/versions/1.0.0/openapi/manifests","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/manifests","items":[{"label":"Create a new manifest","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/consignments-api/versions/1.0.0/openapi/manifests/createmanifest","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/manifests/createmanifest","metadata":{"seo":{"title":"Create a new manifest","description":"Initiates the manifest process for a given carrier and warehouse, specifying the consignments to include in the manifest."}},"httpPath":"/_api/v1/company/{company_slug}/manifest/"},{"label":"Get documents for a specific manifest","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/consignments-api/versions/1.0.0/openapi/manifests/getmanifestdocuments","routeSlug":"/connect/consignments-api/versions/1.0.0/openapi/manifests/getmanifestdocuments","metadata":{"seo":{"title":"Get documents for a specific manifest","description":"You can use this API call to get the manifest documentation (as an A4-size PDF file) that you need to hand-in to the carrier."}},"httpPath":"/_api/v1/company/{company_slug}/manifest/{manifest_id}/documents/"}]},{"type":"link","fsPath":"connect/consignments-api/history.md","metadata":{"type":"markdown"},"label":"Version History","link":"/connect/consignments-api/history","routeSlug":"/connect/consignments-api/history"}]},{"type":"group","fsPath":"connect/delivery-options-api/index.md","metadata":{"type":"markdown"},"label":"Delivery Options","link":"/connect/delivery-options-api","routeSlug":"/connect/delivery-options-api","items":[{"type":"link","label":"Scurri Delivery Options API","link":"/connect/delivery-options-api/versions/2025.1/openapi","routeSlug":"/connect/delivery-options-api/versions/2025.1/openapi"},{"type":"link","label":"Authentication","link":"/connect/delivery-options-api/versions/2025.1/openapi/section/authentication","routeSlug":"/connect/delivery-options-api/versions/2025.1/openapi/section/authentication"},{"type":"link","label":"Request and Response Format","link":"/connect/delivery-options-api/versions/2025.1/openapi/section/request-and-response-format","routeSlug":"/connect/delivery-options-api/versions/2025.1/openapi/section/request-and-response-format"},{"type":"group","label":"Delivery Options","link":"/connect/delivery-options-api/versions/2025.1/openapi/delivery-options","routeSlug":"/connect/delivery-options-api/versions/2025.1/openapi/delivery-options","items":[{"label":"Get a list of available delivery options at checkout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/delivery-options-api/versions/2025.1/openapi/delivery-options/post-delivery-options-api-2.0.0-company-slug-delivery-options","routeSlug":"/connect/delivery-options-api/versions/2025.1/openapi/delivery-options/post-delivery-options-api-2.0.0-company-slug-delivery-options","metadata":{"seo":{"title":"Get a list of available delivery options at checkout","description":"Get a list of available delivery options at checkout"}},"httpPath":"/api/2.0.0/company/{company-slug}/delivery_options/"}]},{"type":"link","fsPath":"connect/delivery-options-api/history.md","metadata":{"type":"markdown"},"label":"Version History","link":"/connect/delivery-options-api/history","routeSlug":"/connect/delivery-options-api/history"}]},{"type":"group","fsPath":"connect/locations-api/index.md","metadata":{"type":"markdown"},"label":"Locations","link":"/connect/locations-api","routeSlug":"/connect/locations-api","items":[{"type":"link","label":"Locations API","link":"/connect/locations-api/versions/2025.1/openapi","routeSlug":"/connect/locations-api/versions/2025.1/openapi"},{"type":"group","label":"Locations","link":"/connect/locations-api/versions/2025.1/openapi/locations","routeSlug":"/connect/locations-api/versions/2025.1/openapi/locations","items":[{"label":"List Delivery Locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect/locations-api/versions/2025.1/openapi/locations/getlocations","routeSlug":"/connect/locations-api/versions/2025.1/openapi/locations/getlocations","metadata":{"seo":{"title":"List Delivery Locations","description":"Retrieve delivery locations for a service based on the given parameters:"}},"httpPath":"/delivery/"}]},{"type":"link","fsPath":"connect/locations-api/categories.md","metadata":{"type":"markdown"},"label":"Location Categories","link":"/connect/locations-api/categories","routeSlug":"/connect/locations-api/categories"},{"type":"link","fsPath":"connect/locations-api/history.md","metadata":{"type":"markdown"},"label":"Version History","link":"/connect/locations-api/history","routeSlug":"/connect/locations-api/history"}]},{"type":"separator","separatorLine":true},{"type":"separator","label":"INTEGRATIONS"},{"type":"group","fsPath":"connect/webhooks/index.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/connect/webhooks","routeSlug":"/connect/webhooks","items":[{"type":"link","fsPath":"connect/webhooks/usage.md","metadata":{"type":"markdown"},"label":"Usage Guide","link":"/connect/webhooks/usage","routeSlug":"/connect/webhooks/usage"},{"type":"link","label":"Webhooks Specification","link":"/connect/webhooks/versions/2026.1/openapi","routeSlug":"/connect/webhooks/versions/2026.1/openapi"},{"type":"group","label":"Consignments","link":"/connect/webhooks/versions/2026.1/openapi/consignments","routeSlug":"/connect/webhooks/versions/2026.1/openapi/consignments","items":[{"label":"Proof of Delivery","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/connect/webhooks/versions/2026.1/openapi/consignments/proof_of_delivery_update","routeSlug":"/connect/webhooks/versions/2026.1/openapi/consignments/proof_of_delivery_update","metadata":{"seo":{"title":"Proof of Delivery","description":"Triggered when Scurri retrieves a Proof of Delivery document from a carrier. The payload includes a direct link to retrieve the file, and extra consignment related information."}},"httpPath":"ProofOfDelivery"}]},{"type":"group","label":"Tracking","link":"/connect/webhooks/versions/2026.1/openapi/tracking","routeSlug":"/connect/webhooks/versions/2026.1/openapi/tracking","items":[{"label":"Tracking Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/connect/webhooks/versions/2026.1/openapi/tracking/tracking_update","routeSlug":"/connect/webhooks/versions/2026.1/openapi/tracking/tracking_update","metadata":{"seo":{"title":"Tracking Update","description":"A webhook that is triggered when one or more tracking updates are received from the carrier."}},"httpPath":"TrackingUpdate"}]},{"type":"link","fsPath":"connect/webhooks/retries.md","metadata":{"type":"markdown"},"label":"Proof of Delivery Retries","link":"/connect/webhooks/retries","routeSlug":"/connect/webhooks/retries"},{"type":"link","fsPath":"connect/webhooks/history.md","metadata":{"type":"markdown"},"label":"Version History","link":"/connect/webhooks/history","routeSlug":"/connect/webhooks/history"}]}]}