Get customers

Purpose

Returns a paginated list of customers, with the core fields needed to identify and reconcile a customer against your own records.

Filters can be combined freely: every filter you send is applied together, and a customer is returned only when it satisfies all of them. Customers can be looked up directly (by Sodtrack id, external reference or identification number) or indirectly through their bookings.

This endpoint is designed to resolve and identify customers. It does not return contact details, identity documents or addresses.

🔎 Query parameters

All filters are optional and can be combined. Sending none returns the paginated list of all customers, ordered by id descending.

Filters sent as empty or whitespace-only strings are ignored, exactly as if they had not been sent. Unrecognized query parameters are ignored.

Example Requests

Look up a customer by identification number:

GET /api/integration/customer?identificationNumber=12.345.678-9

Combine filters to confirm that a reference and an identification number belong to the same customer:

GET /api/integration/customer?reference=EXT-CUSTOMER-REF-001&identificationNumber=123456789

Find the customers behind a booking reference:

GET /api/integration/customer?bookingReference=EXT-BOOKING-REF-001

Paginate the full customer list:

GET /api/integration/customer?pageSize=25&pageNumber=2

Response Example

{
  "data": [
    {
      "id": 2001,
      "reference": "EXT-CUSTOMER-REF-001",
      "name": "María",
      "lastname": "García",
      "createdDate": "2024-06-01T10:00:00.000Z"
    },
    {
      "id": 1987,
      "reference": null,
      "name": "Comercial Andes",
      "lastname": null,
      "createdDate": "2024-05-18T08:22:41.000Z"
    }
  ],
  "metadata": {
    "count": 2,
    "pageNumber": 1,
    "pageSize": 10,
    "totalPages": 1
  }
}

Customer item (data[])

Pagination (metadata)

Error Responses

When the filters match no customers, the request still succeeds: data is [] and metadata.count is 0.

Business Rules & Constraints

Combining filters

Every filter present in the request is applied together, and only customers satisfying all of them are returned.

Several filters reach the same customer through different paths: id, reference and identificationNumber point at the customer directly, while bookingId and bookingReference reach it through its bookings. Combining them is a valid way to confirm that a customer matches more than one criterion.

Pointing two filters at different customers is not an error. The request succeeds and returns an empty page, because no single customer satisfies both conditions.

Identification number matching

The identification number is matched after removing separator characters from the value you send, so punctuation formatting does not affect the result.

Spaces are not removed. Send the identification number without internal spaces, or it will not match.

Matching is exact after this normalization: partial identification numbers return no results.

Booking-based filtering

bookingId and bookingReference select bookings first, and then return the customers those bookings belong to.

If no booking matches, or the matching bookings have no customer associated, the response is an empty page.

Pagination

• pageNumber is 1-based: the first page is 1.

• Default pageSize is 10, maximum is 50.

• count reflects all customers matching the filters, not only those on the current page.

• Results are always ordered by id descending, so the most recently created customers appear first.