### ConvesioConvert API: Get Tags By Email

Source: https://developers.convert.convesio.com/index

This API retrieves all tags associated with a contact identified by their email address. It requires an API key for authentication and accepts the contact's email as a query parameter.

```APIDOC
GET /public/v1/contact/tags/email
ConvesioConvert API Server
https://api.convert.convesio.com/public/v1/contact/tags/email

Description: Return applied tags to the contact (site user) by user email.
Query Parameters:
- email (any, optional): The email of contact.
Header Parameters:
- apiKey (string, required): Your API credential.
Responses:
- 200: Successful operation
- 400: Invalid input
- 401: Invalid apiKey
- 500: Server error
```

--------------------------------

### List Products API

Source: https://developers.convert.convesio.com/index

Retrieves a paginated list of all products from the ConvesioConvert platform. Requires an API key for authentication and allows specifying the number of products per page via a query parameter.

```APIDOC
GET /public/v1/products

Parameters:
  count (query, integer, optional): Number of returned products in each page. Example: count=25
  apiKey (header, string, required): Your API credential.

Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error
```

--------------------------------

### List Product Tags API

Source: https://developers.convert.convesio.com/index

Retrieves a list of all product tags with pagination support. Requires an API key for authentication.

```APIDOC
GET /public/v1/products/tag
Host: api.convert.convesio.com

Headers:
  apiKey: string (required) - Your API credential

Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error
```

--------------------------------

### Site Information API

Source: https://developers.convert.convesio.com/index

Retrieve basic site information, list tags, and list custom attributes.

```APIDOC
APIDOC:
  Get Site Info:
    Description: Show basic information of site.
    Endpoint: GET /site
    Headers:
      apiKey (string, required): Your API credential.
    Responses:
      200: Successful operation
      401: Invalid apiKey
      500: Server error

  List Tags:
    Description: List of all defined tags for site in ConvesioConvert.
    Endpoint: GET /site/tags
    Headers:
      apiKey (string, required): Your API credential.
    Responses:
      200: Successful operation
      401: Invalid apiKey
      500: Server error

  List Custom Attributes:
    Description: List of all defined custom attributes for site in ConvesioConvert.
    Endpoint: GET /site/attributes
    Headers:
      apiKey (string, required): Your API credential.
    Responses:
      200: Successful operation
      401: Invalid apiKey
      500: Server error
```

--------------------------------

### List Product Categories API

Source: https://developers.convert.convesio.com/index

Retrieves a paginated list of all product categories from the ConvesioConvert platform. Requires an API key for authentication.

```APIDOC
GET /public/v1/products/category

Parameters:
  apiKey (header, string, required): Your API credential.

Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error
```

--------------------------------

### Add Product Tags API

Source: https://developers.convert.convesio.com/index

Adds product tags to the ConvesioConvert platform. Allows adding multiple tags, including nested JSON structures, via a JSON request body. Requires an API key for authentication.

```APIDOC
POST /public/v1/products/tag
Host: api.convert.convesio.com

Headers:
  apiKey: string (required) - Your API credential

Request Body (application/json):
  apiSecret: string (required)
  tag: Array of objects (required) - Contains tag details like id, name, and slug.

Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error

Request Sample:
{
  "apiSecret": "B5VsqSSdMOmls8pXUEMV",
  "tag": [
    {
      "id": "33",
      "name": "product tag 1",
      "slug": "producttag1"
    }
  ]
}
```

--------------------------------

### Add/Update Products API

Source: https://developers.convert.convesio.com/index

Adds or updates products in the ConvesioConvert platform. Multiple products can be added or updated by providing a JSON array of product objects in the request body. Requires an API key for authentication. The response message indicates the number of additions/failures.

```APIDOC
POST /public/v1/products

Parameters:
  apiKey (header, string, required): Your API credential.
  apiSecret (body, string, required):
  products (body, array of objects, required):
    id (object, string):
    name (object, string):
    sku (object, string):
    content (object, string):
    excerpt (object, string):
    url (object, string):
    images (object, array of strings):
    price (object, string):
    salePrice (object, string):
    publishedAt (object, string):
    categories (object, array of integers):
    tags (object, array of integers):

Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error

Request Sample:
Content-Type: application/json
{
  "apiSecret": "B5VsqSSdMOmls8pXUEMV",
  "products": [
    {
      "id": "112",
      "name": "SampleProduct",
      "sku": "342",
      "content": "sample text",
      "excerpt": "a text",
      "url": "/SampleProduct",
      "images": [
        "/SampleProduct.png"
      ],
      "price": "3000",
      "salePrice": "3500",
      "publishedAt": "2020-01-21 06:05:06",
      "categories": [
        3
      ],
      "tags": [
        3
      ]
    }
  ]
}
```

--------------------------------

### List Orders API

Source: https://developers.convert.convesio.com/index

Retrieves a list of all purchased orders with pagination support. Requires an API key for authentication and allows specifying the number of results per page.

```APIDOC
GET /public/v1/orders
Host: api.convert.convesio.com

Query Parameters:
  count: integer (optional) - Number of returned order_item in each page

Headers:
  apiKey: string (required) - Your API credential

Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error
```

--------------------------------

### Add Product Categories API

Source: https://developers.convert.convesio.com/index

Adds product categories to the ConvesioConvert platform. Supports adding multiple categories, including nested structures, via a JSON request body. Requires an API key for authentication.

```APIDOC
POST /public/v1/products/category
Host: api.convert.convesio.com

Headers:
  apiKey: string (required) - Your API credential

Request Body (application/json):
  apiSecret: string (required)
  category: Array of objects (required) - Contains category details like id, name, and slug.

Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error

Request Sample:
{
  "apiSecret": "B5VsqSSdMOmls8pXUEMV",
  "category": [
    {
      "id": "33",
      "name": "product cat 1",
      "slug": "productcat1"
    }
  ]
}
```

--------------------------------

### List Content Tags API

Source: https://developers.convert.convesio.com/index

Retrieves all post tags available in the ConvesioConvert platform. Requires an API key for authentication. The response contains a list of all tags.

```APIDOC
GET /public/v1/pages/tag

Parameters:
  apiKey (header, string, required): Your API credential.

Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error
```

--------------------------------

### Contents API Operations

Source: https://developers.convert.convesio.com/index

Provides endpoints for listing and managing content (pages, posts) on the ConvesioConvert platform. Supports retrieving all content with pagination and adding/updating content.

```APIDOC
APIDOC:
  /pages (GET)
    List Contents
    Retrieves all pages, posts of site with pagination.
    Parameters:
      count (integer, optional): Number of returned contacts in each page. Example: count=25
    Headers:
      apiKey (string, required): Your API credential. Example: 0vJrR15wO0RXjOYOkipO
    Responses:
      200: Successful operation
      401: Invalid apiKey
      500: Server error

  /pages (POST)
    Add/Update Contents
    Adds or updates pages, posts of site. Multiple page/post can be provided as nested json in pages. The message field in the response returns the number of additions / updates.
    Headers:
      apiKey (string, required): Your API credential. Example: 0vJrR15wO0RXjOYOkipO
    Request Body:
      Content-Type: application/json
      Schema:
        apiSecret (string, required)
        pages (array of objects, required):
          id (string)
          title (string)
          url (string)
          content (string)
          images (array of strings)
          publishedAt (string)
          categories (array of integers)
          tags (array of integers)
    Responses:
      200: Successful operation
      401: Invalid apiKey
      500: Server error
    Example Payload:
      {
        "apiSecret": "B5VsqSSdMOmls8pXUEMV",
        "pages": [
          {
            "id": "1122",
            "title": "New content",
            "url": "/new",
            "content": "your text",
            "images": [
              "img.jpg"
            ],
            "publishedAt": "2020-09-10",
            "categories": [
              3
            ],
            "tags": [
              3
            ]
          }
        ]
      }

  /pages/category (GET)
    List Content Categories
    Retrieves all post categories.
    Headers:
      apiKey (string, required): Your API credential. Example: 0vJrR15wO0RXjOYOkipO
    Responses:
      200: Successful operation
      401: Invalid apiKey
      500: Server error
```

--------------------------------

### Add Content Tags API

Source: https://developers.convert.convesio.com/index

Adds multiple content tags to the ConvesioConvert platform. Requires an API key for authentication and accepts tag data in a JSON array within the request body. The response indicates the number of successful additions and failures.

```APIDOC
POST /public/v1/pages/tag

Parameters:
  apiKey (header, string, required): Your API credential.
  apiSecret (body, string, required):
  tag (body, array of objects, required):
    id (object, string):
    name (object, string):
    slug (object, string):

Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error

Request Sample:
Content-Type: application/json
{
  "apiSecret": "B5VsqSSdMOmls8pXUEMV",
  "tag": [
    {
      "id": "3",
      "name": "pagetag1",
      "slug": "The page tag"
    }
  ]
}
```

--------------------------------

### Add Order Item API

Source: https://developers.convert.convesio.com/index

Adds order items to the ConvesioConvert platform. Supports adding multiple items within a single order, with details like userId, purchaseAt, orderId, productId, quantity, discountId, paymentMethod, orderTotal, and currency. Requires an API key and apiSecret for authentication.

```APIDOC
POST /public/v1/orders
Host: api.convert.convesio.com

Headers:
  apiKey: string (required) - Your API credential

Request Body (application/json):
  apiSecret: string (required)
  orderItems: Array of objects (required) - Contains details for each order item.
    - userId: string
    - purchaseAt: string (format: YYYY-MM-DD HH:MM:SS)
    - orderId: string
    - productId: string
    - quantity: string
    - discountId: string (optional)
    - paymentMethod: string
    - orderTotal: string
    - currency: string

Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error

Request Sample:
{
  "apiSecret": "B5VsqSSdMOmls8pXUEMV",
  "orderItems": [
    {
      "userId": "1",
      "purchaseAt": "2020-01-21 06:05:06",
      "orderId": "20",
      "productId": "2",
      "quantity": "3",
      "discountId": "50_PERCENT_OFF",
      "paymentMethod": "cod",
      "orderTotal": "3000",
      "currency": "IRR"
    }
  ]
}
```

--------------------------------

### ConvesioConvert API Endpoints

Source: https://developers.convert.convesio.com/index

This section details the various API endpoints available for interacting with the ConvesioConvert platform, including operations for contacts, custom attributes, and tags. Each endpoint specifies the HTTP method, URL, and expected parameters.

```APIDOC
GET /contact/id
URL: https://api.convert.convesio.com/public/v1/contact/id
Description: Retrieves contact information by ID.
Header Parameters:
  apiKey (string, required): Your API credential.
Responses:
  200: Successful operation
  400: Invalid input
  401: Invalid apiKey
  500: Server error
```

```APIDOC
POST /contact
URL: https://api.convert.convesio.com/public/v1/contact
Description: Adds or updates a contact. It is advised not to pass the userType property.
Header Parameters:
  apiKey (string, required): Your API credential.
Request Body (application/json):
  apiSecret (string, required)
  user (object, required): User information including email, userId, userName, firstName, lastName, birthdate, address, phoneNumber, country, region, city, device, browser, euConsent, marketingEmailConsent, registerAt.
Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error
```

```APIDOC
GET /contact/attribute/email
URL: https://api.convert.convesio.com/public/v1/contact/attribute/email
Description: Retrieves custom attributes for a user by their email address.
Query Parameters:
  email (any, required): The email of the contact.
Header Parameters:
  apiKey (string, required): Your API credential.
Responses:
  200: Successful operation
  400: Invalid input
  401: Invalid apiKey
  500: Server error
```

```APIDOC
POST /contact/attribute/email
URL: https://api.convert.convesio.com/public/v1/contact/attribute/email
Description: Adds custom attribute values to a contact by email. The message field indicates the number of added attributes or failures.
Header Parameters:
  apiKey (string, required): Your API credential.
Request Body (application/json):
  apiSecret (string, required)
  email (string, required): The email of the contact.
  data (Array of objects, required): An array of objects, where each object has 'name' and 'value' for the custom attribute.
Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error
```

```APIDOC
GET /contact/attribute/id
URL: https://api.convert.convesio.com/public/v1/contact/attribute/id
Description: Retrieves custom attributes for a user by their user ID.
Query Parameters:
  id (any, required): The user's ID.
Header Parameters:
  apiKey (string, required): Your API credential.
Responses:
  200: Successful operation
  400: Invalid input
  401: Invalid apiKey
  500: Server error
```

```APIDOC
GET /contact/tags/id
URL: https://api.convert.convesio.com/public/v1/contact/tags/id
Description: Retrieves tags applied to a contact (site user) by their ID.
Query Parameters:
  id (any, required): The user's ID.
Header Parameters:
  apiKey (string, required): Your API credential.
Responses:
  200: Successful operation
  400: Invalid input
  401: Invalid apiKey
  500: Server error
```

```APIDOC
POST /contact/tags/id
URL: https://api.convert.convesio.com/public/v1/contact/tags/id
Description: Applies multiple tags to a user by their user ID.
Header Parameters:
  apiKey (string, required): Your API credential.
Request Body (application/json):
  apiSecret (string, required)
  email (string, required): The email of the contact.
  data (Array of strings, required): An array of tag names to apply.
Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error
```

--------------------------------

### Add Content Categories API

Source: https://developers.convert.convesio.com/index

Adds multiple content categories to the ConvesioConvert platform. Requires an API key for authentication and accepts category data in a JSON array within the request body. The response indicates the number of successful additions and failures.

```APIDOC
POST /public/v1/pages/category

Parameters:
  apiKey (header, string, required): Your API credential.
  apiSecret (body, string, required):
  category (body, array of objects, required):
    id (object, string):
    name (object, string):
    slug (object, string):

Responses:
  200: Successful operation
  401: Invalid apiKey
  500: Server error

Request Sample:
Content-Type: application/json
{
  "apiSecret": "B5VsqSSdMOmls8pXUEMV",
  "category": [
    {
      "id": "3",
      "name": "pagecat1",
      "slug": "The page cat"
    }
  ]
}
```

--------------------------------

### Contacts API

Source: https://developers.convert.convesio.com/index

Manage contacts, including listing all contacts, adding/updating contacts, and retrieving contacts by email or ID.

```APIDOC
APIDOC:
  List Contacts:
    Description: List all contacts (site users) with pagination.
    Endpoint: GET /contacts
    Query Parameters:
      count (integer, optional): Number of returned contacts in each page.
    Headers:
      apiKey (string, required): Your API credential.
    Responses:
      200: Successful operation
      401: Invalid apiKey
      500: Server error

  Add/Update Contacts:
    Description: Add or update Contacts (site user). Multiple contacts can be added/updated as nested json in users. The message field in response returns the number of updated users / added users / fails. It is advised to not pass the userType property to let ConvesioConvert determine the user type based on the user's ecommerce orders. Passing 'customer' as the user type may have unintended consequences.
    Endpoint: POST /contacts
    Headers:
      apiKey (string, required): Your API credential.
    Request Body (application/json):
      apiSecret (string, required)
      users (array of objects, required): Pass users info in an array.
        Properties:
          email (string)
          userId (string)
          userType (string, optional)
          userName (string, optional)
          firstName (string, optional)
          lastName (string, optional)
          birthdate (string, optional)
          address (string, optional)
          phoneNumber (string, optional)
          country (string, optional)
          region (string, optional)
          city (string, optional)
          device (string, optional)
          browser (string, optional)
          euConsent (string, optional)
          marketingEmailConsent (string, optional)
          registerAt (string, optional)
    Responses:
      200: Successful operation
      401: Invalid apiKey
      500: Server error
    Request Sample:
      {
        "apiSecret": "B5VsqSSdMOmls8pXUEMV",
        "users": [
          {
            "email": "a@gmail.com",
            "userId": "123",
            "userType": "lead",
            "userName": "user11",
            "firstName": "John",
            "lastName": "Do",
            "birthdate": "2000-01-21",
            "address": "513 John Calvin Drive",
            "phoneNumber": "56124376",
            "country": "Germany",
            "region": "Hamburg",
            "city": "Hamburg",
            "device": "Mobile",
            "browser": "Chrome",
            "euConsent": "granted",
            "marketingEmailConsent": "denied",
            "registerAt": "2020-09-10"
          }
        ]
      }

  Get Contact By Email:
    Description: Return specific contact (site user) info by email.
    Endpoint: GET /contact/email
    Query Parameters:
      email (any, required): The email of contact.
    Headers:
      apiKey (string, required): Your API credential.
    Responses:
      200: Successful operation
      400: Invalid input
      401: Invalid apiKey
      500: Server error

  Get Contact By ID:
    Description: Return specific contact (site user) info by id.
    Endpoint: GET /contact/id
    Query Parameters:
      id (any, required): The user's id.
    Headers:
      apiKey (string, required): Your API credential.
    Responses:
      200: Successful operation
      401: Invalid apiKey
      500: Server error
```

--------------------------------

### ConvesioConvert API: Manage Contact Tags by Email

Source: https://developers.convert.convesio.com/index

This API facilitates the management of contact tags using a user's email address. It enables adding and removing tags for a specified email. Authentication is handled via an API key, and the request body requires an apiSecret.

```APIDOC
POST /public/v1/contact/tags/email
ConvesioConvert API Server
https://api.convert.convesio.com/public/v1/contact/tags/email

Description: Apply multiple tags to a user by user email.
Header Parameters:
- apiKey (string, required): Your API credential.
Request Body Schema (application/json):
- apiSecret (string, required)
- email (string, required): The user's email.
- tags (Array of strings, required): Tags to apply.
Responses:
- 200: Successful operation
- 400: Invalid input
- 401: Invalid apiKey
- 500: Server error

DELETE /public/v1/contact/tags/email
ConvesioConvert API Server
https://api.convert.convesio.com/public/v1/contact/tags/email

Description: Remove multiple tags of a user by email.
Header Parameters:
- apiKey (string, required): Your API credential.
Request Body Schema (application/json):
- apiSecret (string, required)
- email (string, required): The user's email.
- tags (Array of strings, required): Tags to remove.
Responses:
- 200: Successful operation
- 400: Invalid input
- 401: Invalid apiKey
- 500: Server error
```

--------------------------------

### ConvesioConvert API: Manage Contact Tags by User ID

Source: https://developers.convert.convesio.com/index

This API allows for the management of contact tags associated with a user ID. It supports adding and removing multiple tags for a given user. Requires an API key for authentication and an apiSecret in the request body.

```APIDOC
POST /public/v1/contact/tags/id
ConvesioConvert API Server
https://api.convert.convesio.com/public/v1/contact/tags/id

Description: Apply multiple tags to a user by user ID.
Header Parameters:
- apiKey (string, required): Your API credential.
Request Body Schema (application/json):
- apiSecret (string, required)
- id (integer, required): The user ID.
- tags (Array of strings, required): Tags to apply.
Responses:
- 200: Successful operation
- 400: Invalid input
- 401: Invalid apiKey
- 500: Server error

DELETE /public/v1/contact/tags/id
ConvesioConvert API Server
https://api.convert.convesio.com/public/v1/contact/tags/id

Description: Remove multiple tags of a user by user ID.
Header Parameters:
- apiKey (string, required): Your API credential.
Request Body Schema (application/json):
- apiSecret (string, required)
- id (integer, required): The user ID.
- tags (Array of strings, required): Tags to remove.
Responses:
- 200: Successful operation
- 400: Invalid input
- 401: Invalid apiKey
- 500: Server error
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.