Welcome to the Sodtrack Integration API Documentation β your comprehensive guide to integrating seamlessly with Sodtrackβs Service Management ecosystem.
\nThe Sodtrack API enables organizations to connect their systems directly with Sodtrackβs operational platform, facilitating real-time automation of service bookings, project management, lead generation, and contractor coordination.
\nDesigned for scalability, security, and efficiency, this API provides the foundation for integrating Sodtrackβs core functionalities β including scheduling, catalog synchronization, coverage validation, and transactional workflows β into your existing business processes or digital channels.
\nAuthentication and Security: Token-based access using JWT for secure API communication.
\nService Catalog: Retrieve and manage categories, services, and variants available in the Sodtrack ecosystem.
\nCoverage and Availability: Validate geographical coverage and check contractor or time-slot availability in real time.
\nBookings: Create, update, and manage service bookings directly from your systems.
\nProjects and Transactions: Link multiple bookings under project stages, attach documentation, register payments, and synchronize task updates.
\nLead Management: Integrate Sodtrack lead forms and dynamically capture customer interest data.
\nExamples of enviromnents; the actual Base URL to be used will be shared by the integration team.
\nIf you require support during your integration, our technical team is available to assist with API setup, authentication, and best practices.
\nπ© Contact: integrations@sodtrack.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"30960189","collectionId":"cc318f6e-0b51-4254-be86-c090e307212f","publishedId":"2sAY4uEPfU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"01A797"},"publishDate":"2025-02-18T18:51:22.000Z"},"item":[{"name":"π Authentication","item":[{"name":"Get token","event":[{"listen":"test","script":{"id":"cb5be779-9350-4eaf-96e7-ab1ed7b6f9d3","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"563fe841-dee2-4aec-b1df-0569e1359291","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"","description":"string
\nAPI Key provided by Sodtrack. This key identifies and authenticates your integration.
\n","type":"text"},{"key":"origin","value":"","description":"string
\nThe origin domain or identifier associated with your Sodtrack API access (e.g., dev.api.cl.sodtrack.sodtrack.com).
\n","type":"text"}],"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/api/authentication/generateJWT","description":"Generates a JSON Web Token (JWT) that must be included in the header of all subsequent API requests to access protected resources.
\nEach token is issued using the API Key and Origin assigned to your organization. Tokens are time-limited and must be regenerated upon expiration.
\nOnce generated, include the JWT in the Authorization header for all API calls:
Authorization: Bearer {token}\n\nπ Treat your API Key and JWT as sensitive credentials.
\nβ± Refresh tokens periodically before expiration to avoid interruptions in service.
\nβ Do not expose your credentials in client-side applications, browser code, or public repositories.
\nβ Use secure HTTPS connections at all times.
\nAuthentication is the foundation for securely interacting with the Sodtrack Integration API.
\nAll API requests must be authenticated using a JSON Web Token (JWT) obtained through the authentication endpoint described below.
\nThis token ensures that each integration communicates securely with Sodtrackβs infrastructure and that access is restricted to authorized systems.
\n","_postman_id":"5315a0c9-b1b4-4f7e-b785-a511ae25c959","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"cc318f6e-0b51-4254-be86-c090e307212f","id":"cc318f6e-0b51-4254-be86-c090e307212f","name":"Sodtrack Integration API","type":"collection"}}},{"name":"Bookings","item":[{"name":"Create booking","id":"c399461e-27df-4154-a940-43a6b7b8f3a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"origin","value":"","type":"text"}],"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/api/integration/booking/v2","description":"Creates one or more new bookings in Sodtrack.
\nThis endpoint supports batch creation, allowing a single request to include multiple services in the data array.
When multiple service entries are provided, Sodtrack automatically determines whether they can be grouped under a single provider and appointment slot.
\nIf grouping is not possible (due to scheduling, coverage, or provider constraints), individual ungrouped bookings will be created.
\nBookings can be created in a specific project: you can send a project identifier (project), optionally with a shopping cart within that project (project.shoppingCart), or a root-level shopping cart id (shoppingCartId) for compatibility. When project is present, it takes precedence and the shopping cart is resolved from the project (see Project and shopping cart resolution in Business Rules).
\n\n<h4 >If customer is new, one of email, reference or identification numbers should be provided, in order to generate a temporary email for that customer</h4>
\n
\n\n<h4 >If stakeholder is new, one of email, reference or identification number should be provided.</h4>
\n
\n\nIf coordinates are not provided, Sodtrack attempts to geocode the address automatically when geo-reference is part of your subscription.
\n
If geocoding fails, the booking will be created without a map location and must be manually geolocated by an administrator before provider assignment.
\n\nIf coordinates are not provided, Sodtrack attempts to geocode the address automatically when geo-reference is part of your subscription.
\n
If geocoding fails, the booking will be created without a map location and must be manually geolocated by an administrator before provider assignment.
When multiple items are included in the data array (length > 1), Sodtrack automatically determines whether they can be grouped under a single booking (same provider/date).
If grouping is not possible, individual bookings are created for each service item.
\n{\n \"customer\": {\n \"name\": \"MarΓa\",\n \"lastName\": \"GarcΓa\",\n \"identificationNumber\": \"12345678-9\",\n \"identificationNumberCountry\": \"CL\",\n \"phoneNumber\": \"+56912345678\",\n \"email\": \"maria.garcia@example.com\"\n },\n \"address\": {\n \"address\": \"Av. Providencia 1234, Santiago\",\n \"extraInfo\": \"Depto 501\",\n \"coordinate\": {\n \"lat\": -33.43324794409109,\n \"lng\": -70.58645659063548\n }\n },\n \"data\": [\n {\n \"variant\": {\n \"type\": \"variantSku\",\n \"value\": \"install_curtains_sku\",\n \"quantity\": 2,\n \"price\": 150000,\n \"cost\": 80000\n }\n }\n ],\n \"dateAssignment\": {\n \"type\": \"direct\",\n \"date\": \"2025-03-15T09:00:00.000Z\"\n },\n \"providerAssignment\": {\n \"type\": \"direct\",\n \"provider\": {\n \"type\": \"providerId\",\n \"value\": \"42\"\n }\n },\n \"reference\": \"ORD-2025-001\",\n \"saleChannelId\": 1,\n \"project\": {\n \"type\": \"projectReference\",\n \"value\": \"PROJ-EXT-100\"\n },\n \"useStrictCoverageValidationMode\": true\n}\n\n{\n \"customer\": { \"name\": \"MarΓa\", \"lastName\": \"GarcΓa\", \"email\": \"maria@example.com\" },\n \"address\": { \"address\": \"Av. Providencia 1234, Santiago\", \"coordinate\": { \"lat\": -33.43, \"lng\": -70.58 } },\n \"data\": [{ \"variant\": { \"type\": \"variantSku\", \"value\": \"install_curtains_sku\", \"quantity\": 1 } }],\n \"saleChannelId\": 1,\n \"project\": {\n \"type\": \"projectReference\",\n \"value\": \"PROJ-EXT-100\",\n \"shoppingCart\": {\n \"type\": \"shoppingCartReference\",\n \"value\": \"STAGE-ORDER-2025-001\"\n }\n }\n}\n\nWhen no cart exists in the project with reference STAGE-ORDER-2025-001, Sodtrack creates a new shopping cart with that reference and attaches the bookings to it.
{\n \"customer\": {\n \"name\": \"Juan PΓ©rez\"\n },\n \"address\": {\n \"address\": \"Calle Principal 100, Ciudad\"\n },\n \"data\": [\n {\n \"variant\": {\n \"type\": \"variantId\",\n \"value\": \"321\",\n \"quantity\": 1\n }\n }\n ],\n \"saleChannelId\": 1\n}\n\n{\n \"bookings\": [\n {\n \"id\": 10452,\n \"quantity\": 2,\n \"variantSku\": [\"install_curtains_sku\"],\n \"variantId\": 321\n }\n ]\n}\n\nYou can target a project and optionally a shopping cart within it, or use a root-level shopping cart id for compatibility.
\nproject (without project.shoppingCart): Send a project identifier (projectId or projectReference). Sodtrack resolves the project and then uses the latest shopping cart linked to that project. If the project has no shopping cart, a new shopping cart is created for that project and the bookings are attached to it.
project with project.shoppingCart: In addition to the project, you can target a specific cart within that project:
type = \"shoppingCartId\": Sodtrack looks up the shopping cart by project and cart ID. If no cart is found with that ID in the project, it falls back to the latest shopping cart of the project.
type = \"shoppingCartReference\": Sodtrack looks up the shopping cart by project and cart reference. If no cart is found with that reference, it creates a new shopping cart for the project with the given reference (and uses it for the bookings). The new cartβs stage name is derived from the project name and the reference.
When neither project is not sent, Sodtrack creates the bookings without attaching them to a project; further behavior depends on your configuration.
When project.shoppingCart is provided:
shoppingCartId****: Sodtrack looks up the cart by project and cart ID. If not found, it falls back to the latest shopping cart of the project.
shoppingCartReference****: Sodtrack looks up the cart by project and cart reference. If not found, it creates a new shopping cart for that project with the given reference and uses it for the bookings.
When dateAssignment is sent, type determines how the booking date is handled. Scheduling (assigning date and provider) only runs when both dateAssignment and providerAssignment are present and the system can complete the assignment (see Booking or bundle scheduling logic).
direct: The booking is scheduled to a specific date and time. date is required when scheduling is performed (ISO 8601). Optionally, timeRange can be sent to specify a time slot within the day by timeRangeId or timeRangeIndex. If date is missing when the system attempts to schedule, the scheduling step is skipped and the information is stored in a note on the booking.
userScheduling: The user will choose the date later (e.g. via web or app). No immediate date is assigned. userScheduling is the preferred value; date and timeRange are not used for scheduling when this type is set.
onDemand: The service is on-demand; date assignment is handled accordingly by the platform. date and timeRange are not used for direct scheduling.
providerScheduling: The provider will determine or propose the date to the client. No immediate date is assigned from the request. date and timeRange are not used for direct scheduling.
When date definition cannot be completed (e.g. address not geo-referenced, or provider assignment missing/failed), Sodtrack still creates the bookings and stores the scheduling information in a note so it is not lost.
\nIf no valid coordinates are available for address, and for originAddress when provided, bookings remain unassigned until manually updated.
Provided addresses go through a resolution process to determine coordinates depending on the associateToCustomer value and whether the geo-reference intent is part of your subscription.
The system does not call the partner geocoding API. Addresses are used as provided; coordinates remain unchanged. Bookings that require coverage validation follow the non-georeferenced flow (see Strict mode / Best effort mode).
\nIf no coordinates are provided for the address, the system uses the address attribute of the provided address object and requests a match with coordinates from a partner API.
If exactly one match is returned, the system uses those coordinates for all subsequent validation steps, including the associateToCustomer = true step.
If no match is returned or the partner API errors, the address remains without coordinates; resolution does not retry and the request continues with the unresolved address.
\nassociateToCustomer = true:If the provided customer already exists, the platform attempts to find an existing address for that customer and reuse it. Address matching requires exact match of extraInfo (after normalization: trim, null/undefined treated as empty) and at least one of the following:
The address attribute of the provided address equals the existing address's address.
The provided coordinates are within a 3 meter radius of the existing address's coordinates.
If a matching existing address is found, its coordinates and address fields are used for coverage and validations. If not, the address is created or updated as provided (and optionally geocoded when geo-reference intent is enabled).
\nDestination address: associateToCustomer defaults to true when omitted.
Origin address: associateToCustomer defaults to false when omitted.
When the bundling capability is part of your subscription and multiple bookings are created in a single request, Sodtrack validates and creates a single bundle when possible. Bundling is all-or-nothing: the criteria must be satisfied for all created bookings in the request for a bundle to be created.
\nBundling validation rules:
\nThe provided address has coordinates after the address resolution process.
At least one technician is correctly configured to execute all bookings at that address.
If bundle creation fails (e.g. validation or provider constraints) bookings are still created and returned, and scheduling or note creation still runs.
\nScheduling a booking (or the head of a bundle) requires both dateAssignment and providerAssignment in the request when the system is able to assign date and provider (see below).
When the date definition for a booking or bundle cannot be completed or fails, and dateAssignment was provided, Sodtrack creates a note on that booking with the scheduling information so it is not lost. This happens when:
providerAssignment is missing.
providerAssignment was provided but date/provider assignment fails (e.g. no availability for the given technician).
The destination address is not geo-referenced (no coordinates after resolution).
originAddress is provided and is not geo-referenced (no coordinates after resolution).
In all of the above cases, bookings are already created; only the assignment step is skipped and replaced by the note.
\nThe behavior of the booking creation flow depends on two factors:
\nWhether the required addresses were successfully resolved with coordinates.
\nThe configured mode (useStrictCoverageValidationMode).
If a required address (destination and/or origin, depending on the variant rules) is not resolved with coordinates:
\nCoverage validations are not executed.
\nBookings are still created.
\nThese bookings are expected to be managed later through the web administrator.
\nThis behavior is the same in both Strict and Best Effort modes.
The selected mode does not affect this scenario.
\n\n<h4 >Bookings created without address coordinates will require manual resolution and add operational overhead for each case.</h4>
\n
If the required addresses are successfully resolved with coordinates, full validation is executed (variant existence, operation areas, coverage by destination/origin when required, addons, etc.).
\nAt this point, the behavior depends on the selected mode.
\nuseStrictCoverageValidationMode: true (default)
All-or-nothing behavior.
\nIf any validation fails (for example, no coverage for a georeferenced address):
\nNo bookings are created.
\nThe request returns a 400 error.
\nNo partial creation is allowed.
\nThis mode guarantees that:
\nAll requested variants exist.
\nAll variants have an operation area.
\nGeoreferenced addresses have coverage when required.
\nAddons are valid, applicable and have coverage.
\nIf any of these conditions fail, the entire request is rejected.
\n\n\nThis mode mirrors the creation through the administrator web UI, preventing the creation of bookings that could not be satisfied with the current state of configurations.
\n
useStrictCoverageValidationMode: false
Partial success is allowed.
\nValidation and coverage checks are executed, but failures do not abort the entire request.
\nWhen coordinates are resolved:
\nIf a variant does not exist β it is skipped.
\nIf a variant has no operation area β it is skipped.
\nIf a variant has no coverage β that booking may be skipped.
\nIf an addon does not exist or has no coverage β it is not added to the booking.
\nThe process continues with all other valid lines.
\nOnly successfully created bookings are returned in the response.
\n\n\nThis mode allows the consumer to create as many valid bookings and their addons as possible, even if there is no coverage and operational overhead will be needed to handle some cases.
\n
Optional stakeholders array; only the first element is used and is applied to all created bookings.
Link existing: If stakeholderId is provided, Sodtrack resolves it. If the stakeholder is not found, an error is logged and no stakeholder is set on the bookings; the request is not aborted (strict and best effort).
Create new: If stakeholderId is omitted but identifying data (e.g. name) is provided, a new stakeholder is created and its ID is used for all created bookings.
Dynamic form data is stored and linked to each booking for later retrieval.
\nAll timestamps follow the ISO 8601 format (UTC).
\nId of the booking of which the referece should be updated
\n","type":"text/plain"},"type":"any","value":"2343","key":"bookingId"}]}},"response":[{"id":"38452203-659f-44b3-85c3-1aef0e921e74","name":"Update reference","originalRequest":{"method":"PATCH","header":[{"key":"Origin","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reference\": \"2441242KKDSD-DSFS984\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/api/integration/booking/:bookingId/reference","host":["https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com"],"path":["api","integration","booking",":bookingId","reference"],"variable":[{"key":"bookingId","value":"2343","description":"Id of the booking of which the referece should be updated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"bf3ca6aa-a0d9-43fe-b449-7ae480e770ba"},{"name":"Cancel Booking","id":"4f87a878-8bab-48ce-8eaa-d9d2a877a132","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PATCH","header":[{"key":"origin","value":"","type":"text"}],"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/api/integration/booking/cancel","description":"This endpoint cancels an existing booking through the Integration API. The booking is identified in the request body by either booking ID or booking reference.
\nThe endpoint optionally accepts dynamic form answers, for forms associated to the booking cancellation flow.
\nThe booking must exist (bookingId or bookingReference lookup). If not found, the endpoint returns BOOKING_NOT_FOUND_FOR_ID (when identifying by ID) or BOOKING_NOT_FOUND_FOR_REFERENCE (when identifying by reference).
When identifying by bookingReference, the reference must resolve to exactly one booking. If multiple bookings share the same reference, the endpoint returns MULTIPLE_BOOKINGS_FOUND_FOR_REFERENCE.
When identifying by bookingId, the value must be a valid numeric ID. Invalid values return INVALID_BOOKING_ID.
The booking must be in a cancellable status. Bookings in any of the following statuses cannot be cancelled: ON_MY_WAY_TO_ORIGIN, ARRIVED_TO_ORIGIN, ON_MY_WAY, ARRIVED_TO_DESTINATION, DONE, CANCELLED. If the booking is in one of these statuses, the endpoint returns 400 Bad Request with message \"Booking cannot be cancelled\".
dynamicForms is optional, and need an actual dynamic form configured in the platform. The dynamic form has to be associated to the booking cancellation flow and must to have references, at form and fields level, for each of the fields sent in the payload.
{\n \"booking\": {\n \"type\": \"bookingReference\",\n \"value\": \"BOOK-EXT-789\"\n },\n \"dynamicForms\": [\n {\n \"formReference\": \"booking-cancel-reasons-v1\",\n \"values\": [\n {\n \"fieldReference\": \"cancel_reason\",\n \"value\": \"customer_request\"\n },\n {\n \"fieldReference\": \"cancel_details\",\n \"value\": \"Customer requested cancellation via external system.\"\n }\n ]\n }\n ]\n}\n\nHTTP/1.1 200 OK\nContent-Type: application/json\n\nBooking not found (by ID):
\n{\n \"statusCode\": 404,\n \"message\": \"BOOKING_NOT_FOUND_FOR_ID\",\n \"error\": \"Not Found\"\n}\n\nBooking not found (by reference):
\n{\n \"statusCode\": 404,\n \"message\": \"BOOKING_NOT_FOUND_FOR_REFERENCE\",\n \"error\": \"Not Found\"\n}\n\nMultiple bookings for same reference:
\n{\n \"statusCode\": 400,\n \"message\": \"MULTIPLE_BOOKINGS_FOUND_FOR_REFERENCE\",\n \"error\": \"Bad Request\"\n}\n\nInvalid booking ID (non-numeric):
\n{\n \"statusCode\": 400,\n \"message\": \"INVALID_BOOKING_ID\",\n \"error\": \"Bad Request\"\n}\n\nBooking cannot be cancelled (status not allowed):
\n{\n \"statusCode\": 400,\n \"message\": \"Booking cannot be cancelled\",\n \"error\": \"Bad Request\"\n}\n\nThe bookings section is a key component of Sodtrack's flow and API. Here, you will find the endpoint for creating reservations, an essential process for managing your operations. Make sure to follow the required parameters and structure to ensure successful requests.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"3bcfd603-cfdc-4dfb-990e-2144ac4fb271","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"3adee320-3a19-4667-8945-cbaf0c7c0bd1","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"859666ca-6988-492d-8578-94d0b6272424"},{"name":"Projects","item":[{"name":"Project Creation","id":"041b6b56-2265-4810-90ed-7ffe5a267541","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"origin","value":"","type":"text"}],"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/api/integration/project","description":"Creates a new project in Sodtrack linked to a customer.
\nThe project is created with the provided name, reference, and optional description. The customer is resolved by reference or email: if an existing customer matches, that customer is linked to the project; otherwise a new customer is created and then linked.
\nProjects created through this endpoint can later be targeted when creating bookings, so that bookings are attached to a stage of that project.
\n\n\n<h4 >If customer is new, one of email, reference or identification numbers should be provided, in order to generate a temporary email for that customer</h4>
\n
{\n \"name\": \"InstalaciΓ³n cortinas - Av. Providencia\",\n \"description\": \"Proyecto creado desde sistema externo\",\n \"reference\": \"PROJ-EXT-100\",\n \"customer\": {\n \"name\": \"MarΓa\",\n \"lastName\": \"GarcΓa\",\n \"identificationNumber\": \"12345678-9\",\n \"identificationNumberCountry\": \"CL\",\n \"phoneNumber\": \"+56912345678\",\n \"email\": \"maria.garcia@example.com\",\n \"reference\": \"CUST-EXT-001\"\n }\n}\n\n{\n \"name\": \"Proyecto ejemplo\",\n \"reference\": \"PROJ-EXT-101\",\n \"customer\": {\n \"name\": \"Juan PΓ©rez\",\n \"email\": \"juanperez@example.com\"\n }\n}\n\n{\n \"id\": 502,\n \"reference\": \"PROJ-EXT-100\"\n}\n\nThe reference must be unique across all projects in Sodtrack.
If a project with the same reference already exists, the request is rejected with PROJECT_REFERENCE_ALREADY_USED and no project is created.
The customer object is used to either link an existing customer or create a new one:
\nExisting customer: Sodtrack searches by reference and email (from the request).
\nIf exactly one customer is found, that customer is linked to the new project.
\nIf more than one customer matches, the request fails with MULTIPLE_CUSTOMERS_FOUND_FOR_REFERENCE. Ensure your external references or emails uniquely identify a single customer.
New customer: If no customer is found, a new customer is created with the provided data. If email is missing or invalid, the system may generate a temporary email so the user can be created; the customer can be updated later (e.g. via the administrator or other APIs).
Creates a new lead in Sodtrack for a given service.
\nThe lead is created with customer information, required qualifying questions (dynamic form field values tied to the serviceβs lead form), and optional provider assignment and dynamic forms (additional info). Address is optional only for in-store services; for non in-store services, a valid location input is required (see Address and coordinates in Business Rules).
\nWhen address is sent without coordinates, Sodtrack may attempt to geocode it automatically (when auto-geocoding is enabled for external integration). For services that are not in-store, the lead creation requires a valid location input: coordinates, address text, or zip code; otherwise the request fails with REQUIRES_ADDRESS_OR_ZIP_CODE (see Address and coordinates in Business Rules).
Provider assignment and dynamic form snapshots are applied after the lead is created; failures in those steps do not fail the requestβthe lead is still returned.
\n\n\nIf coordinates are not provided but
\naddress.addressis sent, Sodtrack may attempt to geocode the address automatically if its part of your active features.
If the service is not in-store and the request has no coordinates, no address text, and no zip code, the request fails withREQUIRES_ADDRESS_OR_ZIP_CODE.
\n\nEach
\nfieldReferencemust correspond to a dynamic field of the lead form associated with the requestβs service. Invalid or mismatched references cause the request to fail withINVALID_QUALIFYING_QUESTION_WITH_ID_REFERENCE.
{\n \"customer\": {\n \"name\": \"MarΓa\",\n \"lastName\": \"GarcΓa\",\n \"phoneNumber\": \"+56912345678\",\n \"email\": \"maria.garcia@example.com\",\n \"reference\": \"CUST-EXT-001\"\n },\n \"address\": {\n \"address\": \"Av. Providencia 1234, Santiago\",\n \"extraInfo\": \"Depto 501\",\n \"coordinate\": {\n \"lat\": -33.4372,\n \"lng\": -70.6506\n },\n \"zipCode\": \"7500000\"\n },\n \"salesChannelId\": 1,\n \"serviceId\": 42,\n \"reference\": \"LEAD-EXT-200\",\n \"qualifyingQuestions\": [\n {\n \"fieldReference\": \"1\",\n \"value\": \"high\"\n }\n ],\n \"providerAssignment\": {\n \"type\": \"direct\",\n \"provider\": {\n \"type\": \"providerId\",\n \"value\": 10\n }\n }\n}\n\n{\n \"customer\": {\n \"name\": \"MarΓa\",\n \"lastName\": \"GarcΓa\",\n \"phoneNumber\": \"+56912345678\",\n \"email\": \"maria.garcia@example.com\",\n \"reference\": \"CUST-EXT-001\"\n },\n \"address\": {\n \"zipCode\": \"7500000\"\n },\n \"salesChannelId\": 1,\n \"serviceId\": 42,\n \"reference\": \"LEAD-EXT-201\",\n \"qualifyingQuestions\": [\n {\n \"fieldReference\": \"1\",\n \"value\": \"high\"\n }\n ]\n}\n\n{\n \"customer\": {\n \"name\": \"Juan PΓ©rez\"\n },\n \"salesChannelId\": 1,\n \"serviceId\": 42,\n \"qualifyingQuestions\": [\n {\n \"fieldReference\": \"1\",\n \"value\": \"high\"\n }\n ]\n}\n\n{\n \"id\": 1001,\n \"customer_id\": 502\n}\n\nserviceId must identify an existing Sodtrack service that has an associated lead form. Otherwise the request fails with INVALID_SERVICE.
salesChannelId must identify an existing sales channel. Otherwise the request fails with INVALID_SALES_CHANNEL.
For in-store services, Sodtrack uses the sales channel address and the request address can be omitted.
For non in-store services, a valid location input is required: coordinates, address text, or zip code.
\nWhen address is sent with coordinate****: The system validate those to be valid coordinates. Otherwise the request fails with INVALID_LATITUDE_OR_LONGITUDE.
When address is sent with address (street) but no coordinates: Sodtrack may attempt to geocode the address automatically when enabled for external integration. If geocoding succeeds, coordinates are filled in; if it fails, they remain missing.
When the service is not an in-store service: The lead creation step requires at least one valid location input: coordinates (address.coordinate), address text (address.address), or zip code (address.zip_code). If none of these are provided, the request fails with REQUIRES_ADDRESS_OR_ZIP_CODE.
Each element in qualifyingQuestions must have a fieldReference that matches a dynamic field of the lead form associated with the requestβs service.
If a fieldReference does not exist or belongs to a different form, the request fails with INVALID_QUALIFYING_QUESTION_WITH_ID_REFERENCE (including the invalid reference or a message that the field is not associated with the serviceβs lead form).
The array can be empty if the lead form has no required qualifying fields.
\nProvider assignment and dynamic form snapshots are applied after the lead is created.
\nFailures during provider assignment or dynamic form creation are logged but do not cause the endpoint to return an error; the response still returns the created lead (id and customer_id).
For direct provider assignment, provider with type and value must be provided; for automatic, no provider object is needed.
reference is an optional external identifier stored with the lead. This endpoint does not enforce uniqueness on reference.All timestamps follow the ISO 8601 format (UTC) where applicable.
\nCustomer and address data are stored as provided; identification country should be ISO 3166-1 alpha-2 where applicable.
\nThis endpoint cancels an existing lead throug## General Description
\nThis endpoint cancels an existing lead through the Integration API. The lead is identified in the request body by either lead ID or lead reference.
\nIn addition to the cancellation comment, the endpoint optionally accepts dynamic form answers in the same external integration format used in booking/lead flows (formReference + values[] with fieldReference and value).
The lead must exist (leadId or leadReference lookup). If not found, the endpoint returns LEAD_NOT_FOUND.
comment is required and is used as the lead cancellation reason.
dynamicForms is optional. When present, each item is transformed into a dynamic form snapshot
Dynamic form snapshot validation is executed before persistence. Invalid form references or invalid values for the fields, return validation/business errors (400 Bad Request).
{\n \"lead\": {\n \"type\": \"leadReference\",\n \"value\": \"LEAD-EXT-342\"\n },\n \"comment\": \"Customer canceled due to schedule conflict.\",\n \"dynamicForms\": [\n {\n \"formReference\": \"lead-cancel-reasons-v1\",\n \"values\": [\n {\n \"fieldReference\": \"cancel_reason\",\n \"value\": \"customer_unavailable\"\n },\n {\n \"fieldReference\": \"cancel_details\",\n \"value\": \"Customer requested cancellation by phone.\"\n }\n ]\n }\n ]\n}\n\nHTTP/1.1 200 OK\n\n{\n \"statusCode\": 400,\n \"message\": \"LEAD_NOT_FOUND\",\n \"error\": \"Bad Request\"\n}\n\nThis endpoint assigns a lead to a specific provider (direct) or switches the lead to automatic provider assignment (automatic). The lead is identified in the request body by either lead ID or lead reference.
The lead must exist (leadId or leadReference lookup). If not found, the endpoint returns LEAD_NOT_FOUND.
For direct assignment:
Provider must be resolvable from provider.type + provider.value.
provider.type must be one of: providerId, providerReference.
Lead status must not be CANCELLED or DONE.
For automatic assignment:
Lead status must not be CANCELLED or DONE.
Lead must not already have a booking or project.
\nIf lead assignment constraints fail, the endpoint returns 400 Bad Request with the corresponding validation/business error.
{\n \"lead\": {\n \"type\": \"leadReference\",\n \"value\": \"LEAD-EXT-001\"\n },\n \"providerAssignment\": {\n \"type\": \"direct\",\n \"provider\": {\n \"type\": \"providerReference\",\n \"value\": \"PROV-001\"\n }\n }\n}\n\n{\n \"lead\": {\n \"type\": \"leadId\",\n \"value\": \"342\"\n },\n \"providerAssignment\": {\n \"type\": \"automatic\"\n }\n}\n\nHTTP/1.1 200 OK\n\n{\n \"statusCode\": 400,\n \"message\": \"Lead cannot be updated to automatic provider assignment, it has a booking already\",\n \"error\": \"Bad Request\"\n}\n\nCreates a new note associated with an existing lead in Sodtrack.
\nThe lead is identified in the request body by either lead ID or lead reference.
The note is created in the context of the issuer user when possible, and an optional reference can be used to correlate the note with an external system.
{\n \"lead\": {\n \"type\": \"leadReference\",\n \"value\": \"LEAD-EXT-342\"\n },\n \"note\": \"Customer requested a callback in the afternoon.\",\n \"issuer\": {\n \"name\": \"Maria\",\n \"lastName\": \"Fernandez\",\n \"email\": \"maria.fernandez@example.com\"\n },\n \"isShareable\": true,\n \"reference\": \"NOTE-EXT-001\"\n}\n{\n \"lead\": {\n \"type\": \"leadId\",\n \"value\": \"5678\"\n },\n \"note\": \"Follow-up call completed.\",\n \"issuer\": {\n \"name\": \"Support\",\n \"lastName\": \"Team\",\n \"email\": \"support@example.com\"\n }\n}\nHTTP/1.1 200 OK\nlead object:type = \"leadId\": value must be a valid lead ID.type = \"leadReference\": value must be a valid lead reference.LEAD_NOT_FOUND and no note is created.The issuer is resolved using issuer.email:
note.user_id = user.id).Created via API).issuer.email:note.user_id = null).name + lastName) is embedded in the note text (e.g. Note by {name} {lastName}: ...).name and lastName should still be provided even when the issuer might not exist in Sodtrack, so the platform can record who authored the note from the external system.
isShareable controls whether the note is shareable/visible according to your Sodtrack configuration.isShareable is omitted, it defaults to true.reference is optional and stored as-is to help correlate notes with external or upstream systems (e.g. ticket IDs, case IDs).reference.This endpoint reinstates a previously cancelled lead. The lead is identified in the request body by either lead ID or lead reference.
\nReinstating a lead rolls it back to its latest non-cancelled status found in lead status history. The lead cancel reason is cleared.
\nThe lead must exist (leadId or leadReference lookup). If not found, the endpoint returns LEAD_NOT_FOUND.
The lead must currently be in status CANCELLED. Otherwise, the endpoint returns LEAD_NOT_IN_CANCELLED_STATUS.
The lead must have at least one non-cancelled status in lead_status_history. Otherwise, the endpoint returns LEAD_HAS_NO_PREVIOUS_STATUS.
On success, the lead status is set to the latest non-cancelled history status and cancelReason is cleared.
{\n \"lead\": {\n \"type\": \"leadReference\",\n \"value\": \"LEAD-EXT-252\"\n }\n}\n\n{\n \"lead\": {\n \"type\": \"leadId\",\n \"value\": \"252\"\n }\n}\n\nHTTP/1.1 200 OK\n\n{\n \"statusCode\": 400,\n \"message\": \"LEAD_NOT_FOUND\",\n \"error\": \"Bad Request\"\n}\n\n{\n \"statusCode\": 400,\n \"message\": \"LEAD_NOT_IN_CANCELLED_STATUS\",\n \"error\": \"Bad Request\"\n}\n\n{\n \"statusCode\": 400,\n \"message\": \"LEAD_HAS_NO_PREVIOUS_STATUS\",\n \"error\": \"Bad Request\"\n}\n\nCreates a new work order in Sodtrack linked to a customer, a provider, and a service variant, and associated with a product (and optionally a product unit).
\nThis endpoint is intended for external systems that manage work-order style operations (e.g. workshop/maintenance) and want to register them in Sodtrack.
\n{\n \"reference\": \"WO-EXT-0001\",\n \"customer\": {\n \"name\": \"MarΓa\",\n \"lastName\": \"GΓ³mez\",\n \"phoneNumber\": \"+541155551111\",\n \"email\": \"maria.gomez@example.com\",\n \"identificationNumber\": \"23456789\",\n \"identificationNumberCountry\": \"AR\",\n \"reference\": \"EXT-CUSTOMER-REF-002\"\n },\n \"provider\": {\n \"basicInformation\": {\n \"name\": \"Taller Motos Racing SRL\",\n \"lastName\": \"Sucursal Centro\",\n \"phoneNumber\": \"+541155552222\",\n \"email\": \"contacto@motosracing.example.com\",\n \"identificationNumber\": \"30555111222\",\n \"identificationNumberCountry\": \"AR\",\n \"reference\": \"PROV-MOTOS-RACING\"\n },\n \"reference\": \"PROV-MOTOS-RACING\",\n \"isCompany\": true\n },\n \"stakeholder\": {\n \"name\": \"Carlos\",\n \"lastname\": \"MecΓ‘nico\",\n \"reference\": \"MECHANIC-CARLOS-MOTOS-RACING\",\n \"email\": \"carlos@example.com\",\n \"phone\": \"+541155553333\"\n },\n \"workOrderServiceVariant\": {\n \"type\": \"variantSku\",\n \"value\": \"SERVICE-MOTO-10000KM\",\n \"quantity\": 1\n },\n \"product\": {\n \"type\": \"productSerialNumber\",\n \"value\": \"VIN-MOTO-NAKED-650-XYZ-1234\"\n },\n \"executionDateTime\": \"2026-03-03T15:30:00.000Z\"\n}\n\n{\n \"id\": 9001,\n \"externalReference\": \"WO-EXT-0001\",\n \"customer\": {\n \"id\": 2001,\n \"name\": \"MarΓa\",\n \"last_name\": \"GΓ³mez\",\n \"email\": \"maria.gomez@motos-example.com\",\n \"phone\": \"+54 11 5555-1111\",\n \"reference\": \"EXT-CUSTOMER-REF-002\"\n },\n \"provider\": {\n \"id\": 3001,\n \"name\": \"Taller Motos Racing SRL\",\n \"reference\": \"PROV-MOTOS-RACING\",\n \"tradeName\": \"Motos Racing\"\n },\n \"stakeholder\": {\n \"id\": \"stakeholder-mecanico-01\",\n \"name\": \"Carlos\",\n \"lastName\": \"MecΓ‘nico\",\n \"reference\": \"MECHANIC-CARLOS-MOTOS-RACING\"\n },\n \"workOrderServiceVariant\": {\n \"id\": 4001,\n \"reference\": \"SERVICE-MOTO-10000KM\",\n \"name\": \"Service 10.000 km motocicleta\",\n \"estimatedDurationMinutes\": 90\n },\n \"product\": {\n \"id\": 5001,\n \"sku\": \"MOTO-NAKED-650\",\n \"name\": \"Yamaha MT-07\",\n \"brand\": \"Yamaha\",\n \"category\": \"MOTOCICLETA\",\n \"description\": \"Service completo de motocicleta naked 650cc\"\n },\n \"productUnit\": {\n \"id\": 6001,\n \"serialNumber\": \"VIN-MOTO-NAKED-650-XYZ-1234\"\n },\n \"executionDateTime\": \"2026-03-03T15:30:00.000Z\"\n}\n\n{\n \"reference\": \"WO-EXT-0001\",\n \"customer\": {\n \"name\": \"MarΓa\",\n \"lastName\": \"GΓ³mez\",\n \"phoneNumber\": \"+541155551111\",\n \"email\": \"maria.gomez@example.com\",\n \"identificationNumber\": \"23456789\",\n \"identificationNumberCountry\": \"AR\",\n \"reference\": \"EXT-CUSTOMER-REF-002\"\n },\n \"provider\": {\n \"basicInformation\": {\n \"name\": \"Taller Motos Racing SRL\",\n \"lastName\": \"Sucursal Centro\",\n \"phoneNumber\": \"+541155552222\",\n \"email\": \"contacto@motosracing.example.com\",\n \"identificationNumber\": \"30555111222\",\n \"identificationNumberCountry\": \"AR\",\n \"reference\": \"PROV-MOTOS-RACING\"\n },\n \"reference\": \"PROV-MOTOS-RACING\",\n \"isCompany\": true\n },\n \"stakeholder\": {\n \"name\": \"Carlos\",\n \"lastname\": \"MecΓ‘nico\",\n \"reference\": \"MECHANIC-CARLOS-MOTOS-RACING\",\n \"email\": \"carlos@example.com\",\n \"phone\": \"+541155553333\"\n },\n \"workOrderServiceVariant\": {\n \"type\": \"variantSku\",\n \"value\": \"SERVICE-MOTO-10000KM\",\n \"quantity\": 1\n },\n \"product\": {\n \"type\": \"productId\",\n \"value\": \"5001\"\n },\n \"executionDateTime\": \"2026-03-03T15:30:00.000Z\"\n}\n\n{\n \"id\": 9001,\n \"externalReference\": \"WO-EXT-0001\",\n \"customer\": {\n \"id\": 2001,\n \"name\": \"MarΓa\",\n \"last_name\": \"GΓ³mez\",\n \"email\": \"maria.gomez@motos-example.com\",\n \"phone\": \"+54 11 5555-1111\",\n \"reference\": \"EXT-CUSTOMER-REF-002\"\n },\n \"provider\": {\n \"id\": 3001,\n \"name\": \"Taller Motos Racing SRL\",\n \"reference\": \"PROV-MOTOS-RACING\",\n \"tradeName\": \"Motos Racing\"\n },\n \"stakeholder\": {\n \"id\": \"stakeholder-mecanico-01\",\n \"name\": \"Carlos\",\n \"lastName\": \"MecΓ‘nico\",\n \"reference\": \"MECHANIC-CARLOS-MOTOS-RACING\"\n },\n \"workOrderServiceVariant\": {\n \"id\": 4001,\n \"reference\": \"SERVICE-MOTO-10000KM\",\n \"name\": \"Service 10.000 km motocicleta\",\n \"estimatedDurationMinutes\": 90\n },\n \"product\": {\n \"id\": 5001,\n \"sku\": \"MOTO-NAKED-650\",\n \"name\": \"Yamaha MT-07\",\n \"brand\": \"Yamaha\",\n \"category\": \"MOTOCICLETA\",\n \"description\": \"Service completo de motocicleta naked 650cc\"\n },\n \"executionDateTime\": \"2026-03-03T15:30:00.000Z\"\n}\n\nworkOrderServiceVariant uses the same variant identifier pattern as other external integration endpoints: variantId or variantSku.
product uses the external integration product identifier pattern: productSku, productId, or productSerialNumber.
Creates a new product in Sodtrack using an external integration.
\nThis endpoint is typically used to keep the Sodtrack catalog synchronized with an external product source by creating products by SKU and basic descriptive fields.
\n{\n \"sku\": \"MOTO-ADV-790\",\n \"name\": \"KTM Adventure 790\",\n \"description\": \"Moto adventure para rutas y ciudad\",\n \"category\": \"MOTOCICLETA\",\n \"brand\": \"KTM\",\n \"tags\": [\n { \"name\": \"segment\", \"value\": \"adventure\" },\n { \"name\": \"engine_cc\", \"value\": \"790\" }\n ]\n}\n{\n \"id\": 7001,\n \"sku\": \"MOTO-ADV-790\",\n \"name\": \"KTM Adventure 790\",\n \"description\": \"Moto adventure para rutas y ciudad\",\n \"category\": \"MOTOCICLETA\",\n \"brand\": \"KTM\",\n \"type\": \"product\"\n}\nUpdates an existing product in Sodtrack.
\nThe target product is identified by a polymorphic identifier object (product) using either SKU, product id, or serial number, depending on product.type.
{\n \"product\": {\n \"type\": \"productSku\",\n \"value\": \"MOTO-ADV-790\"\n },\n \"name\": \"KTM Adventure 790 (Updated)\",\n \"description\": \"ActualizaciΓ³n de descripciΓ³n\",\n \"category\": \"MOTOCICLETA\",\n \"brand\": \"KTM\",\n \"tags\": [\n { \"name\": \"segment\", \"value\": \"adventure\" }\n ]\n}\n\n{\n \"id\": 8001,\n \"sku\": \"MOTO-ADV-790\",\n \"name\": \"KTM Adventure 790 (Updated)\",\n \"description\": \"ActualizaciΓ³n de descripciΓ³n\",\n \"category\": \"MOTOCICLETA\",\n \"brand\": \"KTM\",\n \"type\": \"product\"\n}\n\nproduct.type determines how the product is resolved:productSku: resolve by SKU
productId: resolve by numeric ID
productSerialNumber: resolve by unit serial number
Updates the list of areas and prices per area associated with a product.
\nThe target product is identified by a polymorphic identifier object (product). The request then provides an array of areas, each identifying an area (by id or reference) and its price.
{\n \"product\": {\n \"type\": \"productSku\",\n \"value\": \"MOTO-REPUESTO-AREA-0001\"\n },\n \"areas\": [\n { \"type\": \"areaReference\", \"value\": \"AREA-MOTO-1\", \"price\": 15000 },\n { \"type\": \"areaReference\", \"value\": \"AREA-MOTO-2\", \"price\": 17500 }\n ]\n}\n\n{\n \"id\": 9001,\n \"sku\": \"MOTO-REPUESTO-AREA-0001\",\n \"name\": \"Coberturas por Γ‘rea para servicio de motocicleta\",\n \"description\": \"Mock de Γ‘reas y precios por zona para servicios de motos\",\n \"category\": \"SERVICIO_MOTO\",\n \"brand\": \"Marca Mock Motos\",\n \"type\": \"product\",\n \"areas\": [\n {\n \"id\": 10000,\n \"price\": 15000,\n \"area\": {\n \"id\": 20000,\n \"name\": \"Zona servicio moto 1\",\n \"reference\": \"AREA-MOTO-1\",\n \"currency\": {\n \"id\": 1,\n \"code\": \"ARS\",\n \"name\": \"Peso argentino\",\n \"symbol\": \"$\"\n }\n }\n }\n ]\n}\n\nThe request provides the areas list to be applied to the product. Depending on configuration, this may replace or update the current list of areas.
areas[].price is interpreted in the areaβs configured currency.
Creates a new acquisition in Sodtrack linked to a customer, a serial number, and an area.
\nThis endpoint also supports optional dynamic forms data, which can be used to capture additional structured information alongside the acquisition.
\n{\n \"customer\": {\n \"name\": \"Juan\",\n \"lastName\": \"PΓ©rez\",\n \"phoneNumber\": \"+541155550000\",\n \"email\": \"juan.perez@example.com\",\n \"identificationNumber\": \"12345678\",\n \"identificationNumberCountry\": \"AR\",\n \"reference\": \"EXT-CUSTOMER-REF-001\"\n },\n \"acquisitionDate\": \"2026-03-03T12:00:00.000Z\",\n \"serialNumber\": \"VIN-MOTO-XYZ-0001\",\n \"reference\": \"ACQ-EXT-0001\",\n \"area\": {\n \"type\": \"areaReference\",\n \"value\": \"AREA-MOTO-1\"\n },\n \"dynamicForms\": [\n {\n \"formReference\": \"acquisition_form\",\n \"values\": [\n { \"fieldReference\": \"purchase_channel\", \"value\": \"online\" },\n { \"fieldReference\": \"comments\", \"value\": \"Entrega coordinada con cliente\" }\n ]\n }\n ]\n}\n{\n \"id\": 1,\n \"customer\": {\n \"id\": 1001,\n \"name\": \"Juan\",\n \"last_name\": \"PΓ©rez\",\n \"email\": \"juan.perez@motos-example.com\",\n \"phone\": \"+54 11 5555-0000\",\n \"reference\": \"EXT-CUSTOMER-REF-001\"\n },\n \"acquisitionDate\": \"2026-03-03T12:00:00.000Z\",\n \"productUnit\": {\n \"id\": 501,\n \"serialNumber\": \"VIN-MOTO-XYZ-0001\",\n \"product\": {\n \"id\": 300,\n \"sku\": \"MOTO-ADV-790\",\n \"name\": \"KTM Adventure 790\",\n \"brand\": \"KTM\",\n \"category\": \"MOTOCICLETA\",\n \"description\": \"Moto adventure para rutas y ciudad\"\n }\n }\n}\ndynamicForms is provided, form references and field references must match the configuration for the acquisition flow in Sodtrack.Creates a transaction (payment or refund) associated with a booking. Optionally breaks down amounts by variant (main service) and addons. The shopping cart is determined from the specified booking.
\n{\n \"id\": 346,\n \"type\": \"refund\",\n \"reference\": \"NR-00000000003\",\n \"amount\": 5000\n}\n\nIf transaction type is refund and cancelBookingIfTotallyRefunded is set to true:
\nThe quantityAdjustment only works for refund type transactions with the following constraints:
\nThe quantityAdjustment for the booking's variant, has always to be less than the quantity of the booking.
\nThe quantityAdjustmen for an addon has to be equal or less than the quantity of that addon in the booking.
\nConstraints:
\nA payment cannot exeed the amount that remains unpaid for each element; variant or addon.
\nIn order to post a refund, there should exist a previous payment transaction.
\nThe quantity of a booking variant cannot be 0 as a result of the transaction.
\nThe quantity of a booking addon can go to 0, eliminating the relation between addon and booking.
\nThis endpoint updates the status of a payment request. The payment request can be identified by its internal ID or by its external reference. It is intended for use by external integration systems to sync payment state (e.g. mark as paid or cancelled).
\n{\n \"paymentRequest\": {\n \"type\": \"paymentRequestId\",\n \"value\": \"342\"\n },\n \"status\": \"cancelled\"\n}\n\nOr by reference:
\n{\n \"paymentRequest\": {\n \"type\": \"paymentRequestId\",\n \"value\": \"PAY-EXT-001\"\n },\n \"status\": \"cancelled\"\n}\n\nSuccess (200 OK): Returns the updated payment request.
\n{\n \"id\": \"342\",\n \"status\": \"paid\",\n \"entityType\": \"lead\",\n \"entityTypeId\": 123,\n \"amount\": 150.50,\n \"description\": \"Lead payment\",\n \"reference\": \"PAY-EXT-001\",\n \"createdDate\": \"2025-02-01T10:00:00.000Z\",\n \"updatedDate\": \"2025-02-12T14:30:00.000Z\",\n \"currency\": {\n \"id\": \"8\",\n \"code\": \"USD\",\n \"symbol\": \"$\"\n }\n}\n\nPayment request not found (404 Not Found):
\n{\n \"statusCode\": 404,\n \"message\": \"PAYMENT_REQUEST_NOT_FOUND\",\n \"error\": \"Not Found\"\n}\n\nbasicInformation (object) - required: Objetc that represent the main information of the user
name (string) - required: Name of the technician or network
lastName (string) - required: Lastname of the technician or network
email (string) - required: Access email for the technician or network to the platforms
phoneNumber (string) - required: Phone number
identificationNumber (string) - required: Fiscal number of the the technician or network
identificationNumberCountry (string) - required: ISO-2 country string
isCompany (boolean) - required: true if it is a network false if it is a single technician.
workOnHolidays (boolean): If the avaialbility algorithm should take into account the general holidays as holidays for this provider
isMainProviderEligible (boolean): Select if the technitian is elleggible to be main provider of projects
isLeadAssignmentEligible (boolean): Select if the technitian is elleggible to be main provider of leads.
reference (string): External reference of the provider, generally the identifier of the provider in your integrated platform
provider (object) - required: Object with the information of the company provider that will have this technician. At least one of the attributes should be provided
id (number): Id of the company provider.
reference (string): Reference of the company provider.
basicInformation (object) - required: Object that represent the main information of the user
name (string) - required: Name of the technician or network
lastName (string) - required: Lastname of the technician or network
email (string) - required: Access email for the technician or network to the platforms
phoneNumber (string) - required: Phone number
identificationNumber (string) - required: Fiscal number of the the technician or network
identificationNumberCountry (string) - required: ISO-2 country string
reference (string): External reference of the provider, generally the identifier of the provider in your integrated platform
workOnHolidays (boolean): If the avaialbility algorithm should take into account the general holidays as holidays for this provider
Id of the provider
\n","type":"text/plain"},"type":"any","value":"35","key":"providerId"}]}},"response":[{"id":"37d87cf3-ac65-4778-a012-b3ff20fadd37","name":"Associate catalog area","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"area_id\": 2,\n \"name\": \"Chile\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/integration/api/provider/:providerId/working-area","host":["https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com"],"path":["integration","api","provider",":providerId","working-area"],"variable":[{"key":"providerId","value":"35","description":"Id of the provider"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 36,\n \"polygon\": [\n [\n -69.49145636744048,\n -17.524454208590498\n ],\n [\n -70.41651464873773,\n -18.43140911217968\n ],\n [\n -71.71159620256485,\n -29.090749609320724\n ],\n [\n -72.02347277458331,\n -32.64678792810332\n ],\n [\n -74.22937416964527,\n -37.525756033853256\n ],\n [\n -75.25405245631103,\n -43.84000131913486\n ],\n [\n -75.97986356657732,\n -46.826966622631474\n ],\n [\n -75.88978523420398,\n -50.96513891871673\n ],\n [\n -74.83540304363899,\n -53.235587066754405\n ],\n [\n -72.40178818053451,\n -55.417682610057696\n ],\n [\n -66.68065805148703,\n -56.20139767058807\n ],\n [\n -66.41025701391436,\n -55.10139261266371\n ],\n [\n -68.61689415694578,\n -54.69163913736025\n ],\n [\n -68.48880916415042,\n -52.25288828726699\n ],\n [\n -71.93287230374929,\n -51.96444971553152\n ],\n [\n -72.27444015854566,\n -50.63471807205209\n ],\n [\n -73.09987677878024,\n -50.67081063456212\n ],\n [\n -73.38451009610218,\n -49.31686315682273\n ],\n [\n -72.27444015854566,\n -48.86017741439368\n ],\n [\n -71.06331668093691,\n -44.480488241551384\n ],\n [\n -71.73221494479843,\n -44.358511994590636\n ],\n [\n -71.53297162267307,\n -43.64190966581542\n ],\n [\n -71.97415326452254,\n -42.498347501523774\n ],\n [\n -71.67528828133403,\n -41.93974900566139\n ],\n [\n -71.83660508187808,\n -40.671174133522044\n ],\n [\n -70.82615637310904,\n -38.566617284233104\n ],\n [\n -71.09075390141633,\n -37.27480130742069\n ],\n [\n -70.25108561531616,\n -35.83443033667401\n ],\n [\n -70.36495298038459,\n -35.1275145667756\n ],\n [\n -69.72452801640976,\n -34.202807328073106\n ],\n [\n -69.78145467987413,\n -33.31542867584144\n ],\n [\n -70.45036940485912,\n -31.428457636234185\n ],\n [\n -69.78148110915207,\n -30.181673563530126\n ],\n [\n -69.61070111875891,\n -28.469488994834535\n ],\n [\n -68.18626445368861,\n -26.89303829233763\n ],\n [\n -68.32858111235007,\n -24.611622274987567\n ],\n [\n -67.27546623134006,\n -24.041033147993986\n ],\n [\n -66.91967458468716,\n -22.957793275767912\n ],\n [\n -67.81628181272994,\n -22.485218164779013\n ],\n [\n -68.4709384425709,\n -20.60563892137594\n ],\n [\n -68.37131678150821,\n -19.348388561513673\n ],\n [\n -69.49145636744048,\n -17.524454208590498\n ]\n ],\n \"name\": \"Chile\",\n \"fromCatalog\": true\n}"}],"_postman_id":"4e5d8e42-8e20-4a03-b67d-d3c74d8f4f0c"},{"name":"Associate variants","id":"8cc4c4f1-f352-45d4-a293-f15672ae302b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"service_variant_to_add\":[848,846,850,851,849,852],\n \"service_variant_to_remove\":[847]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/integration/api/provider/:providerId/service-variant","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"cc318f6e-0b51-4254-be86-c090e307212f","id":"cc318f6e-0b51-4254-be86-c090e307212f","name":"Sodtrack Integration API","type":"collection"}},"urlObject":{"path":["integration","api","provider",":providerId","service-variant"],"host":["https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com"],"query":[],"variable":[{"description":{"content":"Id of the provider
\n","type":"text/plain"},"type":"any","value":"35","key":"providerId"}]}},"response":[{"id":"ca3503ad-fd2f-4c75-98b6-44d67f2c43e0","name":"New Request","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"service_variant_to_add\":[848,846,850,851,849,852],\n \"service_variant_to_remove\":[847]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/integration/api/provider/:providerId/service-variant","host":["https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com"],"path":["integration","api","provider",":providerId","service-variant"],"variable":[{"key":"providerId","value":"35","description":"Id of the provider"}]}},"status":"Created","code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8cc4c4f1-f352-45d4-a293-f15672ae302b"},{"name":"Add daily availability","id":"ab3879be-6640-4e21-ad2f-466b4d9998bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"end_time\":\"20:00\",\n \"start_time\":\"08:00\",\n \"day_of_week\":1\n}","options":{"raw":{"language":"json"}}},"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/integration/api/provider/:providerId/availability","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"cc318f6e-0b51-4254-be86-c090e307212f","id":"cc318f6e-0b51-4254-be86-c090e307212f","name":"Sodtrack Integration API","type":"collection"}},"urlObject":{"path":["integration","api","provider",":providerId","availability"],"host":["https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com"],"query":[],"variable":[{"description":{"content":"Id of the provider
\n","type":"text/plain"},"type":"any","value":"35","key":"providerId"}]}},"response":[{"id":"b7e959bc-8bda-43a8-81c7-59d911e45718","name":"Add daily availability","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"end_time\":\"20:00\",\n \"start_time\":\"08:00\",\n \"day_of_week\":1\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/integration/api/provider/:providerId/availability","host":["https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com"],"path":["integration","api","provider",":providerId","availability"],"variable":[{"key":"providerId","value":"35","description":"Id of the provider"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\":171,\n \"day_of_week\":1,\n \"start_time\":\"08:00\",\n \"end_time\":\"20:00\"\n}"}],"_postman_id":"ab3879be-6640-4e21-ad2f-466b4d9998bd"},{"name":"Change provider status","id":"e670d353-5ffb-43f2-bccc-4438a0ddb90a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"status\":\"accepted\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/api/integration/provider/36","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"cc318f6e-0b51-4254-be86-c090e307212f","id":"cc318f6e-0b51-4254-be86-c090e307212f","name":"Sodtrack Integration API","type":"collection"}},"urlObject":{"path":["api","integration","provider","36"],"host":["https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com"],"query":[],"variable":[]}},"response":[{"id":"d43d7f60-caa8-4533-aad4-a7b60fa92c69","name":"Change provider status","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"status\":\"accepted\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/api/integration/provider/36"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 36,\n \"owns_transportation\": false,\n \"work_on_holidays\": false,\n \"reference\": \"4433\",\n \"status\": \"accepted\",\n \"reviews_count\": 0,\n \"rating\": \"0.00\",\n \"priority\": 3,\n \"user\": {\n \"id\": 7191,\n \"name\": \"Felipe\",\n \"reference\": null,\n \"lastname\": \"Piter Hijo 2\",\n \"summary\": null,\n \"identification_number\": \"190816370\",\n \"identification_number_decrypted\": \"190816370\",\n \"identificationNumberCountry\": \"CL\",\n \"phone\": \"+56978993325\",\n \"authentication_provider_id\": null,\n \"email\": \"felipe+piter_hijo2@sodtrack.com\",\n \"email_verified\": false,\n \"affiliation_code\": \"LISQE9\",\n \"referred_by\": null,\n \"birthdate\": null,\n \"created_date\": \"2025-05-23T18:46:51.838Z\",\n \"parent_id\": null\n },\n \"created_date\": \"2025-05-23T18:46:51.838Z\",\n \"boarding_step\": null,\n \"isCompany\": false,\n \"fundingType\": null,\n \"network\": {\n \"id\": 10,\n \"name\": null\n },\n \"isMainProviderEligible\": true,\n \"isLeadAssignmentEligible\": true\n}"}],"_postman_id":"e670d353-5ffb-43f2-bccc-4438a0ddb90a"}],"id":"70911813-cd36-4236-a6f7-f9f1f52f85ae","description":"This segment has the API to mange the creation and configuration of network and their technicians, as well as for mono technicians
\n","_postman_id":"70911813-cd36-4236-a6f7-f9f1f52f85ae","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"cc318f6e-0b51-4254-be86-c090e307212f","id":"cc318f6e-0b51-4254-be86-c090e307212f","name":"Sodtrack Integration API","type":"collection"}}},{"name":"Customers","item":[{"name":"Create customer","id":"119e9362-98d8-48c5-8d78-74119da6f9c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\":\"Felipe\",\n \"lastname\":\"Hanckes\",\n \"email\":\"felipe+customer@sodtrack.com\",\n \"phone\":\"+56978993325\",\n \"identification_number\":\"190816370\",\n \"identification_number_country\":\"CL\",\n \"reference\":\"12323\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/integration/api/user","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"cc318f6e-0b51-4254-be86-c090e307212f","id":"cc318f6e-0b51-4254-be86-c090e307212f","name":"Sodtrack Integration API","type":"collection"}},"urlObject":{"path":["integration","api","user"],"host":["https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com"],"query":[],"variable":[]}},"response":[{"id":"634edebc-fc4e-4deb-8889-6ffc5e6f22bb","name":"Create customer","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\":\"Felipe\",\n \"lastname\":\"Hanckes\",\n \"email\":\"felipe+customer@sodtrack.com\",\n \"phone\":\"+56978993325\",\n \"identification_number\":\"190816370\",\n \"identification_number_country\":\"CL\",\n \"reference\":\"12323\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/integration/api/user"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 7189,\n \"name\": \"Felipe\",\n \"reference\": \"12323\",\n \"lastname\": \"Hanckes\",\n \"summary\": null,\n \"identification_number\": \"190816370\",\n \"identification_number_decrypted\": \"190816370\",\n \"identificationNumberCountry\": \"CL\",\n \"phone\": \"+56978993325\",\n \"authentication_provider_id\": null,\n \"email\": \"felipe+customer@sodtrack.com\",\n \"email_verified\": false,\n \"affiliation_code\": \"3EI91S\",\n \"referred_by\": null,\n \"birthdate\": null,\n \"created_date\": \"2025-05-23T18:26:33.946Z\",\n \"parent_id\": null\n}"}],"_postman_id":"119e9362-98d8-48c5-8d78-74119da6f9c3"}],"id":"599d8472-61b7-415f-85cf-b875c35ddc9a","_postman_id":"599d8472-61b7-415f-85cf-b875c35ddc9a","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"cc318f6e-0b51-4254-be86-c090e307212f","id":"cc318f6e-0b51-4254-be86-c090e307212f","name":"Sodtrack Integration API","type":"collection"}}}],"id":"9ac659f6-3e60-4487-823e-2aa6177cde0e","_postman_id":"9ac659f6-3e60-4487-823e-2aa6177cde0e","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"cc318f6e-0b51-4254-be86-c090e307212f","id":"cc318f6e-0b51-4254-be86-c090e307212f","name":"Sodtrack Integration API","type":"collection"}}},{"name":"Incidents","item":[{"name":"Get Entity Incident","id":"c32f9c19-4277-47ee-a28f-9d7c5e39e220","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/api/integration/incident?entity=booking&entityId=135","description":"This endpoint returns the list of incidents associated with a given entity (booking or lead). The entity is identified by query parameters entity and entityId. Only booking and lead entities are supported for incident detail; project is not supported and returns an error.
Returns an array of incident objects. Each item includes:
\nGET /integration/api/incident?entity=booking&entityId=73\n\nHTTP/1.1 200 OK\nContent-Type: application/json\n\n[\n {\n \"id\": 1,\n \"description\": \"Customer reported delay\",\n \"entityType\": \"booking\",\n \"entityId\": 12345,\n \"bookingIncidentReason\": { \"id\": 1, \"name\": \"Delay\", \"description\": \"Service delay\" },\n \"bookingIncidentStatus\": { \"id\": 1, \"name\": \"Open\", \"description\": \"Open\" },\n \"userReporter\": { \"id\": 10, \"name\": \"John\", \"lastName\": \"Doe\", \"email\": \"john@example.com\", \"reference\": \"USR-001\" },\n \"userCreator\": { \"id\": 10, \"name\": \"John\", \"lastName\": \"Doe\", \"email\": \"john@example.com\", \"reference\": \"USR-001\" },\n \"userAccountable\": { \"id\": 11, \"name\": \"Jane\", \"lastName\": \"Smith\", \"email\": \"jane@example.com\", \"reference\": \"USR-002\" },\n \"bookingIncidentAttachments\": [],\n \"tasks\": [],\n \"createdDate\": \"2025-02-20T10:00:00.000Z\",\n \"updatedDate\": \"2025-02-20T10:00:00.000Z\",\n \"reference\": \"INC-EXT-001\",\n \"bookingId\": 12345,\n \"bookingVariantName\": \"Installation\",\n \"bookingStatus\": \"scheduled\",\n \"bookingDate\": \"2025-02-25\",\n \"bookingReference\": \"BKG-123\"\n }\n]\n\n{\n \"statusCode\": 400,\n \"message\": \"ENTITY_NOT_SUPPORTED: Only booking and lead entities are supported for incident detail.\",\n \"error\": \"Bad Request\"\n}\n\nEntity for which the incident should be retrieved
\n","type":"text/plain"},"key":"entity","value":"booking"},{"description":{"content":"Id of the entity of which all incidents should be fetched
\n","type":"text/plain"},"key":"entityId","value":"135"}],"variable":[]}},"response":[{"id":"e4b2521e-d666-4767-bf1a-78b9a7134ce4","name":"Get Entity Incident","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"incident\": {\n \"type\": \"string\", // incidentId or incidentReference\n \"value\": \"string\"\n },\n \"description\": \"string\",\n \"statusId\": \"number\",\n \"accountableUser\": {\n \"type\": \"string\", // userId, userReference, userEmail\n \"value\": \"string\"\n }\n}"},"url":{"raw":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/api/integration/incident?entity=booking&entityId=135","host":["https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com"],"path":["api","integration","incident"],"query":[{"key":"entity","value":"booking","description":"Entity for which the incident should be retrieved"},{"key":"entityId","value":"135","description":"Id of the entity of which all incidents should be fetched"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 53,\n \"description\": \"Prueba de inyecciΓ³n de un incidente vΓa integraciΓ³n. 17-11-2025 incidente 1\",\n \"bookingId\": 2343,\n \"bookingVariantName\": \"Presupuesto instalaciΓ³n ElectrodomΓ©sticos\",\n \"bookingStatus\": \"done\",\n \"bookingDate\": \"2025-11-18T11:00:00.000Z\",\n \"bookingReference\": \"UPDT-2-FROM-EXT-INT\",\n \"bookingIncidentReason\": {\n \"id\": 18,\n \"name\": \"Incidentes naturales\",\n \"description\": \"Γrboles caΓdos, hoyos en el camino, agua en exceso, nieve, etc\"\n },\n \"bookingIncidentStatus\": {\n \"id\": 1,\n \"name\": \"Create\",\n \"description\": \"Created status\"\n },\n \"userReporter\": {\n \"id\": 15,\n \"name\": \"Felipe\",\n \"lastName\": \"Hanckes\",\n \"email\": \"felipe@sodtrack.com\",\n \"reference\": null\n },\n \"userCreator\": {\n \"id\": 15,\n \"name\": \"Felipe\",\n \"lastName\": \"Hanckes\",\n \"email\": \"felipe@sodtrack.com\",\n \"reference\": null\n },\n \"userAccountable\": {\n \"id\": 15,\n \"name\": \"Felipe\",\n \"lastName\": \"Hanckes\",\n \"email\": \"felipe@sodtrack.com\",\n \"reference\": null\n },\n \"bookingIncidentAttachments\": [],\n \"offlineCreatedDate\": null,\n \"createdDate\": \"2025-11-17T17:34:46.856Z\",\n \"updatedDate\": \"2025-11-17T17:34:46.856Z\",\n \"reference\": \"ext-int-creation#1\"\n },\n {\n \"id\": 54,\n \"description\": \"Prueba de inyecciΓ³n de un incidente vΓa integraciΓ³n. 17-11-2025 incidente 2 update 1\",\n \"bookingId\": 2343,\n \"bookingVariantName\": \"Presupuesto instalaciΓ³n ElectrodomΓ©sticos\",\n \"bookingStatus\": \"done\",\n \"bookingDate\": \"2025-11-18T11:00:00.000Z\",\n \"bookingReference\": \"UPDT-2-FROM-EXT-INT\",\n \"bookingIncidentReason\": {\n \"id\": 18,\n \"name\": \"Incidentes naturales\",\n \"description\": \"Γrboles caΓdos, hoyos en el camino, agua en exceso, nieve, etc\"\n },\n \"bookingIncidentStatus\": {\n \"id\": 2,\n \"name\": \"resuelto\",\n \"description\": \"El incidente fue resuelto\"\n },\n \"userReporter\": {\n \"id\": 15,\n \"name\": \"Felipe\",\n \"lastName\": \"Hanckes\",\n \"email\": \"felipe@sodtrack.com\",\n \"reference\": null\n },\n \"userCreator\": {\n \"id\": 15,\n \"name\": \"Felipe\",\n \"lastName\": \"Hanckes\",\n \"email\": \"felipe@sodtrack.com\",\n \"reference\": null\n },\n \"userAccountable\": {\n \"id\": 16,\n \"name\": \"Felipe\",\n \"lastName\": \"Hanckes\",\n \"email\": \"felipe+2@sodtrack.com\",\n \"reference\": null\n },\n \"bookingIncidentAttachments\": [],\n \"offlineCreatedDate\": null,\n \"createdDate\": \"2025-11-17T17:38:59.290Z\",\n \"updatedDate\": \"2025-11-20T03:55:46.668Z\",\n \"reference\": \"ext-int-creation#2\"\n }\n]"}],"_postman_id":"c32f9c19-4277-47ee-a28f-9d7c5e39e220"},{"name":"Create Incident","id":"b65b319c-3b81-4e03-896f-0cbc62dd59cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/api/integration/incident","description":"Creates a new incident in Sodtrack and associates it with a booking or a lead.
\nThe target entity is identified by entityType (booking or lead) and by entity (using entityId or entityReference). The incident requires a description and an incident reason (by ID; reference is not yet supported). You can optionally set the reporter, creator, and accountable users, an external reference, and dynamic forms data.
Incidents are used to track issues, complaints, or follow-ups. Only booking and lead are supported for creation; project is not supported.
\n{\n \"entityType\": \"booking\",\n \"entity\": {\n \"type\": \"entityReference\",\n \"value\": \"BOOK-REF-001\"\n },\n \"description\": \"TΓ©cnico no llevΓ³ el equipo correcto.\",\n \"incidentReason\": {\n \"type\": \"reasonId\",\n \"value\": \"2\"\n },\n \"reporterUser\": {\n \"type\": \"userEmail\",\n \"value\": \"soporte@example.com\"\n },\n \"creatorUser\": {\n \"type\": \"userReference\",\n \"value\": \"USER-EXT-001\"\n },\n \"reference\": \"INC-EXT-2025-001\"\n}\n\n{\n \"entityType\": \"lead\",\n \"entity\": {\n \"type\": \"entityReference\",\n \"value\": \"LEAD-EXT-342\"\n },\n \"description\": \"Queja por demora en agendamiento.\",\n \"incidentReason\": {\n \"type\": \"reasonId\",\n \"value\": \"2\"\n },\n \"reporterUser\": {\n \"type\": \"userEmail\",\n \"value\": \"soporte@example.com\"\n },\n \"creatorUser\": {\n \"type\": \"userEmail\",\n \"value\": \"soporte@example.com\"\n },\n \"reference\": \"INC-LEAD-001\",\n \"dynamicForms\": [\n {\n \"formReference\": \"incident_creation_form\",\n \"values\": [\n {\n \"fieldReference\": \"incident_creation_form_field_1\",\n \"value\": \"Yes\"\n }\n ]\n }\n ]\n}\n\n{\n \"entityType\": \"booking\",\n \"entity\": {\n \"type\": \"entityId\",\n \"value\": \"12345\"\n },\n \"description\": \"Incidente reportado por integraciΓ³n.\",\n \"incidentReason\": {\n \"type\": \"reasonId\",\n \"value\": \"1\"\n }\n}\n\n{\n \"id\": 100,\n \"entityType\": \"booking\",\n \"entityId\": 12345,\n \"bookingId\": 12345,\n \"incidentStatus\": {\n \"id\": 1,\n \"name\": \"Open\",\n \"description\": \"Incident is open\",\n \"isFinalStatus\": false,\n \"isInitialStatus\": true,\n \"bookingStatusUpdate\": \"\"\n },\n \"reference\": \"INC-EXT-001\"\n}\n\nentityType and entity are required. Supported values for creation are booking and lead. The enum may include project; it is not supported for this endpoint and returns ENTITY_TYPE_NOT_SUPPORTED.
entity.value must be non-empty (after trim). Otherwise the request fails with ENTITY_IDENTIFIER_REQUIRED.
When entityType is booking:
entity.type = entityId: value is the booking ID. The booking must exist; otherwise the API returns BOOKING_NOT_FOUND_FOR_ID.
entity.type = entityReference: value is the booking reference. No match returns BOOKING_NOT_FOUND_FOR_REFERENCE; multiple matches return MULTIPLE_BOOKINGS_FOUND_FOR_REFERENCE.
When entityType is lead:
entity.type = entityId: value is the lead ID. The lead must exist; otherwise the API returns LEAD_NOT_FOUND_FOR_ID.
entity.type = entityReference: value is the lead reference. The lead must exist; otherwise the API returns LEAD_NOT_FOUND_FOR_REFERENCE.
reporterUser and creatorUser are optional and can be sent as null. When either is provided with a non-null value, it must resolve to an existing user by the given identifier (userId, userEmail, or userReference). If the user cannot be resolved, the request fails with INVALID_REPORTER_USER or INVALID_CREATOR_USER respectively.
accountableUser is optional. When provided, it is resolved if possible; if it cannot be resolved, the incident may be created without an accountable user (behavior may depend on configuration).
\nInvalid user identifier type returns INVALID_USER_TYPE.
incidentReason is required. Only type = reasonId is supported; reasonReference is not yet supported and returns INCIDENT_REASON_REFERENCE_NOT_SUPPORTED.
value must be a valid numeric reason ID that exists in Sodtrack. Invalid number returns INVALID_INCIDENT_REASON_ID; non-existent reason returns INCIDENT_REASON_NOT_FOUND.
Dynamic form data (when provided) is validated and stored for the incident according to the incident creation flow configuration.
\nAll timestamps in responses follow ISO 8601 format (UTC) where applicable.
\nUpdates an existing incident in Sodtrack.
\nThe incident is identified by incident (by incidentId or incidentReference). Only the fields you send are updated; omitted fields keep their current values. You can update the description, incident status, accountable user, and dynamic forms data.
{\n \"incident\": {\n \"type\": \"incidentReference\",\n \"value\": \"INC-EXT-2025-001\"\n },\n \"description\": \"Actualizado: resoluciΓ³n en progreso.\",\n \"incidentStatus\": {\n \"type\": \"statusId\",\n \"value\": \"2\"\n },\n \"accountableUser\": {\n \"type\": \"userEmail\",\n \"value\": \"manager@example.com\"\n }\n}\n\n{\n \"incident\": {\n \"type\": \"incidentId\",\n \"value\": \"101\"\n },\n \"description\": \"DescripciΓ³n actualizada del incidente.\",\n \"incidentStatus\": {\n \"type\": \"statusId\",\n \"value\": \"3\"\n },\n \"dynamicForms\": [\n {\n \"formReference\": \"incident_status_update_form\",\n \"values\": [\n {\n \"fieldReference\": \"incident_status_update_form_field_1\",\n \"value\": \"yesterday\"\n }\n ]\n }\n ]\n}\n\n{\n \"incident\": {\n \"type\": \"incidentId\",\n \"value\": \"101\"\n },\n \"incidentStatus\": {\n \"type\": \"statusId\",\n \"value\": \"2\"\n }\n}\n\n{\n \"id\": 101,\n \"entityType\": \"booking\",\n \"entityId\": 12345,\n \"bookingId\": 12345,\n \"incidentStatus\": {\n \"id\": 2,\n \"name\": \"In Progress\",\n \"description\": \"In Progress\",\n \"isFinalStatus\": false,\n \"isInitialStatus\": false,\n \"bookingStatusUpdate\": \"\"\n }\n}\n\nincident is required, with type and value.
\ntype must be incidentId or incidentReference. Any other value returns INVALID_INCIDENT_TYPE.
If no incident is found for the given ID or reference, the API returns INCIDENT_NOT_FOUND.
When type = incidentReference, if more than one incident matches the reference, the API returns MULTIPLE_INCIDENTS_FOUND_FOR_REFERENCE.
description, incidentStatus, and accountableUser are optional. Only provided fields are updated; omitted fields leave existing values unchanged.
\nYou can send only incident plus one or more of description, status, and accountable user.
\nuserId, userEmail, or userReference). If the user cannot be resolved, the request fails with INVALID_ACCOUNTABLE_USER.incidentStatus (when provided) must use type = statusId. statusReference is not yet supported and returns INCIDENT_STATUS_REFERENCE_NOT_SUPPORTED.
value must be a valid numeric status ID that exists in Sodtrack. Invalid number returns INVALID_INCIDENT_STATUS_ID; non-existent status returns INCIDENT_STATUS_NOT_FOUND.
Dynamic form data (when provided) is validated and stored according to the incident status change flow configuration.
\nAll timestamps in responses follow ISO 8601 format (UTC) where applicable.
\nCreates a new alert for an entity resolved by polymorphic identifier (entityId or entityReference) plus entityType.
ExternalIntegrationEntityIdentifierRequestDTOReturns AlertDTO.
{\n \"entityType\": \"booking\",\n \"entity\": {\n \"type\": \"entityReference\",\n \"value\": \"BKG-EXT-100\"\n },\n \"name\": \"Technician unavailable\",\n \"resolveType\": \"manual\",\n \"metricKey\": \"capacity\",\n \"metricValue\": \"0\",\n \"createdComment\": \"Created from external monitoring\",\n \"reference\": \"EXT-ALERT-100\"\n}\n\nHTTP/1.1 201 Created\n\n{\n \"id\": 10,\n \"uuid\": \"d73c51c5-3fbe-4d8e-8f24-2ecce2f8e8e1\",\n \"entityType\": \"booking\",\n \"entityId\": 12345,\n \"name\": \"Technician unavailable\",\n \"status\": \"active\",\n \"creationUserType\": \"integration_api\",\n \"createdByUserId\": null,\n \"creationType\": \"manual\",\n \"resolveType\": \"manual\",\n \"metricKey\": \"capacity\",\n \"metricValue\": \"0\",\n \"createdComment\": \"Created from external monitoring\",\n \"reference\": \"EXT-ALERT-100\",\n \"resolvedComment\": null,\n \"resolvedByUserId\": null,\n \"resolvedDate\": null,\n \"createdDate\": \"2026-02-24T10:00:00.000Z\",\n \"updatedDate\": \"2026-02-24T10:00:00.000Z\"\n}\n\n{\n \"statusCode\": 400,\n \"message\": \"INVALID_ENTITY_IDENTIFIER_TYPE\",\n \"error\": \"Bad Request\"\n}\n\n{\n \"statusCode\": 400,\n \"message\": \"BUDGET_REFERENCE_NOT_SUPPORTED\",\n \"error\": \"Bad Request\"\n}\n\n{\n \"statusCode\": 409,\n \"message\": \"ALERT_REFERENCE_ALREADY_EXISTS\",\n \"error\": \"Conflict\"\n}\n\nentity.type must be exactly entityId or entityReference; otherwise returns INVALID_ENTITY_IDENTIFIER_TYPE.
Entity resolution requires exactly one identifier value that maps to exactly one instance of the entity.
\nIf entity cannot be resolved: ENTITY_NOT_FOUND.
If reference maps to multiple entities: MULTIPLE_ENTITIES_FOUND.
For entityType = budget, reference-based resolution is not supported yet BUDGET_REFERENCE_NOT_SUPPORTED.
reference, when provided, must be unique; duplicate returns ALERT_REFERENCE_ALREADY_EXISTS.
Resolves an existing alert by alertId or alertReference.
ExternalIntegrationAlertIdentifierRequestDTO{\n \"alert\": {\n \"type\": \"alertReference\",\n \"value\": \"EXT-ALERT-100\"\n },\n \"resolvedComment\": \"Issue solved by integration workflow.\"\n}\n\nHTTP/1.1 200 OK\n\n{\n \"id\": 10,\n \"uuid\": \"d73c51c5-3fbe-4d8e-8f24-2ecce2f8e8e1\",\n \"entityType\": \"booking\",\n \"entityId\": 12345,\n \"name\": \"Technician unavailable\",\n \"status\": \"resolved\",\n \"creationUserType\": \"integration_api\",\n \"createdByUserId\": null,\n \"creationType\": \"manual\",\n \"resolveType\": \"manual\",\n \"metricKey\": \"capacity\",\n \"metricValue\": \"0\",\n \"createdComment\": \"Created from external monitoring\",\n \"reference\": \"EXT-ALERT-100\",\n \"resolvedComment\": \"Issue solved by integration workflow.\",\n \"resolvedByUserId\": null,\n \"resolvedDate\": \"2026-02-24T10:30:00.000Z\",\n \"createdDate\": \"2026-02-24T10:00:00.000Z\",\n \"updatedDate\": \"2026-02-24T10:30:00.000Z\"\n}\n\n{\n \"statusCode\": 400,\n \"message\": \"INVALID_ALERT_IDENTIFIER_TYPE\",\n \"error\": \"Bad Request\"\n}\n\n{\n \"statusCode\": 400,\n \"message\": \"ONLY_ACTIVE_ALERT_CAN_BE_RESOLVED\",\n \"error\": \"Bad Request\"\n}\n\n{\n \"statusCode\": 400,\n \"message\": \"STICKY_ALERT_CANNOT_BE_RESOLVED\",\n \"error\": \"Bad Request\"\n}\n\n{\n \"statusCode\": 404,\n \"message\": \"ALERT_NOT_FOUND\",\n \"error\": \"Not Found\"\n}\n\nalert.type must be alertId or alertReference; otherwise returns INVALID_ALERT_IDENTIFIER_TYPE.
If identifier is missing/empty after normalization, backend returns ALERT_IDENTIFIER_REQUIRED.
Only alerts with status active can be resolved: otherwise ONLY_ACTIVE_ALERT_CAN_BE_RESOLVED.
Alerts with resolveType = sticky cannot be resolved via API: STICKY_ALERT_CANNOT_BE_RESOLVED.
If alert does not exist: ALERT_NOT_FOUND.
Reopens a resolved alert by alertId or alertReference.
ExternalIntegrationAlertIdentifierRequestDTO{\n \"alert\": {\n \"type\": \"alertId\",\n \"value\": \"10\"\n }\n}\n\nHTTP/1.1 200 OK\n\n{\n \"id\": 10,\n \"uuid\": \"d73c51c5-3fbe-4d8e-8f24-2ecce2f8e8e1\",\n \"entityType\": \"booking\",\n \"entityId\": 12345,\n \"name\": \"Technician unavailable\",\n \"status\": \"active\",\n \"creationUserType\": \"integration_api\",\n \"createdByUserId\": null,\n \"creationType\": \"manual\",\n \"resolveType\": \"manual\",\n \"metricKey\": \"capacity\",\n \"metricValue\": \"0\",\n \"createdComment\": \"Created from external monitoring\",\n \"reference\": \"EXT-ALERT-100\",\n \"resolvedComment\": \"Issue solved by integration workflow.\",\n \"resolvedByUserId\": null,\n \"resolvedDate\": \"2026-02-24T10:30:00.000Z\",\n \"createdDate\": \"2026-02-24T10:00:00.000Z\",\n \"updatedDate\": \"2026-02-24T11:00:00.000Z\"\n}\n\n{\n \"statusCode\": 400,\n \"message\": \"INVALID_ALERT_IDENTIFIER_TYPE\",\n \"error\": \"Bad Request\"\n}\n\n{\n \"statusCode\": 400,\n \"message\": \"ONLY_RESOLVED_ALERT_CAN_BE_REOPENED\",\n \"error\": \"Bad Request\"\n}\n\n{\n \"statusCode\": 400,\n \"message\": \"STICKY_ALERT_CANNOT_BE_REOPENED\",\n \"error\": \"Bad Request\"\n}\n\n{\n \"statusCode\": 404,\n \"message\": \"ALERT_NOT_FOUND\",\n \"error\": \"Not Found\"\n}\n\nalert.type must be alertId or alertReference; otherwise returns INVALID_ALERT_IDENTIFIER_TYPE.
If identifier is missing/empty after normalization, backend returns ALERT_IDENTIFIER_REQUIRED.
Only alerts with status resolved can be reopened: otherwise ONLY_RESOLVED_ALERT_CAN_BE_REOPENED.
Alerts with resolveType = sticky cannot be reopened via API: STICKY_ALERT_CANNOT_BE_REOPENED.
If alert does not exist: ALERT_NOT_FOUND.
Id of the category from which to get the active services from
\n","type":"text/plain"},"type":"any","value":"9","key":"categoryId"}]}},"response":[{"id":"831a19b2-0121-42bf-a24e-d3fa25e60e2b","name":"Active variants by category","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ","type":"text"}],"url":{"raw":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/api/integration/catalog/categories/:categoryId/services","host":["https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com"],"path":["api","integration","catalog","categories",":categoryId","services"],"variable":[{"key":"categoryId","value":"54"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 113,\n \"name\": \"Servicio de prueba integraciΓ³n\",\n \"description\": \"descripciΓ³n de prueba\",\n \"order\": 0,\n \"image\": \"\",\n \"variants\": [],\n \"categories\": [],\n \"created_date\": \"2024-01-29T11:14:51.317Z\",\n \"active\": true\n },\n {\n \"id\": 132,\n \"name\": \"InstalaciΓ³n de cortinas\",\n \"description\": \"Instalar cortinas de casa\",\n \"order\": 0,\n \"image\": \"\",\n \"variants\": [],\n \"categories\": [],\n \"created_date\": \"2024-05-20T10:31:35.230Z\",\n \"active\": true\n }\n]"}],"_postman_id":"4d2f7113-a66b-4ba1-852e-dc5a04a0563e"},{"name":"Active variants by service","id":"ed44dbfa-30c6-46bb-8340-2ba30c8a06e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/catalog/services/:serviceId/variants","urlObject":{"path":["catalog","services",":serviceId","variants"],"host":["https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com"],"query":[],"variable":[{"description":{"content":"Id of a service from which to get the active variants.
\n","type":"text/plain"},"type":"any","value":"","key":"serviceId"}]}},"response":[{"id":"c5efcef6-6f5c-451d-a4cc-7d295938c36f","name":"Active variants by service and category","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ","type":"text"}],"url":{"raw":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/catalog/services/:serviceId/variants","host":["https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com"],"path":["catalog","services",":serviceId","variants"],"variable":[{"key":"serviceId","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 284,\n \"internal_name\": \"Variante de Servicio- Corto\",\n \"service\": {\n \"id\": 137,\n \"name\": \"Servicio de Pruebas - Corto\",\n \"serviceType\": {\n \"id\": 1,\n \"name\": \"B1\"\n }\n },\n \"skus\": [\n {\n \"id\": 461,\n \"sku\": \"sku-ucdev-7\"\n }\n ]\n }\n]"}],"_postman_id":"ed44dbfa-30c6-46bb-8340-2ba30c8a06e1"}],"id":"77a39cd6-42db-4828-9096-654f7b3f3101","description":"This section provides all the catalog information, including available categories, services, and variants. It serves as a reference point for key details about the services offered on the platform.
\n","_postman_id":"77a39cd6-42db-4828-9096-654f7b3f3101","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"cc318f6e-0b51-4254-be86-c090e307212f","id":"cc318f6e-0b51-4254-be86-c090e307212f","name":"Sodtrack Integration API","type":"collection"}}},{"name":"Configuration","item":[{"name":"Upsert variants and providers","id":"d229d7d1-2e42-4175-9595-efdd79c57ae4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/api/integration/unified/upsert","description":"This endpoint provides a unified upsert operation for creating or updating service variants and providers (professionals) in a single API call. It manages the complete lifecycle of service variants identified by SKU, providers identified by reference, and their associated configurations including provider-variant associations, availability schedules, and working areas.
\nThe endpoint processes execution variants only (not budgeted variants).
\nThis endpoint is specifically designed for external integration systems to synchronize professional data and service configurations. It supports creating or updating professionals that are either natural persons or networks, but must not be used for technicians that belong to a company.
\nThis endpoint only supports creating or updating professionals that are either:
\nNatural persons (individual providers with isCompany: false and no parent relationship)
Networks (providers with isCompany: true that act as parent organizations)
It MUST NOT be used to create or update technicians that belong to a company (providers with a parent relationship). Attempting to update a provider that has an existing parent relationship will result in an error.
Each service variant SKU sent in the request MUST be unique in the system.
\nIf more than one variant is found for the same SKU, the operation for that SKU must fail and be stored as an error.
\nNo partial processing should occur for that SKUβthe entire variant upsert operation for that SKU is rejected.
\nIf a SKU sent in the variants payload matches an existing variant, but the service or category differs from the existing one:
\nThe variant and all its operation variants will be moved from the existing service to the new service provided in the request.
\nIf the category differs, the variant will be moved under the new category provided in the request.
\nThis operation preserves all existing operation variants and their configurationsβonly the service and category associations are updated.
\nOperation variants are NEVER deleted by the algorithm. The system preserves all existing operation variants and only updates or reassigns them based on the incoming payload.
\nOperation variants NEVER will end without being associated to an operation area. The re-shuffle logic ensures that all operation variants maintain at least one area association.
\nisExecution: true are processed. Variants with isExecution: false are skipped with a warning log entry and do not count toward the variantsProcessed total.When a provider is sent and it already exists (identified by reference), the update strategy follows this pattern:
This behavior applies to the following provider configuration sections:
\nareas field)Keep: Working areas that match areas in the incoming areas array are preserved.
Remove: Working areas that exist but are not in the incoming areas array are deleted.
Add: New working areas are created for areas in the incoming areas array that don't have an existing working area association.
availability field)availability array. This is a complete reset operationβall previous availability records are deleted and new ones are created from the payload.service_variants field)Keep: Provider-variant associations that match variants in the incoming service_variants array are preserved.
Remove: Provider-variant associations for variants not included in the incoming service_variants array are deleted.
Add: New provider-variant associations are created for variants in the incoming service_variants array that don't have an existing association.
Note: Provider basic information fields (isMainProviderEligible, isLeadAssignmentEligible, workOnHolidays) are updated directly from the payload values. The isCompany field is only set during creation and is not updated for existing providers.
When an existing service variant is sent with operation area configurations (via the operationAreas object), the system performs intelligent re-shuffling of operation variants rather than deleting and recreating them. The algorithm supports two configuration modes: detailed (specific area configurations) and all (default parameters for remaining areas).
The system processes operation areas in two phases:
\ndetailed EntriesArea Resolution and Currency Grouping
\nEach area value in each detailed entry is resolved to an Area entity with its associated currency.
Areas are automatically grouped by currencyβone VariantOperation is created or updated per currency group.
\nThe system tracks which areas have been processed in this phase.
\nConflict Detection
\nFor each currency group, the system identifies existing operation variants that have overlapping areas (same currency, shared area IDs).
\nIf no conflicts exist, a new operation variant is created with the specified areas and parameters.
\nConflict Resolution Strategy
\nOperations with Remaining Areas: If an existing operation variant has both overlapping areas (that need to be reassigned) and non-overlapping areas (that should remain), the system:
\nRemoves the overlapping areas from the existing operation variant
\nUpdates the operation variant to keep only the remaining areas
\nPreserves the existing operation variant's parameters (duration, cost, price, etc.)
\nThe freed overlapping areas are added to the working set for reassignment
\nOperations That Would Become Empty
\nIf an existing operation variant would become empty (all its areas are being reassigned), the system:
\nSorts these operations by area count (fewest first) for deterministic processing
\nUpdates all but the last operation with the new parameters and keeps their existing areas
\nRemoves these areas from the working set
\nUpdates the last operation with the new parameters and assigns all remaining areas from the working set to it
\nNew Operation Creation
\nall Parameters (if provided)Remaining Areas Identification
\nThe system retrieves all active areas in the system.
\nIt filters out areas that were already processed in Phase 1 (from detailed entries).
The remaining unprocessed areas are identified.
\nSynthetic DTO Creation
\nFor the remaining areas, the system creates synthetic VariantOperationAreaDTO objects using the parameters from the all configuration.
These synthetic DTOs use AREA_ID type and include all remaining area IDs.
Processing Remaining Areas
\nThe synthetic DTOs are processed using the same conflict resolution logic as Phase 1.
\nThis ensures that all remaining areas receive the default parameters specified in all.
No Deletion: Operation variants are never deleted. They are either updated with new areas/parameters or preserved as-is.
\nArea Preservation: All areas specified in the request (either explicitly in detailed or implicitly via all) are assigned to operation variantsβno areas are lost.
Parameter Updates: When an operation variant is updated, its parameters (duration, cost, price, bookingAnticipationHours) are updated to match the incoming DTO values.
\nCurrency Isolation: Operation variants are always grouped by currency. Areas with different currencies are never mixed in the same operation variant.
\nPriority: detailed entries take precedence over all. Areas specified in detailed are processed first, and all parameters are only applied to areas not covered by detailed.
Use detailed when you need specific configurations for specific areas:
{\n \"operationAreas\": {\n \"detailed\": [\n {\n \"type\": \"areaReference\",\n \"value\": [\"AREA-001\", \"AREA-002\"],\n \"price\": 150.0,\n \"duration\": \"120\"\n }\n ]\n }\n}\n\nUse all when you want to apply the same parameters to all active areas:
{\n \"operationAreas\": {\n \"all\": {\n \"price\": 100.0,\n \"duration\": \"60\",\n \"cost\": 50.0\n }\n }\n}\n\nUse both detailed and all when you need specific configurations for some areas and default parameters for the rest:
{\n \"operationAreas\": {\n \"detailed\": [\n {\n \"type\": \"areaReference\",\n \"value\": [\"AREA-001\"],\n \"price\": 200.0,\n \"duration\": \"180\"\n }\n ],\n \"all\": {\n \"price\": 100.0,\n \"duration\": \"60\"\n }\n }\n}\n\nIn this example, AREA-001 gets the specific configuration (price: 200.0, duration: 180), while all other active areas get the default parameters (price: 100.0, duration: 60).
\nExisting State:
\nOperation Variant A: Areas [1, 2, 3], Currency USD, Price $100
\nOperation Variant B: Areas [4, 5], Currency USD, Price $80
\nSystem has 10 total active areas: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
\nIncoming Request:
\n{\n \"operationAreas\": {\n \"detailed\": [\n {\n \"type\": \"areaId\",\n \"value\": [\"2\", \"3\", \"6\"],\n \"price\": 120.0,\n \"duration\": \"90\"\n }\n ],\n \"all\": {\n \"price\": 80.0,\n \"duration\": \"60\"\n }\n }\n}\n\nResult:
\nOperation Variant A: Updated to Areas [1], Currency USD, Price $100 (areas 2, 3 removed, but price preserved since not in detailed)
\nOperation Variant B: Updated to Areas [4, 5], Currency USD, Price $80 (parameters updated from all)
New Operation Variant C: Areas [2, 3, 6], Currency USD, Price $120, Duration 90 (created from detailed)
New Operation Variant D: Areas [7, 8, 9, 10], Currency USD, Price $80, Duration 60 (created from all for remaining areas)
{\n \"variants\": [\n {\n \"sku\": \"SV-001\",\n \"name\": \"Standard Cleaning Service\",\n \"isInStore\": false,\n \"isExecution\": true,\n \"parentService\": {\n \"name\": \"Cleaning Services\",\n \"description\": \"Professional cleaning services\",\n \"category\": {\n \"name\": \"Home Services\",\n \"description\": \"Services for home maintenance\"\n }\n },\n \"operationAreas\": {\n \"detailed\": [\n {\n \"type\": \"areaReference\",\n \"value\": [\"AREA-001\", \"AREA-002\"],\n \"duration\": \"120\",\n \"price\": 150.0,\n \"cost\": 100.0,\n \"bookingAnticipationHours\": 24\n }\n ],\n \"all\": {\n \"duration\": \"60\",\n \"price\": 100.0,\n \"cost\": 50.0,\n \"bookingAnticipationHours\": 12\n }\n }\n }\n ],\n \"providers\": [\n {\n \"reference\": \"PROV-001\",\n \"basicInformation\": {\n \"name\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phoneNumber\": \"+1234567890\",\n \"identificationNumber\": \"12345678\",\n \"identificationNumberCountry\": \"US\"\n },\n \"isCompany\": false,\n \"workOnHolidays\": false,\n \"isMainProviderEligible\": true,\n \"isLeadAssignmentEligible\": true,\n \"service_variants\": [\n {\n \"type\": \"variantSku\",\n \"value\": \"SV-001\"\n }\n ],\n \"availability\": [\n {\n \"day_of_week\": 1,\n \"start_time\": \"09:00\",\n \"end_time\": \"17:00\"\n },\n {\n \"day_of_week\": 2,\n \"start_time\": \"09:00\",\n \"end_time\": \"17:00\"\n }\n ],\n \"areas\": [\n {\n \"type\": \"areaReference\",\n \"value\": \"AREA-001\"\n }\n ]\n }\n ]\n}\n\n{\n \"success\": true,\n \"message\": \"All operations completed successfully\",\n \"variantsProcessed\": 1,\n \"providersProcessed\": 1,\n \"variantResults\": [\n {\n \"variantId\": 123,\n \"sku\": \"SV-001\",\n \"success\": true\n }\n ],\n \"providerResults\": [\n {\n \"providerId\": 456,\n \"reference\": \"PROV-001\",\n \"success\": true\n }\n ]\n}\n\n{\n \"success\": false,\n \"message\": \"Completed with 2 error(s)\",\n \"variantsProcessed\": 0,\n \"providersProcessed\": 1,\n \"errors\": [\n \"Variant SV-001: Multiple variants found for the same SKU\",\n \"Provider PROV-002: Provider cannot be part of a network\"\n ],\n \"variantResults\": [\n {\n \"variantId\": 0,\n \"sku\": \"SV-001\",\n \"success\": false,\n \"error\": \"Multiple variants found for the same SKU\"\n }\n ],\n \"providerResults\": [\n {\n \"providerId\": 456,\n \"reference\": \"PROV-001\",\n \"success\": true\n },\n {\n \"providerId\": 0,\n \"reference\": \"PROV-002\",\n \"success\": false,\n \"error\": \"Provider cannot be part of a network\"\n }\n ]\n}\n\n[Float] - Latitude, geographical reference of the address
\n","type":"text/plain"},"key":"lat","value":"{{LATITUDE}}"},{"description":{"content":"[Float] - Longitude, geographical reference of the address
\n","type":"text/plain"},"key":"lng","value":"{{LONGITUDE}}"},{"description":{"content":"[CONDITIONAL] - Variant identifier. Not required if sku is provided.
\n","type":"text/plain"},"key":"variantId","value":"{{VARIANTID}}"},{"description":{"content":"[CONDITIONAL] - SKU identifier. If this parameter is provided, variantId is not needed.
\n","type":"text/plain"},"key":"sku","value":"{{SKU}}"}],"variable":[]}},"response":[{"id":"c9235db4-76a7-4746-8d49-163d76ad5566","name":"Coverage by geographical reference and variant id","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ","type":"text"}],"url":{"raw":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/coverage/check?lat=-33.57432&lng=-77.4324&sku=11221323","host":["https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com"],"path":["coverage","check"],"query":[{"key":"lat","value":"-33.57432"},{"key":"lng","value":"-77.4324"},{"key":"sku","value":"11221323","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" true"}],"_postman_id":"5591d11d-61f1-407c-9a80-78277dc32ce4"},{"name":"Available Dates","id":"1d431fa5-c3d2-4a18-993e-e0f392f58919","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"location\": { //Required\n \"type\": \"string\", //\"coordinates\" | \"areaId\" | \"areaReference\",\n \"value\": \"number | Object\" //number | { lat: number, lng: number }\n },\n \"variant\": { //Required\n \"type\": \"string\", //'variantSku' | 'variantId'\n \"value\": \"string\"\n },\n \"provider\": {\n \"type\": \"string\", //'providerId' | 'providerReference'\n \"value\": \"string\"\n },\n \"startDate\": \"YYYY-MM-dd\", //Optional, default now()\n \"quantityOfDays\": \"number\" //Optional, default 5\n}","options":{"raw":{"language":"json"}}},"url":"https://{{ENVIRONMENT}}.integration.cl.sodtrack-shared.sodtrack.com/api/integration/dates/check","description":"Retrieves the available dates for performing a specific service, based on the requested location, service variant, and optional provider parameters.
\nThis endpoint allows client systems to display valid scheduling options to customers, ensuring that the selected date corresponds to Sodtrackβs real-time contractor availability.
\nAvailability is determined based on contractor coverage, variant eligibility, and existing bookings.
\nWhen provider is omitted, the API returns aggregate availability across all eligible providers.
If location.type = \"coordinates\", the system automatically determines the coverage area based on geolocation.
Returned dates are always formatted as ISO 8601 (YYYY-MM-DD).
If no available dates are found, an empty array is returned:
\nRetrieves available time slots for a given date, based on the requested location, service variant, and optional provider parameters.
\nDepending on the tenant configuration, the response may return either:
\nA list of specific times (in 30-minute intervals), or
\nA list of time ranges ({ startTime, endTime }) when time ranges are configured at the tenant level.
This endpoint allows client systems to display accurate, real-time scheduling options for a specific date.
\n{\n \"location\": {\n \"type\": \"coordinates\",\n \"value\": { \"lat\": -33.4489, \"lng\": -70.6693 }\n },\n \"variant\": {\n \"type\": \"variantSku\",\n \"value\": \"install_curtains_sku\"\n },\n \"date\": \"2025-10-10\"\n}\n\n{\n \"location\": {\n \"type\": \"areaSku\",\n \"value\": \"SANTIAGO_RM\"\n },\n \"variant\": {\n \"type\": \"variantId\",\n \"value\": \"567\"\n },\n \"provider\": {\n \"type\": \"providerId\",\n \"value\": \"999\"\n },\n \"date\": \"2025-10-10\"\n}\n\n{\n \"hours\": [\n \"08:00\",\n \"08:30\",\n \"09:00\",\n \"09:30\",\n \"10:00\"\n ]\n}\n\n{\n \"timeRanges\": [\n { \"startTime\": \"08:00\", \"endTime\": \"10:00\" },\n { \"startTime\": \"14:00\", \"endTime\": \"16:30\" }\n ]\n}\n\nNote: The API will return either hours or timeRanges, depending on tenant configuration.
Availability is derived from contractor schedules, coverage zones, and existing bookings.
\nWhen the tenant is configured for time ranges, returned windows are inclusive and may vary in length (e.g., 2-hour blocks).
\nWhen configured for specific times, availability is expressed in 30-minute intervals.
\n{ \"hours\": [] }{ \"timeRanges\": [] }
\nor
\nAll times are expressed in local time relative to the contractorβs region or the defined coverage area.
\nThis section includes the endpoint to verify if a specific variant has coverage in a given location. Simply provide the coordinates and the variant to get an accurate response.
\n","_postman_id":"aa6d6d5d-5a18-40fb-8180-10ca153c1829","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"cc318f6e-0b51-4254-be86-c090e307212f","id":"cc318f6e-0b51-4254-be86-c090e307212f","name":"Sodtrack Integration API","type":"collection"}}},{"name":"π Webhooks","item":[{"name":"Booking","item":[{"name":"BookingDoneEvent","id":"89712c43-e5ae-48a6-82fe-5fa6d715b4a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"timestamp\": \"string\",\n \"userTriggererEmail\": \"string\",\n \"forced\": \"boolean\",\n \"booking\": {\n \"id\": \"number\",\n \"reference\": \"string\",\n \"createdDate\": \"Date\",\n \"serviceVariantTotalPrice\": \"number\",\n \"serviceVariantTotalCost\": \"number\",\n \"serviceName\": \"string\",\n \"totalAddonsCost\": \"number\",\n \"totalAddonsPrice\": \"number\",\n \"totalAddonsDuration\": \"number\",\n \"status\": \"string\",\n \"variantDuration\": \"number\",\n \"transportCost\": \"number\",\n \"quantity\": \"number\",\n \"date\": \"Date\",\n \"doneDate\": \"Date\",\n \"periodStartTime\": \"Date\",\n \"periodEndTime\": \"Date\",\n \"finalCost\": \"number\",\n \"finalPrice\": \"number\",\n \"totalDuration\": \"number\",\n \"category\": {\n \"id\": \"number\",\n \"name\": \"string\"\n },\n \"saleChannel\": {\n \"id\": \"number\",\n \"name\": \"string\"\n },\n \"shoppingCartId\": \"number\",\n \"serviceVariant\": {\n \"id\": \"number\",\n \"name\": \"string\",\n \"skus\": [\n {\n \"id\": \"number\",\n \"sku\": \"string\"\n }\n ]\n },\n \"addons\": [\n {\n \"id\": \"number\",\n \"quantity\": \"number\",\n \"name\": \"string\",\n \"duration\": \"number\",\n \"totalCost\": \"number\",\n \"totalPrice\": \"number\",\n \"unitCost\": \"number\",\n \"unitPrice\": \"number\"\n }\n ],\n \"products\": [\n {\n \"id\": \"number\",\n \"quantity\": \"number\",\n \"productPromisedDeliveryDate\": \"Date\",\n \"sku\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"price\": \"number\",\n \"unit\": {\n \"id\": \"number\",\n \"serialNumber\": \"string\"\n }\n }\n ],\n \"dynamicFieldValues\": [\n {\n \"id\": \"number\",\n \"value\": \"string\"\n }\n ],\n \"dynamicFormFields\": [\n {\n \"reference\": \"string\",\n \"value\": \"string\"\n }\n ]\n },\n \"customer\": {\n \"id\": \"number\",\n \"name\": \"string\",\n \"identificationNumber\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\"\n },\n \"address\": {\n \"id\": \"number\",\n \"coordinates\": {\n \"lng\": \"number\", \n \"lat\": \"number\"\n },\n \"address\": \"string\",\n \"formattedAddress\": \"string\",\n \"areas\": [\n {\n \"id\": \"number\",\n \"name\": \"string\",\n \"reference\": \"\"\n }\n ]\n },\n \"professional\": {\n \"id\": \"number\",\n \"isCompany\": \"boolean\",\n \"reference\": \"string\",\n \"name\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"","description":"The BookingDoneEvent webhook notifies subscribers when a booking has been successfully completed within the Sodtrack platform.
This event is triggered once a bookingβs lifecycle reaches the βdoneβ status β typically after the assigned technician or provider has finalized the job, submitted the completion report, or confirmed the service outcome.
\nIntegrating this webhook allows client systems to automatically synchronize booking statuses, trigger post-service workflows (e.g., invoicing, customer feedback collection, or ERP updates), and maintain real-time operational consistency with Sodtrack.
\nThis webhook is triggered when:
\nA bookingβs status transitions to \"done\"
The booking completion is successfully recorded in the Sodtrack system.
\nOnly bookings that have been fully processed and validated by the system generate this event.
\nAutomatically update booking statuses in external CRMs, ERPs, or scheduling systems.
\nTrigger post-completion workflows such as invoice generation, customer satisfaction surveys, or performance analytics.
\nMaintain synchronized service completion records between Sodtrack and third-party platforms.
\nThe body of this webhook inherits the standard Sodtrack webhook structure, which includes:
\nThe common shared webhook fields
\nThe booking objects
\nIn addition to the shared webhook fields and the standard booking object, this event includes the following additional field:
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[{"id":"b5df695d-0739-4c09-88e9-c551ff11d6a3","name":"BookingDoneEvent","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"timestamp\": \"string\",\n \"userTriggererEmail\": \"string\",\n \"forced\": \"boolean\",\n \"booking\": {\n \"id\": \"number\",\n \"reference\": \"string\",\n \"createdDate\": \"Date\",\n \"serviceVariantTotalPrice\": \"number\",\n \"serviceVariantTotalCost\": \"number\",\n \"serviceName\": \"string\",\n \"totalAddonsCost\": \"number\",\n \"totalAddonsPrice\": \"number\",\n \"totalAddonsDuration\": \"number\",\n \"status\": \"string\",\n \"variantDuration\": \"number\",\n \"transportCost\": \"number\",\n \"quantity\": \"number\",\n \"date\": \"Date\",\n \"doneDate\": \"Date\",\n \"periodStartTime\": \"Date\",\n \"periodEndTime\": \"Date\",\n \"finalCost\": \"number\",\n \"finalPrice\": \"number\",\n \"totalDuration\": \"number\",\n \"category\": {\n \"id\": \"number\",\n \"name\": \"string\"\n },\n \"saleChannel\": {\n \"id\": \"number\",\n \"name\": \"string\"\n },\n \"shoppingCartId\": \"number\",\n \"serviceVariant\": {\n \"id\": \"number\",\n \"name\": \"string\",\n \"skus\": [\n {\n \"id\": \"number\",\n \"sku\": \"string\"\n }\n ]\n },\n \"addons\": [\n {\n \"id\": \"number\",\n \"quantity\": \"number\",\n \"name\": \"string\",\n \"duration\": \"number\",\n \"totalCost\": \"number\",\n \"totalPrice\": \"number\",\n \"unitCost\": \"number\",\n \"unitPrice\": \"number\"\n }\n ],\n \"products\": [\n {\n \"id\": \"number\",\n \"quantity\": \"number\",\n \"productPromisedDeliveryDate\": \"Date\",\n \"sku\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"price\": \"number\",\n \"unit\": {\n \"id\": \"number\",\n \"serialNumber\": \"string\"\n }\n }\n ],\n \"dynamicFieldValues\": [\n {\n \"id\": \"number\",\n \"value\": \"string\"\n }\n ],\n \"dynamicFormFields\": [\n {\n \"reference\": \"string\",\n \"value\": \"string\"\n }\n ]\n },\n \"customer\": {\n \"id\": \"number\",\n \"name\": \"string\",\n \"identificationNumber\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\"\n },\n \"address\": {\n \"id\": \"number\",\n \"coordinates\": {\n \"lng\": \"number\", \n \"lat\": \"number\"\n },\n \"address\": \"string\",\n \"formattedAddress\": \"string\",\n \"areas\": [\n {\n \"id\": \"number\",\n \"name\": \"string\",\n \"reference\": \"\"\n }\n ]\n },\n \"professional\": {\n \"id\": \"number\",\n \"isCompany\": \"boolean\",\n \"reference\": \"string\",\n \"name\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"89712c43-e5ae-48a6-82fe-5fa6d715b4a7"},{"name":"BookingAcceptedEvent","id":"fc2781b9-a3cf-4c15-954d-a0f5e8e140e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"timestamp\": \"string\",\n \"userTriggererEmail\": \"string\",\n \"booking\": {\n \"id\": \"number\",\n \"reference\": \"string\",\n \"createdDate\": \"Date\",\n \"serviceVariantTotalPrice\": \"number\",\n \"serviceVariantTotalCost\": \"number\",\n \"serviceName\": \"string\",\n \"totalAddonsCost\": \"number\",\n \"totalAddonsPrice\": \"number\",\n \"totalAddonsDuration\": \"number\",\n \"status\": \"string\",\n \"variantDuration\": \"number\",\n \"transportCost\": \"number\",\n \"quantity\": \"number\",\n \"date\": \"Date\",\n \"doneDate\": \"Date\",\n \"periodStartTime\": \"Date\",\n \"periodEndTime\": \"Date\",\n \"finalCost\": \"number\",\n \"finalPrice\": \"number\",\n \"totalDuration\": \"number\",\n \"category\": {\n \"id\": \"number\",\n \"name\": \"string\"\n },\n \"saleChannel\": {\n \"id\": \"number\",\n \"name\": \"string\"\n },\n \"shoppingCartId\": \"number\",\n \"serviceVariant\": {\n \"id\": \"number\",\n \"name\": \"string\",\n \"skus\": [\n {\n \"id\": \"number\",\n \"sku\": \"string\"\n }\n ]\n },\n \"addons\": [\n {\n \"id\": \"number\",\n \"quantity\": \"number\",\n \"name\": \"string\",\n \"duration\": \"number\",\n \"totalCost\": \"number\",\n \"totalPrice\": \"number\",\n \"unitCost\": \"number\",\n \"unitPrice\": \"number\"\n }\n ],\n \"products\": [\n {\n \"id\": \"number\",\n \"quantity\": \"number\",\n \"productPromisedDeliveryDate\": \"Date\",\n \"sku\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"price\": \"number\",\n \"unit\": {\n \"id\": \"number\",\n \"serialNumber\": \"string\"\n }\n }\n ],\n \"dynamicFieldValues\": [\n {\n \"id\": \"number\",\n \"value\": \"string\"\n }\n ],\n \"dynamicFormFields\": [\n {\n \"reference\": \"string\",\n \"value\": \"string\"\n }\n ]\n },\n \"customer\": {\n \"id\": \"number\",\n \"name\": \"string\",\n \"identificationNumber\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\"\n },\n \"address\": {\n \"id\": \"number\",\n \"coordinates\": {\n \"lng\": \"number\", \n \"lat\": \"number\"\n },\n \"address\": \"string\",\n \"formattedAddress\": \"string\",\n \"areas\": [\n {\n \"id\": \"number\",\n \"name\": \"string\",\n \"reference\": \"\"\n }\n ]\n },\n \"professional\": {\n \"id\": \"number\",\n \"isCompany\": \"boolean\",\n \"reference\": \"string\",\n \"name\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"","description":"The BookingAcceptedEvent webhook notifies subscribers when a booking has been accepted by a service provider within the Sodtrack platform.
This event is triggered when a provider confirms their availability and commitment to fulfill a service request β typically when a technician or professional accepts a booking assignment with a scheduled date, when a booking with an assigned provider is scheduled by the customer, or a provider and date is assigned directly.
\nThe booking transitions to \"accepted\" status, indicating that a provider is committed to delivering the service at a specific date and time.
\nIntegrating this webhook allows client systems to automatically track provider confirmations, trigger post-acceptance workflows (e.g., customer notifications, schedule confirmations, resource preparation, calendar updates), and maintain real-time operational consistency with Sodtrack.
\nThis webhook is triggered when:
\nThe booking has an assigned provider.
\nThe booking has a scheduled date and time assigned.
\nThe booking status transitions to \"accepted\" in the Sodtrack system.
\nAutomatically send confirmation notifications to customers when a provider accepts their booking with a scheduled date.
\nSynchronize provider acceptance records with external workforce management or scheduling systems.
\nTrigger preparation workflows such as resource allocation, equipment assignment, or route optimization.
\nUpdate calendar systems with confirmed appointments for both customers and providers.
\nTrack provider performance metrics based on acceptance patterns and response times.
\nMaintain synchronized booking status records between Sodtrack and third-party platforms.
\nThe body of this webhook inherits the standard Sodtrack webhook structure, which includes:
\nThe common shared webhook fields
\nThe booking objects
\nThe BookingCreatedEvent webhook notifies subscribers when a new booking has been successfully created within the Sodtrack platform.
This event is triggered once a booking is created and initialized in the system β typically after a customer completes a service request, a booking is generated from a shopping cart, or a booking is created from a budget execution. At this point, the booking enters the βcreatedβ status and becomes ready for provider assignment and scheduling.
\nIntegrating this webhook allows client systems to automatically synchronize new booking records, trigger initial workflows (e.g., provider matching, resource allocation, or external system notifications), and maintain real-time operational consistency with Sodtrack.
\nThis webhook is triggered when:
\nA new booking is successfully created in the Sodtrack system, and
\nThe booking has been initialized with all required information and assigned the \"created\" status.
Only bookings that have been fully validated and persisted by the system generate this event.
\nAutomatically synchronize new booking records in external CRMs, ERPs, or scheduling systems.
\nMaintain synchronized booking creation records between Sodtrack and third-party platforms.
\nInitiate notification workflows to stakeholders about new service requests.
\nThe body of this webhook inherits the standard Sodtrack webhook structure, which includes:
\nThe common shared webhook fields
\nThe booking objects
\nThe BookingProviderAssignedEvent webhook notifies subscribers when a service provider (technician, professional, or company) has been assigned to a booking within the Sodtrack platform.
This event is triggered when a provider is matched and assigned to fulfill a service request β typically through automatic matching algorithms, manual assignment by administrators, or when a provider accepts a booking request.
\nIntegrating this webhook allows client systems to automatically track provider assignments, trigger provider-specific workflows (e.g., job notifications, schedule synchronization, resource preparation), handle provider reassignments, and maintain real-time operational consistency with Sodtrack.
\nThis webhook is triggered when:
\nA provider is successfully assigned to a booking (either initial assignment or reassignment), and
\nThe provider assignment is recorded and validated in the Sodtrack system.
\nThe event includes information about the assigned provider and the booking details, enabling systems to handle provider assignments appropriately.
\nAutomatically synchronize provider assignments in external workforce management, ERP, or scheduling systems.
\nTrigger provider notification workflows (e.g., job alerts, schedule updates, mobile app notifications).
\nMaintain synchronized provider assignment records between Sodtrack and third-party platforms.
\nHandle provider reassignment logic, including notification of previous providers when assignments change.
\nUpdate resource allocation and capacity planning systems based on provider commitments.
\nTrack provider performance metrics by monitoring assignment frequency and patterns.
\nThe body of this webhook inherits the standard Sodtrack webhook structure, which includes:
\nThe common shared webhook fields
\nThe booking objects
\nThe BookingCancelledEvent webhook notifies subscribers when a booking has been cancelled within the Sodtrack platform.
This event is triggered when a booking's lifecycle is terminated before completion β typically when a customer cancels the service request, an administrator cancels the booking, or the booking is cancelled due to an incident resolution.
Once triggered, the booking transitions to the βcancelledβ status and ceases active processing.
Integrating this webhook allows client systems to automatically synchronize booking cancellations, trigger post-cancellation workflows (e.g., refund processing, resource reallocation, inventory updates, or customer communication), and maintain real-time operational consistency with Sodtrack.
\nThis webhook is triggered when:
\nA booking's status transitions to \"cancelled\", and
The booking cancellation is successfully recorded in the Sodtrack system.
\nOnly bookings that have been properly cancelled and validated by the system generate this event.
\nAutomatically update booking statuses in external CRMs, ERPs, or scheduling systems to reflect cancellations.
\nTrigger post-cancellation workflows such as refund processing, provider compensation calculations, or resource reallocation.
\nMaintain synchronized cancellation records between Sodtrack and third-party platforms.
\nInitiate customer communication workflows (e.g., cancellation confirmations, feedback requests).
\nUpdate inventory and availability management systems to free up previously allocated resources.
\nThe body of this webhook inherits the standard Sodtrack webhook structure, which includes:
\nThe common shared webhook fields
\nThe booking objects
\nThe Booking Webhooks group includes all outbound events related to the lifecycle of a booking within Sodtrack.
\nThese webhooks notify subscribed systems whenever any significant booking-related event occurs β ensuring external platforms remain synchronized with real-time booking data.
\nEach event delivers a JSON payload that includes detailed information about the booking object, its current status, and relevant associations (such as assigned provider, service variant, or project context).
\nAll Booking Webhook payloads include a booking object in their body.
The following sections describe the standard fields that may appear across booking-related events.
π§Ύ booking object
customer objectaddress objectprofessional object (optional)The ExternalTransactionCreatedEvent webhook notifies subscribers when a financial transaction has been successfully created and recorded within the Sodtrack platform.
\nThe transaction is recorded with all associated booking and addon movements, enabling comprehensive financial tracking.
\nIntegrating this webhook allows client systems to automatically:
\nSynchronize payment records,
\nTrigger financial workflows (e.g., accounting updates, invoice generation, revenue recognition, reconciliation), and
\nMaintain real-time financial consistency with Sodtrack.
\nThis webhook is triggered when:
\nA financial transaction (payment or refund) is successfully created and validated in the Sodtrack system, and
\nThe transaction is associated with a shopping cart and includes all related booking and addon movements.
\nAutomatically synchronize payment and refund records in external accounting systems, ERPs, or financial platforms.
\nTrigger post-transaction workflows such as invoice generation, receipt delivery, or revenue recognition.
\nMaintain synchronized financial records between Sodtrack and third-party systems.
\nTrack payment status and reconcile transactions across multiple sources.
\nGenerate financial reports and analytics based on transaction patterns.
\nSodtrack supports outbound Webhooks to allow external systems to receive real-time notifications whenever specific events occur within the platform.
\nWebhooks enable seamless integration with third-party systems by automatically sending an HTTP request to a configured endpoint when a defined event is triggeredβsuch as the creation, update, or completion of a booking, project, or payment transaction.
\nThis mechanism ensures that partner systems remain synchronized with Sodtrackβs operational data without the need for continuous polling or manual updates.
\nEvent Trigger:
\n Each webhook is associated with a specific event type (e.g., booking_created, booking_done, technician_assigned).
When the event occurs in Sodtrack, a POST request is sent to the subscriberβs configured endpoint.
\nPayload Delivery:
\nThe webhook request body contains a structured JSON payload describing the event and relevant data objects.
\nThis allows your system to process updates, initiate workflows, or log information in real time.
\nHeaders and Authentication:
\nEach tenant can define custom headers (e.g., authorization tokens or client identifiers) to be included in webhook requests.
\nTo configure or modify these headers, tenants must contact integrations@sodtrack.com.
\nDelivery Reliability:
\n Webhooks are sent as HTTP POST requests with Content-Type: application/json.
Sodtrack automatically retries failed webhook deliveries according to its retry policy to ensure reliable event propagation.
\nAutomatically syncing booking status updates with an ERP or CRM.
\nTriggering post-service surveys or notification workflows upon service completion.
\nUpdating availability or project progress in third-party dashboards.
\nLogging transactional or operational events for analytics or auditing.
\nAlways validate the webhookβs source and signature (if applicable).
\nUse HTTPS endpoints to ensure data is encrypted in transit.
\nImplement idempotency on your webhook receiver to handle potential retries safely.
\nAvoid blocking the webhook requestβrespond quickly with a 2xx status and handle processing asynchronously.
\nEvery webhook payload sent by Sodtrack includes the following top-level fields, regardless of the event type:
\nThese fields are always present at the root level of the webhook payload, alongside the event-specific data (e.g., booking, project, payment).