{"info":{"_postman_id":"d6a81ff8-cfff-461a-ae4f-9b598b8b8fd1","name":"Travellink Api - OTA - Documentation","description":"

This API is designed for the management of domains and store-related clients.

It supports the creation of user accounts with scoped permissions — either limited to a specific store or with access across multiple store contexts.

The StoreId parameter should be provided only when there is no implicit association between the user and a specific store.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"45687227","collectionId":"d6a81ff8-cfff-461a-ae4f-9b598b8b8fd1","publishedId":"2sB34ZqPn7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-06-30T20:14:24.000Z"},"item":[{"name":"Store","item":[{"name":"Store","id":"62a3b0fe-6511-4ec4-b0fa-6a1848b25e1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Developer-Token","value":"{{Developer-Token}}","type":"text"},{"key":"Developer-Access-Code","value":"{{Developer-Access-Code}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"StoreId\": 13,\r\n \"AccessCredentials\": {\r\n \"Company\": {\r\n \"Identifier\": \"\",\r\n \"Password\": \"\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/TravellinkWebApi/api/v1/ota/store","description":"

GET Store Information

This endpoint retrieves store information from the system based on the provided access credentials.

Request Method

GET

Request URL

https://wooba-sandbox.travellink.com.br/asTravellinkWebApi/api/v1/ota/store

Request Body

The request must include the following parameters in JSON format:

StoreId (integer): The unique identifier for the store you want to retrieve information for.
\n
AccessCredentials (object): Contains the credentials required for authentication.
\n
- Company (object): An object that holds the company credentials.
  \n
  - Identifier (string): The unique identifier for the company.
    \n
  - Password (string): The password associated with the company identifier.
    \n
  \n
\n

Expected Response Structure

Upon a successful request, the response will contain the following fields:

Stores (array): A list of stores retrieved from the system. Each store object may include:
\n
- Id (integer): The unique identifier of the store.
  \n
- Name (string): The name of the store.
  \n
- Email (string): The email associated with the store.
  \n
- State (integer): The state code of the store.
  \n
- StateDescription (string): A description of the state of the store.
  \n
\n
Errors (array): An array that contains any errors encountered during the request (empty if successful).
\n
- Each error object may include:
  \n
  - Message (string): A description of the error.
    \n
  - Exception (string): Detailed exception information if applicable.
    \n
  \n
\n
Success (boolean): Indicates whether the request was successful.
\n
RequestDate (string): The date and time when the request was made.
\n

Notes

This endpoint is essential for accessing store data. Ensure that the credentials provided are correct to avoid authentication errors.

\n","urlObject":{"path":["TravellinkWebApi","api","v1","ota","store"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"62a3b0fe-6511-4ec4-b0fa-6a1848b25e1b"}],"id":"355dcf45-8c31-4f08-9238-5be10a1492b7","description":"

Endpoints designed for store management.

\n","_postman_id":"355dcf45-8c31-4f08-9238-5be10a1492b7"},{"name":"Domain","item":[{"name":"Get","id":"a7f8bc22-49b5-43dc-a4f2-e6bd2ec3b8a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Developer-Token","value":"{{Developer-Token}}","type":"text"},{"key":"Developer-Access-Code","value":"{{Developer-Access-Code}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"StoreId\": 13,\r\n \"AccessCredentials\": {\r\n \"Company\": {\r\n \"Identifier\": \"\",\r\n \"Password\": \"\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/TravellinkWebApi/api/v1/ota/domain","description":"

Endpoint Description

This API endpoint retrieves domain information associated with a specific store in the Travellink system. It requires authentication credentials and the store identifier to successfully fetch the data.

Request

Method: GET
URL: https://wooba-sandbox.travellink.com.br/TravellinkWebApi/api/v1/ota/domain

Request Body

The request body must be a JSON object containing the following parameters:

StoreId (integer): The unique identifier for the store. In the provided example, the value is 13.
\n
AccessCredentials (object): Contains the authentication details required to access the API.
\n
- Company (object): Holds the company-specific credentials.
  \n
  - Identifier (string): The identifier for the company, e.g., .
    \n
  - Password (string): The password associated with the identifier, e.g., .
    \n
  \n
\n

Response

On a successful request, the API returns a JSON object with the following structure:

Domains (array): An array of domain objects associated with the store.
\n
- Each domain object contains:
  \n
  - Id (integer): The unique identifier for the domain.
    \n
  - Host (string): The host associated with the domain.
    \n
  - Email (string): The email address linked to the domain.
    \n
  - DocumentNumber (string): The document number related to the domain.
    \n
  - Type (integer): The type of the domain.
    \n
  - State (integer): The state of the domain.
    \n
  \n
\n
Errors (array): An array that will contain any error messages if the request fails. In a successful response, this will be empty.
\n
Success (boolean): Indicates whether the request was successful. A value of true indicates success.
\n
RequestDate (string): The date and time when the request was made.
\n

Notes

Ensure that the StoreId and AccessCredentials are correctly provided to avoid authentication errors.
\n
The response will vary based on the domains associated with the specified StoreId.
\n

\n","urlObject":{"path":["TravellinkWebApi","api","v1","ota","domain"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"a7f8bc22-49b5-43dc-a4f2-e6bd2ec3b8a2"},{"name":"Get By Id","id":"8429e461-1fb5-4644-b00e-fd2b8b1e7542","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Developer-Token","value":"{{Developer-Token}}","type":"text"},{"key":"Developer-Access-Code","value":"{{Developer-Access-Code}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"StoreId\": 13,\r\n \"AccessCredentials\": {\r\n \"Company\": {\r\n \"Identifier\": \"\",\r\n \"Password\": \"\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/TravellinkWebApi/api/v1/ota/domain/373","description":"

API Endpoint: Retrieve Domain Information

This endpoint allows clients to retrieve domain information associated with a specific store in the Travellink system. The request must include valid access credentials to authenticate the request.

Request

Method: GET
\n
URL: https://wooba-sandbox.travellink.com.br/TravellinkWebApi/api/v1/ota/domain/373
\n

Request Body

The request body must be sent in JSON format and includes the following parameters:

StoreId (integer): The unique identifier for the store. In this case, the value is 13.
\n
AccessCredentials (object): An object containing the credentials needed for authentication.
\n
- Company (object): An object that holds the company-specific credentials.
  \n
  - Identifier (string): The identifier for the company, e.g., \"\".
    \n
  - Password (string): The password associated with the identifier, e.g., \"\".
    \n
  \n
\n

Response

Upon a successful request, the API will return a JSON response with the following structure:

Domains (array): An array of domain objects associated with the store.
\n
- Each domain object contains:
  \n
  - Id (integer): The unique identifier for the domain.
    \n
  - Host (string): The host associated with the domain.
    \n
  - Email (string): The email address linked to the domain.
    \n
  - DocumentNumber (string): The document number related to the domain.
    \n
  - Type (integer): The type of the domain.
    \n
  - State (integer): The state of the domain.
    \n
  \n
\n
Errors (array): An array that will contain any errors encountered during the request. If no errors occurred, this will be an empty array.
\n
Success (boolean): Indicates whether the request was successful or not.
\n
RequestDate (string): The date when the request was made.
\n

Example Response

{\n  \"Domains\": [\n    {\n      \"Id\": 0,\n      \"Host\": \"\",\n      \"Email\": \"\",\n      \"DocumentNumber\": \"\",\n      \"Type\": 0,\n      \"State\": 0\n    }\n  ],\n  \"Errors\": [],\n  \"Success\": true,\n  \"RequestDate\": \"\"\n}\n\n

This endpoint is essential for accessing domain information, which can be used for various operational needs within the Travellink system.

\n","urlObject":{"path":["TravellinkWebApi","api","v1","ota","domain","373"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"8429e461-1fb5-4644-b00e-fd2b8b1e7542"},{"name":"Create","id":"0e2d262a-5a4d-4dc2-a4c0-daa23620d5b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Developer-Token","value":"{{Developer-Token}}","type":"text"},{"key":"Developer-Access-Code","value":"{{Developer-Access-Code}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"StoreId\": 13,\r\n \"AccessCredentials\": {\r\n \"Company\": {\r\n \"Identifier\": \"\",\r\n \"Password\": \"\"\r\n }\r\n },\r\n \"Domain\": {\r\n \"Host\": \"@travellink.com.br\",\r\n \"Email\": \"\",\r\n \"DocumentNumber\": \"\",\r\n \"Type\": \"Host\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/TravellinkWebApi/api/v1/ota/domain","description":"

API Endpoint: Create Domain

This endpoint allows you to create a new domain entry in the system. It requires specific credentials and domain details to be provided in the request body.

Request

Method: POST
URL: {{baseEndpoint}}/TravellinkWebApi/api/v1/ota/domain

Request Body

The request body must be a JSON object containing the following parameters:

StoreId (integer): The identifier for the store where the domain is associated.
\n
AccessCredentials (object): Contains the credentials required for authentication.
\n
- Company (object): Holds the company-specific credentials.
  \n
  - Identifier (string): The unique identifier for the company.
    \n
  - Password (string): The password associated with the company identifier.
    \n
  \n
\n
Domain (object): Contains details about the domain to be created.
\n
- Host (string): The host name for the domain.
  \n
- Email (string): An optional email address associated with the domain.
  \n
- DocumentNumber (string): An optional document number related to the domain.
  \n
- Type (integer): The type of the domain (e.g., Host).
  \n
\n

Example Request Body

{\n  \"StoreId\": 13,\n  \"AccessCredentials\": {\n    \"Company\": {\n      \"Identifier\": \"\",\n      \"Password\": \"\"\n    }\n  },\n  \"Domain\": {\n    \"Host\": \"@travellink.com.br\",\n    \"Email\": \"\",\n    \"DocumentNumber\": \"\",\n    \"Type\": \"Host\"\n  }\n}\n\n

Response

On a successful request, the API will return a JSON response with the following structure:

Domain (object): Contains the details of the created domain.
\n
- Id (integer): The identifier of the created domain.
  \n
- Host (string): The host name for the domain.
  \n
- Email (string): The email associated with the domain.
  \n
- DocumentNumber (string): The document number related to the domain.
  \n
- Type (integer): The type of the domain.
  \n
- State (integer): The state of the domain (e.g., active, inactive).
  \n
\n
Errors (array): An array containing any errors that occurred during the request. If the request is successful, this will be empty.
\n
Success (boolean): Indicates whether the request was successful.
\n
RequestDate (string): The date and time when the request was made.
\n

Example Response

{\n  \"Domain\": {\n    \"Id\": 0,\n    \"Host\": \"\",\n    \"Email\": \"\",\n    \"DocumentNumber\": \"\",\n    \"Type\": 0,\n    \"State\": 0\n  },\n  \"Errors\": [],\n  \"Success\": true,\n  \"RequestDate\": \"\"\n}\n\n

Notes

Ensure that the AccessCredentials are valid to avoid authentication errors.
\n
The Host parameter must be correctly formatted to ensure the domain is created successfully.
\n
Check the Errors array in the response for any issues if the request is not successful.
\n

\n","urlObject":{"path":["TravellinkWebApi","api","v1","ota","domain"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"0e2d262a-5a4d-4dc2-a4c0-daa23620d5b9"},{"name":"Change","id":"e8f8b44c-76fa-4458-a4a7-330a9aad6b84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Developer-Token","value":"{{Developer-Token}}","type":"text"},{"key":"Developer-Access-Code","value":"{{Developer-Access-Code}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"StoreId\": 13,\r\n \"AccessCredentials\": {\r\n \"Company\": {\r\n \"Identifier\": \"\",\r\n \"Password\": \"\"\r\n }\r\n },\r\n \"Domain\": {\r\n \"Host\": \"\",\r\n \"Email\": \"fulano.silva@wooba.com.br\",\r\n \"DocumentNumber\": \"124.124.124-24\",\r\n \"Type\": \"EmailAndDocument\",\r\n \"State\": \"Active\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/TravellinkWebApi/api/v1/ota/domain/422","description":"

PATCH Request to Update Domain Information

This endpoint allows you to update the domain information associated with a specific store in the system. It is primarily used to modify the domain details such as the host, email, document number, and type of the domain.

Request Format

Method: PATCH
\n
URL: https://wooba-sandbox.travellink.com.br/TravellinkWebApi/api/v1/ota/domain/{id}
\n

Request Body

The request body must be formatted as a JSON object containing the following keys:

StoreId (integer): The identifier for the store.
\n
AccessCredentials (object): Contains the credentials for accessing the API.
\n
- Company (object):
  \n
  - Identifier (string): The identifier for the company.
    \n
  - Password (string): The password associated with the company identifier.
    \n
  \n
\n
Domain (object): Contains the domain information to be updated.
\n
- Host (string): The host of the domain (can be empty).
  \n
- Email (string): The email associated with the domain.
  \n
- DocumentNumber (string): The document number associated with the domain.
  \n
- Type (string): The type of the domain (e.g., \"EmailAndDocument\").
  \n
- State (string): The current state of the domain (e.g., \"Active\").
  \n
\n

Example Request Body

{\n  \"StoreId\": 13,\n  \"AccessCredentials\": {\n    \"Company\": {\n      \"Identifier\": \"\",\n      \"Password\": \"\"\n    }\n  },\n  \"Domain\": {\n    \"Host\": \"\",\n    \"Email\": \"fulano.silva@wooba.com.br\",\n    \"DocumentNumber\": \"124.124.124-24\",\n    \"Type\": \"EmailAndDocument\",\n    \"State\": \"Active\"\n  }\n}\n\n

Response Structure

Upon a successful request, the response will contain the following structure:

Domain (object): Contains the updated domain information.
\n
- Id (integer): The unique identifier of the domain.
  \n
- Host (string): The host of the domain.
  \n
- Email (string): The email associated with the domain.
  \n
- DocumentNumber (string): The document number associated with the domain.
  \n
- Type (integer): The type of the domain represented as an integer.
  \n
- State (integer): The state of the domain represented as an integer.
  \n
\n
Errors (array): An array containing any errors that occurred during the request. This will be empty if there are no errors.
\n
Success (boolean): Indicates whether the request was successful.
\n
RequestDate (string): The date and time when the request was made.
\n

Example Response

{\n  \"Domain\": {\n    \"Id\": 0,\n    \"Host\": \"\",\n    \"Email\": \"\",\n    \"DocumentNumber\": \"\",\n    \"Type\": 0,\n    \"State\": 0\n  },\n  \"Errors\": [],\n  \"Success\": true,\n  \"RequestDate\": \"\"\n}\n\n

This endpoint is useful for maintaining and updating domain information associated with your store, ensuring that the details are current and accurate.

\n","urlObject":{"path":["TravellinkWebApi","api","v1","ota","domain","422"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"e8f8b44c-76fa-4458-a4a7-330a9aad6b84"},{"name":"Change Only State","id":"d379f886-9540-4e2c-8338-6c66efb90f02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Developer-Token","value":"{{Developer-Token}}","type":"text"},{"key":"Developer-Access-Code","value":"{{Developer-Access-Code}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"StoreId\": 13,\r\n \"AccessCredentials\": {\r\n \"Company\": {\r\n \"Identifier\": \"\",\r\n \"Password\": \"\"\r\n }\r\n },\r\n \"Domain\": {\r\n \"State\": \"Inactive\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/TravellinkWebApi/api/v1/ota/domain/422","description":"

PATCH Request to Update Domain State

This endpoint allows you to update the state of a domain associated with a specific store. By sending a PATCH request to the specified URL, you can change the status of the domain to either active or inactive.

Request Parameters

The request body must be in JSON format and should include the following parameters:

StoreId (integer): The identifier for the store whose domain state you want to update.
\n
AccessCredentials (object): Contains the credentials required for authentication.
\n
- Company (object): Holds the company credentials.
  \n
  - Identifier (string): The unique identifier for the API access.
    \n
  - Password (string): The password associated with the API access.
    \n
  \n
\n
Domain (object): Contains the details of the domain to be updated.
\n
- State (string): The new state for the domain (e.g., \"Inactive\").
\n

Example Request Body

{\n  \"StoreId\": 13,\n  \"AccessCredentials\": {\n    \"Company\": {\n      \"Identifier\": \"\",\n      \"Password\": \"\"\n    }\n  },\n  \"Domain\": {\n    \"State\": \"Inactive\"\n  }\n}\n\n

Expected Response

A successful request will return a response with the following structure:

Domain (object): Contains information about the updated domain.
\n
- Id (integer): The identifier of the domain.
  \n
- Host (string): The host of the domain.
  \n
- Email (string): The email associated with the domain.
  \n
- DocumentNumber (string): The document number related to the domain.
  \n
- Type (integer): The type of the domain.
  \n
- State (integer): The current state of the domain.
  \n
\n
Errors (array): An array that will be empty if there are no errors.
\n
Success (boolean): Indicates whether the request was successful.
\n
RequestDate (string): The date when the request was made.
\n

Example Response

{\n  \"Domain\": {\n    \"Id\": 0,\n    \"Host\": \"\",\n    \"Email\": \"\",\n    \"DocumentNumber\": \"\",\n    \"Type\": 0,\n    \"State\": 0\n  },\n  \"Errors\": [],\n  \"Success\": true,\n  \"RequestDate\": \"\"\n}\n\n

Notes

Ensure that the StoreId and AccessCredentials are valid to avoid authentication errors.
\n
The state of the domain can be set to \"Inactive\" or \"Active\" based on your requirements.
\n

\n","urlObject":{"path":["TravellinkWebApi","api","v1","ota","domain","422"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"d379f886-9540-4e2c-8338-6c66efb90f02"}],"id":"e1936936-df7d-4318-a13f-bade2200a074","_postman_id":"e1936936-df7d-4318-a13f-bade2200a074","description":""},{"name":"Customer","item":[{"name":"Get","id":"363e8b7e-6f7d-48c1-8a72-531a13ebaef1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Developer-Token","value":"{{Developer-Token}}","type":"text"},{"key":"Developer-Access-Code","value":"{{Developer-Access-Code}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"StoreId\": 13,\r\n \"AccessCredentials\": {\r\n \"Company\": {\r\n \"Identifier\": \"\",\r\n \"Password\": \"\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/TravellinkWebApi/api/v1/ota/customer","description":"

API Endpoint: Retrieve Customer Information

Method

GET

Endpoint

https://wooba-sandbox.travellink.com.br/TravellinkWebApi/api/v1/ota/customer

Description

This endpoint retrieves customer information associated with a specific store. It requires authentication credentials and the store identifier to access the customer data.

Request Parameters

The request body must be sent in JSON format and includes the following parameters:

StoreId (integer): The identifier for the store from which customer data is being requested.
\n
AccessCredentials (object): Contains the credentials required for authentication.
\n
- Company (object): Holds the company-specific authentication details.
  \n
  - Identifier (string): The unique identifier for the company.
    \n
  - Password (string): The password associated with the company identifier.
    \n
  \n
\n

Example Request Body

{\n  \"StoreId\": 13,\n  \"AccessCredentials\": {\n    \"Company\": {\n      \"Identifier\": \"\",\n      \"Password\": \"\"\n    }\n  }\n}\n\n

Expected Response Format

On a successful request, the response will be in JSON format with the following structure:

Customers (array): A list of customer objects. Each customer object contains:
\n
- Id (integer): The unique identifier for the customer.
  \n
- Name (string): The name of the customer.
  \n
- Email (string): The email address of the customer.
  \n
- BirthDate (string): The birth date of the customer.
  \n
- State (integer): The state code associated with the customer.
  \n
- Document (object): Contains document details.
  \n
  - Type (integer): The type of document.
    \n
  - Number (string): The document number.
    \n
  \n
- Phones (array): A list of phone objects, each containing:
  \n
  - Type (integer): The type of phone.
    \n
  - CountryCode (string): The country code for the phone number.
    \n
  - AreaCode (string): The area code for the phone number.
    \n
  - Number (string): The phone number.
    \n
  \n
\n
Errors (array): An array that will contain any errors encountered during the request. If there are no errors, this will be an empty array.
\n
Success (boolean): Indicates whether the request was successful.
\n
RequestDate (string): The date when the request was made.
\n

Example Response

{\n  \"Customers\": [\n    {\n      \"Id\": 0,\n      \"Name\": \"\",\n      \"Email\": \"\",\n      \"BirthDate\": \"\",\n      \"State\": 0,\n      \"Document\": {\n        \"Type\": 0,\n        \"Number\": \"\"\n      },\n      \"Phones\": [\n        {\n          \"Type\": 0,\n          \"CountryCode\": \"\",\n          \"AreaCode\": \"\",\n          \"Number\": \"\"\n        }\n      ]\n    }\n  ],\n  \"Errors\": [],\n  \"Success\": true,\n  \"RequestDate\": \"\"\n}\n\n

\n","urlObject":{"path":["TravellinkWebApi","api","v1","ota","customer"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"363e8b7e-6f7d-48c1-8a72-531a13ebaef1"},{"name":"Get By Id","id":"c3fbde5b-203c-49fe-a18e-f95ac802d04d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Developer-Token","value":"{{Developer-Token}}","type":"text"},{"key":"Developer-Access-Code","value":"{{Developer-Access-Code}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"StoreId\": 13,\r\n \"AccessCredentials\": {\r\n \"Company\": {\r\n \"Identifier\": \"\",\r\n \"Password\": \"\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/TravellinkWebApi/api/v1/ota/customer/110","description":"

API Endpoint: Get Customer Information

This endpoint retrieves detailed information about a specific customer identified by their unique ID. It requires authentication credentials and a store identifier to access the customer data.

Request

Method: GET
\n
URL: https://wooba-sandbox.travellink.com.br/TravellinkWebApi/api/v1/ota/customer/{customerId}
\n

Request Body (JSON)

The request body must be sent in JSON format and should include the following parameters:

StoreId (integer): The identifier for the store making the request.
\n
AccessCredentials (object): Contains the authentication details.
\n
- Company (object): Holds the company credentials.
  \n
  - Identifier (string): The unique identifier for the API access.
    \n
  - Password (string): The password associated with the API access.
    \n
  \n
\n

Example Request Body:

{\n  \"StoreId\": 13,\n  \"AccessCredentials\": {\n    \"Company\": {\n      \"Identifier\": \"\",\n      \"Password\": \"\"\n    }\n  }\n}\n\n

Response

Upon a successful request, the server responds with a JSON object containing customer details.

Response Structure

Customers (array): A list of customer objects.
\n
- Id (integer): The unique identifier for the customer.
  \n
- Name (string): The name of the customer.
  \n
- Email (string): The email address of the customer.
  \n
- BirthDate (string): The birth date of the customer (format: YYYY-MM-DD).
  \n
- State (integer): The state code associated with the customer.
  \n
- Document (object): Contains document details.
  \n
  - Type (integer): The type of document (e.g., ID, passport).
    \n
  - Number (string): The document number.
    \n
  \n
- Phones (array): A list of phone objects associated with the customer.
  \n
  - Type (integer): The type of phone (e.g., mobile, home).
    \n
  - CountryCode (string): The country code for the phone number.
    \n
  - AreaCode (string): The area code for the phone number.
    \n
  - Number (string): The actual phone number.
    \n
  \n
\n
Errors (array): An array that contains any errors that occurred during the request.
\n
Success (boolean): Indicates whether the request was successful.
\n
RequestDate (string): The date and time when the request was made.
\n

Example Response:

{\n  \"Customers\": [\n    {\n      \"Id\": 0,\n      \"Name\": \"\",\n      \"Email\": \"\",\n      \"BirthDate\": \"\",\n      \"State\": 0,\n      \"Document\": {\n        \"Type\": 0,\n        \"Number\": \"\"\n      },\n      \"Phones\": [\n        {\n          \"Type\": 0,\n          \"CountryCode\": \"\",\n          \"AreaCode\": \"\",\n          \"Number\": \"\"\n        }\n      ]\n    }\n  ],\n  \"Errors\": [],\n  \"Success\": true,\n  \"RequestDate\": \"\"\n}\n\n

This endpoint is essential for applications that need to access customer data securely and efficiently.

\n","urlObject":{"path":["TravellinkWebApi","api","v1","ota","customer","110"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c3fbde5b-203c-49fe-a18e-f95ac802d04d"},{"name":"Change","id":"9d2db18e-69c0-49ec-baef-269fa3d9980e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Developer-Token","value":"{{Developer-Token}}","type":"text"},{"key":"Developer-Access-Code","value":"{{Developer-Access-Code}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"StoreId\": 13,\r\n \"AccessCredentials\": {\r\n \"Company\": {\r\n \"Identifier\": \"\",\r\n \"Password\": \"\"\r\n }\r\n },\r\n \"Customer\": {\r\n \"Name\": \"John Doe Junior\",\r\n \"Document\": {\r\n \"Type\": 1,\r\n \"Number\": \"036.877.390-66\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/TravellinkWebApi/api/v1/ota/customer/108","description":"

PATCH Customer Information

This endpoint allows you to update the information of a specific customer identified by their unique ID. The request modifies customer details such as their name, email, birth date, state, document information, and phone numbers.

Request Parameters

The request body must be sent in JSON format and should include the following parameters:

StoreId (integer): The identifier for the store associated with the customer.
\n
AccessCredentials (object): Contains the credentials required for authentication.
\n
- Company (object): An object that holds the company credentials.
  \n
  - Identifier (string): The unique identifier for the company.
    \n
  - Password (string): The password associated with the company identifier.
    \n
  \n
\n
Customer (object): Contains the details of the customer to be updated.
\n
- Id (integer): The unique identifier of the customer.
  \n
- Name (string): The name of the customer.
  \n
- Email (string): The email address of the customer.
  \n
- BirthDate (string): The birth date of the customer in ISO 8601 format.
  \n
- State (integer): The state identifier associated with the customer.
  \n
- Document (object): Contains the customer's document information.
  \n
  - Type (integer): The type of document (e.g., CPF, CNPJ).
    \n
  - Number (string): The document number.
    \n
  \n
- Phones (array of objects): A list of phone numbers associated with the customer.
  \n
  - Each phone object can include:
    \n
    - Type (integer): The type of phone number.
      \n
    - CountryCode (string): The country code for the phone number.
      \n
    - AreaCode (string): The area code for the phone number.
      \n
    - Number (string): The actual phone number.
      \n
    \n
  \n
\n

Response Structure

Upon a successful request, the response will contain the following fields:

Customer (object): Reflects the updated customer information.
\n
- Id (integer): The unique identifier of the customer (should be 0 if not found).
  \n
- Name (string): The name of the customer.
  \n
- Email (string): The email address of the customer.
  \n
- BirthDate (string): The birth date of the customer.
  \n
- State (integer): The state identifier associated with the customer.
  \n
- Document (object): Contains the document information.
  \n
  - Type (integer): The type of document.
    \n
  - Number (string): The document number.
    \n
  \n
- Phones (array of objects): A list of phone numbers associated with the customer.
  \n
  - Each phone object includes:
    \n
    - Type (integer): The type of phone number.
      \n
    - CountryCode (string): The country code for the phone number.
      \n
    - AreaCode (string): The area code for the phone number.
      \n
    - Number (string): The actual phone number.
      \n
    \n
  \n
\n
Errors (array): An array that contains any errors encountered during the request (empty if successful).
\n
Success (boolean): Indicates whether the request was successful.
\n
RequestDate (string): The date and time when the request was made.
\n

This endpoint is crucial for maintaining up-to-date customer records within the system.

\n","urlObject":{"path":["TravellinkWebApi","api","v1","ota","customer","108"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"9d2db18e-69c0-49ec-baef-269fa3d9980e"},{"name":"Create","id":"6c4a503e-4967-47ad-bffc-ade6c8de624b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Developer-Token","value":"{{Developer-Token}}","type":"text"},{"key":"Developer-Access-Code","value":"{{Developer-Access-Code}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"StoreId\": 0,\r\n \"AccessCredentials\": {\r\n \"Company\": {\r\n \"Identifier\": \"\",\r\n \"Password\": \"\"\r\n }\r\n },\r\n \"Person\": {\r\n \"FirstName\": \"John\",\r\n \"MiddleName\": \"\",\r\n \"Surname\": \"Doe\",\r\n \"Gender\": \"Male\",\r\n \"BirthDate\": \"1999-06-30\",\r\n \"Email\": \"johndoexx@wooba.com.br\"\r\n },\r\n \"Documents\": [\r\n {\r\n \"Type\": \"Cpf\", //['Cpf', 'Cnpj', 'DriverLicense', 'Passport', 'RNE', 'RG', 'CNH', 'OAB']\r\n \"Number\": \"250.382.070-06\",\r\n \"Validity\": \"2030-06-30T17:39:19.893Z\",\r\n \"IssuingCountry\": \"BR\"\r\n }\r\n ],\r\n \"Phones\": [\r\n {\r\n \"Type\": \"Mobile\", //['General', 'Commercial', 'Fax', 'Mobile']\r\n \"CountryCode\": \"55\",\r\n \"AreaCode\": \"51\",\r\n \"Number\": \"999999999\"\r\n }\r\n ],\r\n \"Address\": {\r\n \"ZipCode\": \"99999999\",\r\n \"Country\": \"BR\",\r\n \"State\": \"SP\",\r\n \"City\": \"Sao Paulo\",\r\n \"Neighborhood\": \"Vila Madalena\",\r\n \"Address1\": \"Rua Sao Paulo\",\r\n \"Address2\": \"Apto 123\",\r\n \"Number\": \"123\"\r\n },\r\n \"Password\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/TravellinkWebApi/api/v1/ota/customer","description":"

POST Customer Information

This endpoint allows you to create a new customer record in the system.

Request Method

POST

Request URL

https://wooba-sandbox.travellink.com.br/TravellinkWebApi/api/v1/ota/customer

Request Parameters

The request body must be sent in JSON format and should include the following parameters:

StoreId (integer): The identifier for the store associated with the customer.
\n
AccessCredentials (object): Contains the credentials required for authentication.
\n
- Company (object): An object that holds the company credentials.
  \n
  - Identifier (string): The unique identifier for the company.
    \n
  - Password (string): The password associated with the company identifier.
    \n
  \n
\n
Person (object): Contains the details of the customer to be created.
\n
- FirstName (string): The first name of the customer.
  \n
- Surname (string): The surname of the customer.
  \n
- Gender (string): The gender of the customer.
  \n
- BirthDate (string): The birth date of the customer in ISO 8601 format.
  \n
- Email (string): The email address of the customer.
  \n
\n
Documents (array of objects): A list of documents associated with the customer.
\n
- Each document object can include:
  \n
  - Type (string): The type of document (e.g., CPF).
    \n
  - Number (string): The document number.
    \n
  - Validity (string): The validity date of the document in ISO 8601 format.
    \n
  - IssuingCountry (string): The country that issued the document.
    \n
  \n
\n
Phones (array of objects): A list of phone numbers associated with the customer.
\n
- Each phone object can include:
  \n
  - Type (string): The type of phone number (e.g., Mobile).
    \n
  - CountryCode (string): The country code for the phone number.
    \n
  - AreaCode (string): The area code for the phone number.
    \n
  - Number (string): The actual phone number.
    \n
  \n
\n
Address (object): Contains the address details of the customer.
\n
- ZipCode (string): The postal code of the address.
  \n
- Country (string): The country of the address.
  \n
- State (string): The state of the address.
  \n
- City (string): The city of the address.
  \n
- Neighborhood (string): The neighborhood of the address.
  \n
- Address1 (string): The primary address line.
  \n
- Address2 (string): The secondary address line.
  \n
- Number (string): The house or apartment number.
  \n
\n
Password (string): The password for the customer account.
\n

Response Structure

Upon a successful request, the response will contain the following fields:

Customer (object): Reflects the created customer information.
\n
- Id (integer): The unique identifier of the customer (should be 0 if not found).
  \n
- Name (string): The name of the customer.
  \n
- Email (string): The email address of the customer.
  \n
- BirthDate (string): The birth date of the customer.
  \n
- State (integer): The state identifier associated with the customer.
  \n
- Document (object): Contains the document information.
  \n
  - Type (integer): The type of document.
    \n
  - Number (string): The document number.
    \n
  \n
- Phones (array of objects): A list of phone numbers associated with the customer.
  \n
  - Each phone object includes:
    \n
    - Type (integer): The type of phone number.
      \n
    - CountryCode (string): The country code for the phone number.
      \n
    - AreaCode (string): The area code for the phone number.
      \n
    - Number (string): The actual phone number.
      \n
    \n
  \n
\n
Errors (array): An array that contains any errors encountered during the request (empty if successful).
\n
Success (boolean): Indicates whether the request was successful.
\n
RequestDate (string): The date and time when the request was made.
\n

This endpoint is crucial for maintaining up-to-date customer records within the system.

\n","urlObject":{"path":["TravellinkWebApi","api","v1","ota","customer"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"6c4a503e-4967-47ad-bffc-ade6c8de624b"},{"name":"Change Only State","id":"a5dd0294-9caa-4d46-af2d-989c5bf16ffa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Developer-Token","value":"{{Developer-Token}}","type":"text"},{"key":"Developer-Access-Code","value":"{{Developer-Access-Code}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"StoreId\": 13,\r\n \"AccessCredentials\": {\r\n \"Company\": {\r\n \"Identifier\": \"\",\r\n \"Password\": \"\"\r\n },\r\n \"Customer\": {\r\n \"State\": \"Inactive\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/TravellinkWebApi/api/v1/ota/customer/87","description":"

PATCH Customer Status

This endpoint allows you to update the status of a customer in the system.

Endpoint:
PATCH https://wooba-sandbox.travellink.com.br/TravellinkWebApi/api/v1/ota/customer/{customerId}
Replace {customerId} with the actual ID of the customer you wish to update.

Request Body Parameters:

StoreId (integer, required): The identifier for the store associated with the request.
\n
AccessCredentials (object, required): Contains the credentials for accessing the API.
\n
- Company (object, required): The company details.
  \n
  - Identifier (string, required): The identifier for the API access.
    \n
  - Password (string, required): The password for the API access.
    \n
  \n
\n
Customer (object, required): Contains the details of the customer to be updated.
\n
- State (string, required): The new state of the customer (e.g., \"Inactive\").
\n

Expected Response Format:

On a successful request, the response will include:

Customer (object): The updated customer details.
\n
- Id (integer): The unique identifier of the customer.
  \n
- Name (string): The name of the customer.
  \n
- Email (string): The email address of the customer.
  \n
- BirthDate (string): The birth date of the customer.
  \n
- State (integer): The current state of the customer.
  \n
- Document (object): The document details of the customer.
  \n
  - Type (integer): The type of document.
    \n
  - Number (string): The document number.
    \n
  \n
- Phones (array): A list of phone numbers associated with the customer.
  \n
  - Type (integer): The type of phone.
    \n
  - CountryCode (string): The country code for the phone number.
    \n
  - AreaCode (string): The area code for the phone number.
    \n
  - Number (string): The actual phone number.
    \n
  \n
\n
Errors (array): Any errors encountered during the request.
\n
Success (boolean): Indicates whether the request was successful.
\n
RequestDate (string): The date and time when the request was made.
\n

Response Status:

200 OK: Indicates that the customer status was successfully updated.

\n","urlObject":{"path":["TravellinkWebApi","api","v1","ota","customer","87"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"a5dd0294-9caa-4d46-af2d-989c5bf16ffa"}],"id":"7dd22384-e07f-442b-a22e-213f617dfa2c","_postman_id":"7dd22384-e07f-442b-a22e-213f617dfa2c","description":""},{"name":"Auth","item":[{"name":"GenerateToken - Anonymous","id":"f84387e7-7fd9-4f53-ad3e-19d62d52ef1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Developer-Token","value":"{{Developer-Token}}","type":"text"},{"key":"Developer-Access-Code","value":"{{Developer-Access-Code}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"StoreId\": 13,\r\n \"AccessCredentials\": {\r\n \"Company\": {\r\n \"Identifier\": \"\",\r\n \"Password\": \"\"\r\n }\r\n },\r\n \"Person\": {\r\n \"FirstName\": \"Homer\",\r\n \"SocialName\": \"\",\r\n \"MiddleName\": \"Jay\",\r\n \"Surname\": \"Simpson\",\r\n \"Gender\": \"Male\",\r\n \"BirthDate\": \"2000-01-05\",\r\n \"Email\": \"homer.simpson@wooba.com.br\"\r\n },\r\n \"Documents\": [\r\n {\r\n \"Type\": \"Cpf\",\r\n \"Number\": \"296.064.560-05\",\r\n \"Validity\": \"2030-06-30\",\r\n \"IssuingCountry\": \"BR\"\r\n }\r\n ],\r\n \"Phones\": [\r\n {\r\n \"Type\": \"General\",\r\n \"CountryCode\": \"+55\",\r\n \"AreaCode\": \"51\",\r\n \"Number\": \"999998888\"\r\n }\r\n ],\r\n \"Address\": {\r\n \"ZipCode\": \"99999-999\",\r\n \"Country\": \"Brasil\",\r\n \"State\": \"string\",\r\n \"City\": \"Sao Paulo\",\r\n \"Neighborhood\": \"Liberdade\",\r\n \"Address1\": \"Rua Japao\",\r\n \"Address2\": \"\",\r\n \"Number\": \"123\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/TravellinkWebApi/api/v1/ota/auth/generatetoken","description":"

POST Generate Token - Anonymous

This endpoint creates an order and generates an authentication token for system access.

Request URL

https://wooba-sandbox.travellink.com.br/TravellinkWebApi/api/v1/ota/auth/generatetoken

Request Parameters

The request body must be sent in JSON format and should include the following parameters:

StoreId (integer): The identifier for the store associated with the request.
\n
AccessCredentials (object): Contains the credentials required for authentication.
\n
- Company (object): An object that holds the company credentials.
  \n
  - Identifier (string): The unique identifier for the company.
    \n
  - Password (string): The password associated with the company identifier.
    \n
  \n
\n
Person (object): Contains the details of the person requesting the token.
\n
- FirstName (string): The first name of the person.
  \n
- SocialName (string): The social name of the person.
  \n
- MiddleName (string): The middle name of the person.
  \n
- Surname (string): The surname of the person.
  \n
- Gender (string): The gender of the person.
  \n
- BirthDate (string): The birth date of the person in ISO 8601 format.
  \n
- Email (string): The email address of the person.
  \n
\n
Documents (array of objects): A list of documents associated with the person.
\n
- Each document object can include:
  \n
  - Type (string): The type of document (e.g., CPF).
    \n
  - Number (string): The document number.
    \n
  - Validity (string): The validity date of the document in ISO 8601 format.
    \n
  - IssuingCountry (string): The country that issued the document.
    \n
  \n
\n
Phones (array of objects): A list of phone numbers associated with the person.
\n
- Each phone object can include:
  \n
  - Type (string): The type of phone number (e.g., General).
    \n
  - CountryCode (string): The country code for the phone number.
    \n
  - AreaCode (string): The area code for the phone number.
    \n
  - Number (string): The actual phone number.
    \n
  \n
\n
Address (object): Contains the address details of the person.
\n
- ZipCode (string): The postal code of the address.
  \n
- Country (string): The country of the address.
  \n
- State (string): The state of the address.
  \n
- City (string): The city of the address.
  \n
- Neighborhood (string): The neighborhood of the address.
  \n
- Address1 (string): The primary address line.
  \n
- Address2 (string): The secondary address line.
  \n
- Number (string): The house or apartment number.
  \n
\n

Response Structure

Upon a successful request, the response will contain the following fields:

Token (string): The generated authentication token.
\n
Errors (array): An array that contains any errors encountered during the request (empty if successful).
\n
Success (boolean): Indicates whether the request was successful.
\n
RequestDate (string): The date and time when the request was made.
\n

This endpoint is essential for obtaining a valid token necessary for further interactions with the system.

\n","urlObject":{"path":["TravellinkWebApi","api","v1","ota","auth","generatetoken"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"f84387e7-7fd9-4f53-ad3e-19d62d52ef1a"},{"name":"GenerateToken","id":"44cca8ee-9f85-486f-be43-92ab0e22da8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Developer-Token","value":"{{Developer-Token}}","type":"text"},{"key":"Developer-Access-Code","value":"{{Developer-Access-Code}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"StoreId\": 13,\r\n \"AccessCredentials\": {\r\n \"Company\": {\r\n \"Identifier\": \"\",\r\n \"Password\": \"\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/TravellinkWebApi/api/v1/ota/auth/generatetoken/108","description":"

POST Generate Token

This endpoint allows you to generate an authentication token for accessing the API.

Request Method

POST

Request URL

https://wooba-sandbox.travellink.com.br/TravellinkWebApi/api/v1/ota/auth/generatetoken/108

Request Parameters

The request body must be sent in JSON format and should include the following parameters:

StoreId (integer): The identifier for the store associated with the authentication request.
\n
AccessCredentials (object): Contains the credentials required for authentication.
\n
- Company (object): An object that holds the company credentials.
  \n
  - Identifier (string): The unique identifier for the company.
    \n
  - Password (string): The password associated with the company identifier.
    \n
  \n
\n

Response Structure

Upon a successful request, the response will contain the following fields:

Token (string): The generated authentication token.
\n
Errors (array): An array that contains any errors encountered during the request (empty if successful).
\n
Success (boolean): Indicates whether the request was successful.
\n
RequestDate (string): The date and time when the request was made.
\n

This endpoint is essential for obtaining a token that can be used for subsequent API requests, ensuring secure access to the services provided by the API.

\n","urlObject":{"path":["TravellinkWebApi","api","v1","ota","auth","generatetoken","108"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"44cca8ee-9f85-486f-be43-92ab0e22da8e"}],"id":"0cfcfb11-de1d-4f5f-bec5-12040cae2204","description":"

There are two ways of authentication. The first allows an order to be placed without the need to identify the user.

The second form of authentication identifies the customer accessing the system.

\n","_postman_id":"0cfcfb11-de1d-4f5f-bec5-12040cae2204"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"ce43f0ff-ad3a-444e-80cf-aadd4f3b3bc6"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"75c0fda4-7fb3-4d8f-bd14-b88ffcde9ee5"}}],"variable":[{"key":"baseEndPoint","value":"","type":"default"},{"key":"Login","value":"","type":"string"},{"key":"Password","value":"","type":"string"}]}