{"items":[{"type":"link","label":"GLS/NXT OOH Platform Integration REST API","link":"/openapi-carrier-integration-api","routeSlug":"/openapi-carrier-integration-api"},{"type":"link","label":"🚀 Key Capabilities","link":"/openapi-carrier-integration-api/section/key-capabilities","routeSlug":"/openapi-carrier-integration-api/section/key-capabilities"},{"type":"link","label":"🔄 Event-Driven Architecture","link":"/openapi-carrier-integration-api/section/event-driven-architecture","routeSlug":"/openapi-carrier-integration-api/section/event-driven-architecture"},{"type":"link","label":"🛡️ Security & Reliability","link":"/openapi-carrier-integration-api/section/security-and-reliability","routeSlug":"/openapi-carrier-integration-api/section/security-and-reliability"},{"type":"link","label":"🎯 Business Value","link":"/openapi-carrier-integration-api/section/business-value","routeSlug":"/openapi-carrier-integration-api/section/business-value"},{"type":"separator","label":"Introduction"},{"type":"group","label":"Concepts","link":"/openapi-carrier-integration-api/concepts","routeSlug":"/openapi-carrier-integration-api/concepts","items":[]},{"type":"group","label":"Main Features","link":"/openapi-carrier-integration-api/main-features","routeSlug":"/openapi-carrier-integration-api/main-features","items":[{"type":"link","label":"🚚 Operations Overview","link":"/openapi-carrier-integration-api/main-features/operations-overview","routeSlug":"/openapi-carrier-integration-api/main-features/operations-overview"},{"type":"link","label":"📦 Delivery Operations","link":"/openapi-carrier-integration-api/main-features/delivery-operations","routeSlug":"/openapi-carrier-integration-api/main-features/delivery-operations"},{"type":"link","label":"🔄 Return Operations","link":"/openapi-carrier-integration-api/main-features/return-operations","routeSlug":"/openapi-carrier-integration-api/main-features/return-operations"},{"type":"link","label":"🏪 Locker Management","link":"/openapi-carrier-integration-api/main-features/locker-management","routeSlug":"/openapi-carrier-integration-api/main-features/locker-management"},{"type":"link","label":"📋 Parcel Management","link":"/openapi-carrier-integration-api/main-features/parcel-management","routeSlug":"/openapi-carrier-integration-api/main-features/parcel-management"},{"type":"link","label":"🔐 Authentication & Security","link":"/openapi-carrier-integration-api/main-features/authentication-and-security","routeSlug":"/openapi-carrier-integration-api/main-features/authentication-and-security"},{"type":"link","label":"⚠️ Error Handling","link":"/openapi-carrier-integration-api/main-features/error-handling","routeSlug":"/openapi-carrier-integration-api/main-features/error-handling"}]},{"type":"group","label":"Flow Diagrams","link":"/openapi-carrier-integration-api/flow-diagrams","routeSlug":"/openapi-carrier-integration-api/flow-diagrams","items":[{"type":"link","label":"Parcel Booking Flow","link":"/openapi-carrier-integration-api/flow-diagrams/parcel-booking-flow","routeSlug":"/openapi-carrier-integration-api/flow-diagrams/parcel-booking-flow"},{"type":"link","label":"Parcel Cancel Flow","link":"/openapi-carrier-integration-api/flow-diagrams/parcel-cancel-flow","routeSlug":"/openapi-carrier-integration-api/flow-diagrams/parcel-cancel-flow"},{"type":"link","label":"Courier Collection/Delivery Flow","link":"/openapi-carrier-integration-api/flow-diagrams/courier-collectiondelivery-flow","routeSlug":"/openapi-carrier-integration-api/flow-diagrams/courier-collectiondelivery-flow"}]},{"type":"group","label":"Webhooks","link":"/openapi-carrier-integration-api/webhooks","routeSlug":"/openapi-carrier-integration-api/webhooks","items":[]},{"type":"group","label":"Authentication","link":"/openapi-carrier-integration-api/authentication","routeSlug":"/openapi-carrier-integration-api/authentication","items":[]},{"type":"group","label":"Shipment Statuses","link":"/openapi-carrier-integration-api/shipment-statuses","routeSlug":"/openapi-carrier-integration-api/shipment-statuses","items":[{"type":"link","label":"1. Booking","link":"/openapi-carrier-integration-api/shipment-statuses/1.-booking","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/1.-booking"},{"type":"link","label":"BOOKING_PRE_CHECK","link":"/openapi-carrier-integration-api/shipment-statuses/booking_pre_check","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_pre_check"},{"type":"link","label":"BOOKING_REQUESTED","link":"/openapi-carrier-integration-api/shipment-statuses/booking_requested","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_requested"},{"type":"link","label":"BOOKING_CREATED","link":"/openapi-carrier-integration-api/shipment-statuses/booking_created","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_created"},{"type":"link","label":"BOOKING_CANCELLATION_FAILED","link":"/openapi-carrier-integration-api/shipment-statuses/booking_cancellation_failed","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_cancellation_failed"},{"type":"link","label":"BOOKING_EXPIRED","link":"/openapi-carrier-integration-api/shipment-statuses/booking_expired","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_expired"},{"type":"link","label":"BOOKING_CANCELLED ✦ FINAL","link":"/openapi-carrier-integration-api/shipment-statuses/booking_cancelled-final","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_cancelled-final"},{"type":"link","label":"2. Booking Rejections","link":"/openapi-carrier-integration-api/shipment-statuses/2.-booking-rejections","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/2.-booking-rejections"},{"type":"link","label":"BOOKING_REJECTED_DIMENSIONS_EXCEED","link":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_dimensions_exceed","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_dimensions_exceed"},{"type":"link","label":"BOOKING_REJECTED_INVALID_CONSIGNEE","link":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_invalid_consignee","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_invalid_consignee"},{"type":"link","label":"BOOKING_REJECTED_INVALID_LOCKER","link":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_invalid_locker","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_invalid_locker"},{"type":"link","label":"BOOKING_REJECTED_LOCKER_UNAVAILABLE","link":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_locker_unavailable","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_locker_unavailable"},{"type":"link","label":"BOOKING_REJECTED_NO_ACCESSIBLE_COMPARTMENT","link":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_no_accessible_compartment","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_no_accessible_compartment"},{"type":"link","label":"BOOKING_REJECTED_LOCKER_IS_FULL ✦ FINAL","link":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_locker_is_full-final","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_locker_is_full-final"},{"type":"link","label":"BOOKING_REJECTED_NO_FREE_FITTING_COMPARTMENT ✦ FINAL","link":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_no_free_fitting_compartment-final","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_no_free_fitting_compartment-final"},{"type":"link","label":"BOOKING_REJECTED_PROVIDER_ERROR ✦ FINAL","link":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_provider_error-final","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/booking_rejected_provider_error-final"},{"type":"link","label":"3. Delivery to Locker","link":"/openapi-carrier-integration-api/shipment-statuses/3.-delivery-to-locker","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/3.-delivery-to-locker"},{"type":"link","label":"COURIER_DELIVERED","link":"/openapi-carrier-integration-api/shipment-statuses/courier_delivered","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/courier_delivered"},{"type":"link","label":"CONSIGNEE_DELIVERED","link":"/openapi-carrier-integration-api/shipment-statuses/consignee_delivered","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/consignee_delivered"},{"type":"link","label":"COURIER_DELIVERY_LABEL_SCANNED (GLS Germany and GLS Austria only)","link":"/openapi-carrier-integration-api/shipment-statuses/courier_delivery_label_scanned-(gls-germany-and-gls-austria-only)","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/courier_delivery_label_scanned-(gls-germany-and-gls-austria-only)"},{"type":"link","label":"DELIVERY_COMPARTMENT_BROKEN (GLS Germany and GLS Austria only)","link":"/openapi-carrier-integration-api/shipment-statuses/delivery_compartment_broken-(gls-germany-and-gls-austria-only)","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/delivery_compartment_broken-(gls-germany-and-gls-austria-only)"},{"type":"link","label":"DELIVERY_COMPARTMENT_OCCUPIED (GLS Germany and GLS Austria only)","link":"/openapi-carrier-integration-api/shipment-statuses/delivery_compartment_occupied-(gls-germany-and-gls-austria-only)","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/delivery_compartment_occupied-(gls-germany-and-gls-austria-only)"},{"type":"link","label":"DELIVERY_NOT_POSSIBLE (GLS Germany and GLS Austria only)","link":"/openapi-carrier-integration-api/shipment-statuses/delivery_not_possible-(gls-germany-and-gls-austria-only)","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/delivery_not_possible-(gls-germany-and-gls-austria-only)"},{"type":"link","label":"DELIVERY_PARCEL_TOO_BIG (GLS Germany and GLS Austria only)","link":"/openapi-carrier-integration-api/shipment-statuses/delivery_parcel_too_big-(gls-germany-and-gls-austria-only)","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/delivery_parcel_too_big-(gls-germany-and-gls-austria-only)"},{"type":"link","label":"4. Collection from Locker","link":"/openapi-carrier-integration-api/shipment-statuses/4.-collection-from-locker","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/4.-collection-from-locker"},{"type":"link","label":"CONSIGNEE_COLLECTED ✦ FINAL","link":"/openapi-carrier-integration-api/shipment-statuses/consignee_collected-final","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/consignee_collected-final"},{"type":"link","label":"CONSIGNEE_COLLECTION_EXPIRED","link":"/openapi-carrier-integration-api/shipment-statuses/consignee_collection_expired","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/consignee_collection_expired"},{"type":"link","label":"COURIER_COLLECTED ✦ FINAL","link":"/openapi-carrier-integration-api/shipment-statuses/courier_collected-final","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/courier_collected-final"},{"type":"link","label":"COURIER_COLLECTED_EXPIRED ✦ FINAL","link":"/openapi-carrier-integration-api/shipment-statuses/courier_collected_expired-final","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/courier_collected_expired-final"},{"type":"link","label":"COURIER_COLLECTION_LABEL_SCANNED (GLS Germany and GLS Austria only)","link":"/openapi-carrier-integration-api/shipment-statuses/courier_collection_label_scanned-(gls-germany-and-gls-austria-only)","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/courier_collection_label_scanned-(gls-germany-and-gls-austria-only)"},{"type":"link","label":"COURIER_COLLECTION_LABEL_NOT_AVAILABLE (GLS Germany and GLS Austria only)","link":"/openapi-carrier-integration-api/shipment-statuses/courier_collection_label_not_available-(gls-germany-and-gls-austria-only)","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/courier_collection_label_not_available-(gls-germany-and-gls-austria-only)"},{"type":"link","label":"COLLECTION_COMPARTMENT_BROKEN (GLS Germany and GLS Austria only)","link":"/openapi-carrier-integration-api/shipment-statuses/collection_compartment_broken-(gls-germany-and-gls-austria-only)","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/collection_compartment_broken-(gls-germany-and-gls-austria-only)"},{"type":"link","label":"COLLECTION_NOT_POSSIBLE (GLS Germany and GLS Austria only)","link":"/openapi-carrier-integration-api/shipment-statuses/collection_not_possible-(gls-germany-and-gls-austria-only)","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/collection_not_possible-(gls-germany-and-gls-austria-only)"},{"type":"link","label":"COLLECTION_PARCEL_NOT_AVAILABLE (GLS Germany and GLS Austria only)","link":"/openapi-carrier-integration-api/shipment-statuses/collection_parcel_not_available-(gls-germany-and-gls-austria-only)","routeSlug":"/openapi-carrier-integration-api/shipment-statuses/collection_parcel_not_available-(gls-germany-and-gls-austria-only)"}]},{"type":"separator","label":"Endpoints"},{"type":"group","label":"Locker API","link":"/openapi-carrier-integration-api/locker-api","routeSlug":"/openapi-carrier-integration-api/locker-api","items":[{"label":"Create a new locker","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-api/createlocker","routeSlug":"/openapi-carrier-integration-api/locker-api/createlocker","metadata":{"seo":{"title":"Create a new locker","description":"Create a new locker with the specified details for the carrier, provider, location, and features."}},"httpPath":"/lockers"},{"label":"Get a list of lockers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-api/listlockers","routeSlug":"/openapi-carrier-integration-api/locker-api/listlockers","metadata":{"seo":{"title":"Get a list of lockers","description":"Retrieve a list of lockers with optional filters such as location, status, carrier, and provider."}},"httpPath":"/lockers"},{"label":"Update a locker","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-api/updatelocker","routeSlug":"/openapi-carrier-integration-api/locker-api/updatelocker","metadata":{"seo":{"title":"Update a locker","description":"Update the details of an existing locker, including carrier details, provider details, location, and features."}},"httpPath":"/lockers/{uid}"},{"label":"Get lockers by UIDs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-api/getlockersbyuids","routeSlug":"/openapi-carrier-integration-api/locker-api/getlockersbyuids","metadata":{"seo":{"title":"Get lockers by UIDs","description":"Retrieve one or more lockers by their UIDs in a single request."}},"httpPath":"/lockers/by-uid"},{"label":"Get lockers by carrier locker ids","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-api/getlockersbycarrierlockerids","routeSlug":"/openapi-carrier-integration-api/locker-api/getlockersbycarrierlockerids","metadata":{"seo":{"title":"Get lockers by carrier locker ids","description":"Retrieve one or more lockers by their carrier locker ids in a single request."}},"httpPath":"/lockers/by-carrier-locker-id"},{"label":"Get a list of existing locker model and locker version pairs for provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-api/listlockerproviders","routeSlug":"/openapi-carrier-integration-api/locker-api/listlockerproviders","metadata":{"seo":{"title":"Get a list of existing locker model and locker version pairs for provider","description":"Retrieve a list of existing locker model and locker version pairs for each provider."}},"httpPath":"/lockers/providers"},{"label":"Update Locker Status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-api/updatelockerstatus","routeSlug":"/openapi-carrier-integration-api/locker-api/updatelockerstatus","metadata":{"seo":{"title":"Update Locker Status","description":"Update the status of an existing locker."}},"httpPath":"/lockers/status"}]},{"type":"group","label":"Locker Group API","link":"/openapi-carrier-integration-api/locker-group-api","routeSlug":"/openapi-carrier-integration-api/locker-group-api","items":[{"label":"Get available locker group types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-group-api/listlockergrouptypes","routeSlug":"/openapi-carrier-integration-api/locker-group-api/listlockergrouptypes","metadata":{"seo":{"title":"Get available locker group types","description":"Returns the global catalog of locker group types that can be used to create locker groups."}},"httpPath":"/locker-groups/types"},{"label":"Get a list of locker groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-group-api/listlockergroups","routeSlug":"/openapi-carrier-integration-api/locker-group-api/listlockergroups","metadata":{"seo":{"title":"Get a list of locker groups","description":"Returns the carrier's locker groups, optionally filtered by type key and name."}},"httpPath":"/locker-groups"},{"label":"Create a locker group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-group-api/createlockergroup","routeSlug":"/openapi-carrier-integration-api/locker-group-api/createlockergroup","metadata":{"seo":{"title":"Create a locker group","description":"Creates a new locker group for the carrier."}},"httpPath":"/locker-groups"},{"label":"Get a specific locker group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-group-api/getlockergroup","routeSlug":"/openapi-carrier-integration-api/locker-group-api/getlockergroup","metadata":{"seo":{"title":"Get a specific locker group","description":"Retrieve details of a specific locker group by its unique identifier."}},"httpPath":"/locker-groups/{uid}"},{"label":"Update a locker group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-group-api/updatelockergroup","routeSlug":"/openapi-carrier-integration-api/locker-group-api/updatelockergroup","metadata":{"seo":{"title":"Update a locker group","description":"Updates the name of an existing locker group."}},"httpPath":"/locker-groups/{uid}"},{"label":"Delete a locker group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-group-api/deletelockergroup","routeSlug":"/openapi-carrier-integration-api/locker-group-api/deletelockergroup","metadata":{"seo":{"title":"Delete a locker group","description":"Deletes a locker group owned by the carrier."}},"httpPath":"/locker-groups/{uid}"},{"label":"Assign lockers to a locker group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-group-api/addlockergrouplockers","routeSlug":"/openapi-carrier-integration-api/locker-group-api/addlockergrouplockers","metadata":{"seo":{"title":"Assign lockers to a locker group","description":"Assigns the carrier's lockers to the locker group. A locker may belong to at most one group per type key."}},"httpPath":"/locker-groups/{uid}/lockers"},{"label":"Remove lockers from a locker group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/locker-group-api/removelockergrouplockers","routeSlug":"/openapi-carrier-integration-api/locker-group-api/removelockergrouplockers","metadata":{"seo":{"title":"Remove lockers from a locker group","description":"Removes the specified lockers from the locker group."}},"httpPath":"/locker-groups/{uid}/lockers"}]},{"type":"group","label":"Network API","link":"/openapi-carrier-integration-api/network-api","routeSlug":"/openapi-carrier-integration-api/network-api","items":[{"label":"Get a list of networks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/network-api/listnetworks","routeSlug":"/openapi-carrier-integration-api/network-api/listnetworks","metadata":{"seo":{"title":"Get a list of networks","description":"Returns all networks where the carrier is the owner or tenant."}},"httpPath":"/networks"},{"label":"Get a specific network","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/network-api/getnetwork","routeSlug":"/openapi-carrier-integration-api/network-api/getnetwork","metadata":{"seo":{"title":"Get a specific network","description":"Retrieve details of a specific network by its unique identifier."}},"httpPath":"/networks/{uid}"},{"label":"Delete a network","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/network-api/deletenetwork","routeSlug":"/openapi-carrier-integration-api/network-api/deletenetwork","metadata":{"seo":{"title":"Delete a network","description":"Deletes a network. Fails if any lockers are still in ACCEPTED status."}},"httpPath":"/networks/{uid}"},{"label":"Get lockers in a network","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/network-api/listnetworklockers","routeSlug":"/openapi-carrier-integration-api/network-api/listnetworklockers","metadata":{"seo":{"title":"Get lockers in a network","description":"Retrieve a paginated list of lockers within a network with optional filtering and sorting."}},"httpPath":"/networks/{uid}/lockers"},{"label":"Add lockers to a network","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/network-api/addnetworklockers","routeSlug":"/openapi-carrier-integration-api/network-api/addnetworklockers","metadata":{"seo":{"title":"Add lockers to a network","description":"Adds lockers owned by the carrier to the network. Lockers not owned by the carrier are silently skipped."}},"httpPath":"/networks/{uid}/lockers"},{"label":"Remove lockers from a network","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/network-api/removenetworklockers","routeSlug":"/openapi-carrier-integration-api/network-api/removenetworklockers","metadata":{"seo":{"title":"Remove lockers from a network","description":"Removes the specified lockers from the network."}},"httpPath":"/networks/{uid}/lockers"},{"label":"Update a network locker","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/network-api/updatenetworklocker","routeSlug":"/openapi-carrier-integration-api/network-api/updatenetworklocker","metadata":{"seo":{"title":"Update a network locker","description":"Updates the status of a locker within a network, optionally including carrier details."}},"httpPath":"/networks/{uid}/lockers/{lockerUid}"}]},{"type":"group","label":"Parcel API","link":"/openapi-carrier-integration-api/parcel-api","routeSlug":"/openapi-carrier-integration-api/parcel-api","items":[{"label":"Publish parcel data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/parcel-api/publishparceldata","routeSlug":"/openapi-carrier-integration-api/parcel-api/publishparceldata","metadata":{"seo":{"title":"Publish parcel data","description":"This endpoint allows the Carriers to publish parcel data into the OOH Platform. It should be used to push parcel data at the time when the locker booking is expected to take place or to pre-check if a parcel can be accepted in the locker."}},"httpPath":"/parcels/data"},{"label":"Publish parcel data with carrier locker id","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/parcel-api/publishparceldatabytenantid","routeSlug":"/openapi-carrier-integration-api/parcel-api/publishparceldatabytenantid","metadata":{"seo":{"title":"Publish parcel data with carrier locker id","description":"This endpoint is an alternative to /parcels/data endpoint and could be used to publish parcel data using carrierLockerId instead of lockerUid."}},"httpPath":"/parcels/data/by-tenant-locker-id"},{"label":"Get parcels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/parcel-api/getparcels","routeSlug":"/openapi-carrier-integration-api/parcel-api/getparcels","metadata":{"seo":{"title":"Get parcels","description":"Retrieve a list of parcels associated with the carrier. This endpoint allows fetching detailed information about parcels, including their status and history."}},"httpPath":"/parcels"},{"label":"Get parcels (v2)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/parcel-api/getparcelsv2","routeSlug":"/openapi-carrier-integration-api/parcel-api/getparcelsv2","metadata":{"seo":{"title":"Get parcels (v2)","description":"Retrieve a paginated list of parcels associated with the carrier, filterable by locker and/or parcel IDs."}},"httpPath":"/v2/parcels"},{"label":"Cancel parcel","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/parcel-api/cancelparcel","routeSlug":"/openapi-carrier-integration-api/parcel-api/cancelparcel","metadata":{"seo":{"title":"Cancel parcel","description":"Cancel the booking of a specific parcel. Only parcels that haven’t been delivered can be cancelled. This endpoint allows carriers to manage cancellations effectively."}},"httpPath":"/parcels/{parcelId}"}]},{"type":"separator","label":"Webhooks"},{"type":"group","label":"Locker Events","link":"/openapi-carrier-integration-api/locker-events","routeSlug":"/openapi-carrier-integration-api/locker-events","items":[{"label":"Webhook for locker updates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi-carrier-integration-api/locker-events/webhooklockerupdates","routeSlug":"/openapi-carrier-integration-api/locker-events/webhooklockerupdates","metadata":{"seo":{"title":"Webhook for locker updates","description":"Webhook to push locker updates to any URL provided by the carrier. This endpoint allows carriers to receive real-time updates about lockers."}},"httpPath":"LockerUpdates"}]},{"type":"group","label":"Parcel Events","link":"/openapi-carrier-integration-api/parcel-events","routeSlug":"/openapi-carrier-integration-api/parcel-events","items":[{"label":"Webhook for parcel updates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi-carrier-integration-api/parcel-events/webhookparcelupdates","routeSlug":"/openapi-carrier-integration-api/parcel-events/webhookparcelupdates","metadata":{"seo":{"title":"Webhook for parcel updates","description":"Webhook to push parcel updates to any URL provided by the carrier. This endpoint allows carriers to receive real-time updates about parcels."}},"httpPath":"ParcelUpdates"}]},{"type":"group","label":"Collection Events","link":"/openapi-carrier-integration-api/collection-events","routeSlug":"/openapi-carrier-integration-api/collection-events","items":[{"label":"Webhook for pickup notifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi-carrier-integration-api/collection-events/webhookcollectionnotifications","routeSlug":"/openapi-carrier-integration-api/collection-events/webhookcollectionnotifications","metadata":{"seo":{"title":"Webhook for pickup notifications","description":"Webhook to push collection notifications to any URL provided by the carrier. Notifications are sent once per day, informing the carrier about parcels that need to be picked up from the lockers."}},"httpPath":"CollectionNotification"}]},{"type":"separator","label":"Testing"},{"type":"group","label":"Testing guide","link":"/openapi-carrier-integration-api/testing-guide","routeSlug":"/openapi-carrier-integration-api/testing-guide","items":[{"type":"link","label":"1. Setup","link":"/openapi-carrier-integration-api/testing-guide/1.-setup","routeSlug":"/openapi-carrier-integration-api/testing-guide/1.-setup"},{"type":"link","label":"2. What you can do","link":"/openapi-carrier-integration-api/testing-guide/2.-what-you-can-do","routeSlug":"/openapi-carrier-integration-api/testing-guide/2.-what-you-can-do"},{"type":"link","label":"2.1 Create last-mile bookings with depth parameters to trigger scenarios","link":"/openapi-carrier-integration-api/testing-guide/2.1-create-last-mile-bookings-with-depth-parameters-to-trigger-scenarios","routeSlug":"/openapi-carrier-integration-api/testing-guide/2.1-create-last-mile-bookings-with-depth-parameters-to-trigger-scenarios"},{"type":"link","label":"Sequence codes","link":"/openapi-carrier-integration-api/testing-guide/sequence-codes","routeSlug":"/openapi-carrier-integration-api/testing-guide/sequence-codes"},{"type":"link","label":"2.2 Trigger first-mile specific scenarios","link":"/openapi-carrier-integration-api/testing-guide/2.2-trigger-first-mile-specific-scenarios","routeSlug":"/openapi-carrier-integration-api/testing-guide/2.2-trigger-first-mile-specific-scenarios"},{"type":"link","label":"2.3 Trigger individual parcel or locker events","link":"/openapi-carrier-integration-api/testing-guide/2.3-trigger-individual-parcel-or-locker-events","routeSlug":"/openapi-carrier-integration-api/testing-guide/2.3-trigger-individual-parcel-or-locker-events"},{"type":"link","label":"Limitations","link":"/openapi-carrier-integration-api/testing-guide/limitations","routeSlug":"/openapi-carrier-integration-api/testing-guide/limitations"}]},{"type":"group","label":"Mock Service API","link":"/openapi-carrier-integration-api/mock-service-api","routeSlug":"/openapi-carrier-integration-api/mock-service-api","items":[{"label":"Trigger first-mile event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/mock-service-api/triggerfirstmileevent","routeSlug":"/openapi-carrier-integration-api/mock-service-api/triggerfirstmileevent","metadata":{"seo":{"title":"Trigger first-mile event","description":"Triggers one first-mile parcel event for the selected provider and carrier."}},"httpPath":"/parcel/first-mile/event"},{"label":"Trigger first-mile sequence","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/mock-service-api/triggerfirstmilesequence","routeSlug":"/openapi-carrier-integration-api/mock-service-api/triggerfirstmilesequence","metadata":{"seo":{"title":"Trigger first-mile sequence","description":"Triggers a full first-mile event sequence. Do not send event_type. The service chooses the sequence."}},"httpPath":"/parcel/first-mile/sequence"},{"label":"Trigger last-mile event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/mock-service-api/triggerlastmileevent","routeSlug":"/openapi-carrier-integration-api/mock-service-api/triggerlastmileevent","metadata":{"seo":{"title":"Trigger last-mile event","description":"Triggers one last-mile parcel event for the selected provider and carrier.Sending COURIER_DELIVERED as the first event for a given parcel_id creates the booking and sets that status in one step.If the first event sent for a parcel_id is anything other than COURIER_DELIVERED, it is ignored.Once COURIER_DELIVERED has been triggered, send further calls with later statuses to advance the same shipment."}},"httpPath":"/parcel/last-mile/event"},{"label":"Trigger locker event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-carrier-integration-api/mock-service-api/triggerlockerevent","routeSlug":"/openapi-carrier-integration-api/mock-service-api/triggerlockerevent","metadata":{"seo":{"title":"Trigger locker event","description":"Triggers a locker status event for the specified provider.For AMAZON_DE and CAINIAO_FR, include provider_payload.GLS/NXT supplies the required payload.Other providers do not need provider_payload."}},"httpPath":"/locker/event"}]}]}