### Get All Partners Success Response

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Represents a successful response when retrieving a list of partners. Includes an array of Partner objects and metadata.

```json
{
  "data": [
    {
      "id": 1,
      "alias": "companyname",
      "createdAt": "2025-08-25T18:19:57.946Z",
      "updatedAt": "2025-08-25T18:19:57.946Z",
      "name": "Company name ...",
      "tradeName": "Trade name...",
      "cnpj": "00000000000000",
      "stateSubscription": "SP",
      "observation": "observation...",
      "postalCode": "000000000",
      "streetName": "Street name...",
      "addressNumber": 123,
      "city": "City name",
      "state": "PR",
      "neighborhood": "Neighborhood name",
      "email": "company@email.com",
      "phone": "1100000000",
      "cellphone": "11000000000",
      "nfEmail": "invoice@email.com.br",
      "active": true,
      "commission1": 35000,
      "commission2": 32500,
      "commission3": 30000,
      "commission4": 28500
    }
  ],
  "meta": {}
}
```

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

### Get All Stores API

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

This endpoint retrieves a paginated list of all stores for a given company. It requires authentication and company-level authorization. The response includes store details and pagination controls.

```JSON
{
  "get": {
    "description": "Retrieves a comprehensive paginated list of all stores belonging to a specific company. This endpoint provides administrators with an overview of all store locations including essential information such as store names, operational status, creation dates, and other relevant metadata. The response includes pagination controls with configurable page size and navigation, making it efficient to browse through large numbers of stores. Requires proper authentication and company-level authorization to ensure data security and access control.",
    "operationId": "StoresController_getAllStores",
    "parameters": [
      {
        "name": "companyId",
        "required": true,
        "in": "path",
        "schema": {
          "example": 1,
          "type": "number"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Sucess",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllStoresSucessResponseDto"
            }
          }
        }
      },
      "400": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllStoresBadRequestResponseDto"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllStoresUnauthorizedResponseDto"
            }
          }
        }
      },
      "403": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllStoresForbiddenResponseDto"
            }
          }
        }
      },
      "404": {
        "description": "Not Found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllStoresNotFoundResponseDto"
            }
          }
        }
      },
      "500": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllStoresInternalServerErrorResponseDto"
            }
          }
        }
      }
    },
    "security": [
      {
        "accessToken": []
      }
    ],
    "summary": "Get all stores",
    "tags": [
      "Stores"
    ]
  }
}
```

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

### Get One Partner Not Found Response

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Response structure for when a requested partner is not found. Indicates that no partner matches the provided identifier.

```json
{
  "message": {
    "type": "string",
    "example": "Partner not found"
  },
  "error": {
    "type": "string",
    "example": "Not found"
  },
  "statusCode": {
    "type": "number",
    "example": 404
  }
}
```

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

### Get Company by ID

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Retrieves details for a specific company using its unique identifier.

```json
{
  "get": {
    "description": "Get a company",
    "operationId": "CompaniesController_getOne",
    "paramet"
  }
}
```

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

### Get Store Information

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Retrieves details for a specific store. This endpoint requires authentication and returns store information or appropriate error responses for not found or server errors.

```json
{
  "get": {
    "summary": "Get one store",
    "tags": [
      "Stores"
    ],
    "responses": {
      "200": {
        "description": "Success",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOneStoreSuccessResponseDto"
            }
          }
        }
      },
      "404": {
        "description": "Not Found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOneStoreNotFoundResponseDto"
            }
          }
        }
      },
      "500": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOneStoreInternalServerErrorResponseDto"
            }
          }
        }
      }
    },
    "security": [
      {
        "accessToken": []
      }
    ]
  }
}
```

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

### Get All Partners

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Retrieves a paginated list of all partners, supporting filtering by CNPJ, name, active status, and sorting options. Returns partner details including company information, contact data, and commission rates. Supports various query parameters for customization.

```json
{
  "get": {
    "description": "Retrieves a paginated list of all partners in the system. Supports filtering by various criteria such as CNPJ, name, active status, and sorting options. Returns partner information including company details, contact data, and commission rates.",
    "operationId": "PartnersController_getAllPartners",
    "parameters": [
      {
        "name": "sortBy",
        "required": false,
        "in": "query",
        "schema": {
          "example": "createdAt",
          "type": "string",
          "enum": [
            "id",
            "createdAt",
            "updatedAt",
            "alias",
            "name",
            "tradeName",
            "delinquent",
            "active",
            "cnpj"
          ]
        }
      },
      {
        "name": "page",
        "required": false,
        "in": "query",
        "schema": {
          "example": 1,
          "type": "number"
        }
      },
      {
        "name": "limit",
        "required": false,
        "in": "query",
        "schema": {
          "example": 10,
          "type": "number"
        }
      },
      {
        "name": "orderBy",
        "required": false,
        "in": "query",
        "schema": {
          "example": "asc",
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ]
        }
      },
      {
        "name": "id",
        "required": false,
        "in": "query",
        "schema": {
          "example": 1,
          "type": "number"
        }
      },
      {
        "name": "createdAt",
        "required": false,
        "in": "query",
        "schema": {
          "example": "between(2025-01-01.2025-01-31)",
          "type": "string"
        }
      },
      {
        "name": "updatedAt",
        "required": false,
        "in": "query",
        "schema": {
          "example": "between(2025-01-01.2025-01-31)",
          "type": "string"
        }
      },
      {
        "name": "alias",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(companyname)",
          "type": "string"
        }
      },
      {
        "name": "name",
        "required": false,
        "in": "query",
        "schema": {
          "example": "ne(Company Name)",
          "type": "string"
        }
      },
      {
        "name": "tradeName",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(Trade Name)",
          "type": "string"
        }
      }
    ],
    "security": [
      {
        "accessToken": []
      }
    ],
    "summary": "Get all partners",
    "tags": [
      "Partners"
    ]
  }
}
```

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

### Get Company Users Success Response

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Represents a successful response when retrieving a list of company users. It includes the user data and pagination metadata. This is the standard success format for user listing.

```json
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CompanyUserDataDto"
      }
    },
    "meta": {
      "$ref": "#/components/schemas/CompanyUserMetaDto"
    }
  },
  "required": [
    "data",
    "meta"
  ]
}
```

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

### Get One Partner

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Retrieves detailed information for a specific partner using their unique partner ID. The response includes comprehensive data such as company details, contact information, address, and commission configuration. This operation requires authentication.

```json
{
  "get": {
    "tags": [
      "Partners"
    ],
    "summary": "Get one partner",
    "operationId": "PartnersController_getOnePartner",
    "parameters": [
      {
        "name": "partnerId",
        "required": true,
        "in": "path",
        "schema": {
          "example": 1,
          "type": "number"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Success",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOnePartnerSuccessResponseDto"
            }
          }
        }
      },
      "400": {
        "description": "Bad request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOnePartnerBadRequestResponseDto"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOnePartnerUnauthorizedResponseDto"
            }
          }
        }
      },
      "403": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOnePartnerForbiddenResponseDto"
            }
          }
        }
      },
      "404": {
        "description": "Not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOnePartnerNotFoundResponseDto"
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOnePartnerInternalServerErrorResponseDto"
            }
          }
        }
      }
    },
    "security": [
      {
        "accessToken": []
      }
    ]
  }
}
```

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

### Get All Companies

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Retrieves a list of all companies. Supports filtering by creation date, alias, name, trade name, delinquency status, active status, and CNPJ. Allows sorting by various company attributes.

```json
{
  "get": {
    "description": "Get all companies",
    "operationId": "CompaniesController_getAll",
    "parameters": [
      {
        "name": "createdAt",
        "required": false,
        "in": "query",
        "schema": {
          "example": "between(2025-01-01.2025-01-31)",
          "type": "string"
        }
      },
      {
        "name": "sortBy",
        "required": false,
        "in": "query",
        "schema": {
          "example": "createdAt",
          "type": "string",
          "enum": [
            "id",
            "createdAt",
            "updatedAt",
            "alias",
            "name",
            "tradeName",
            "delinquent",
            "active",
            "cnpj"
          ]
        }
      },
      {
        "name": "alias",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(companyname)",
          "type": "string"
        }
      },
      {
        "name": "name",
        "required": false,
        "in": "query",
        "schema": {
          "example": "ne(Company Name)",
          "type": "string"
        }
      },
      {
        "name": "tradeName",
        "required": false,
        "in": "query",
        "schema": {
          "example": "cont(Company Name)",
          "type": "string"
        }
      },
      {
        "name": "delinquent",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(true)",
          "type": "string"
        }
      },
      {
        "name": "active",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(true)",
          "type": "string"
        }
      },
      {
        "name": "cnpj",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(00000000000000)",
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Success",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllSuccessResponseDto"
            }
          }
        }
      },
      "400": {
        "description": "Bad request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllBadRequestResponseDto"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllUnauthorizedResponseDto"
            }
          }
        }
      },
      "403": {
        "description": "Forbiden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllForbidenResponseDto"
            }
          }
        }
      },
      "500": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllInternalServerErrorResponseDto"
            }
          }
        }
      }
    },
    "security": [
      {
        "accessToken": []
      }
    ],
    "summary": "Get all companies",
    "tags": [
      "Companies"
    ]
  }
}
```

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

### Get One Store API

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

This endpoint retrieves detailed information for a specific store, identified by both company ID and store ID. It requires authentication and authorization. The response provides comprehensive store data.

```JSON
{
  "/admin/companies/{companyId}/stores/{storeId}": {
    "get": {
      "description": "Retrieves detailed information of a specific store within a company. This endpoint allows administrators to access comprehensive store data including store identification, name, operational status, creation and modification timestamps, and other relevant store-specific information. The store is identified by both company ID and store ID parameters to ensure proper data isolation and security. Requires proper authentication and authorization to access store information.",
      "operationId": "StoresController_getOneStore",
      "parameters": [
        {
          "name": "companyId",
          "required": true,
          "in": "path",
          "schema": {
            "example": 1,
            "type": "number"
          }
        },
        {
          "name": "storeId",
          "required": true,
          "in": "path",
          "schema": {
            "example": 1,
            "type": "number"
          }
        }
      ],
      "responses": {
        "200": {
          "description": "Sucess",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetOneStoreSucessResponseDto"
              }
            }
          }
        },
        "400": {
          "description": "Bad Request",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetOneStoreBadRequestResponseDto"
              }
            }
          }
        },
        "401": {
          "description": "Unauthorized",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetOneStoreUnauthorizedResponseDto"
              }
            }
          }
        },
        "403": {
          "description": "Forbidden",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetOneStoreForbiddenResponseDto"
              }
            }
          }
        },
        "404": {
          "description": "Not Found",
          "content": {
            "appl
```

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

### Get One Partner Success Response

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Represents a successful response when retrieving a single partner by ID. Includes the full Partner object.

```json
{
  "id": 1,
  "alias": "companyname",
  "createdAt": "2025-08-25T18:19:57.946Z",
  "updatedAt": "2025-08-25T18:19:57.946Z",
  "name": "Company name ...",
  "tradeName": "Trade name...",
  "cnpj": "00000000000000",
  "stateSubscription": "SP",
  "observation": "observation...",
  "postalCode": "000000000",
  "streetName": "Street name...",
  "addressNumber": 123,
  "city": "City name",
  "state": "PR",
  "neighborhood": "Neighborhood name",
  "email": "company@email.com",
  "phone": "1100000000",
  "cellphone": "11000000000",
  "nfEmail": "invoice@email.com.br",
  "active": true,
  "commission1": 35000,
  "commission2": 32500,
  "commission3": 30000,
  "commission4": 28500
}
```

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

### Get All Company Users

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Retrieves a paginated list of all users for a specific company. Supports filtering by various user attributes and returns user data along with pagination details.

```json
{
  "get": {
    "description": "Endpoint to retrieve a paginated list of all users associated with a specific company. Returns user information including ID, name, email, active status, and creation/update timestamps, along with pagination metadata such as current page, limit, total count, and total pages.",
    "operationId": "CompanyUsersController_getAll",
    "parameters": [
      {
        "name": "companyId",
        "required": true,
        "in": "path",
        "schema": {
          "example": 1,
          "type": "number"
        }
      },
      {
        "name": "id",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(1)",
          "type": "string"
        }
      },
      {
        "name": "createdAt",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(2025-09-04)",
          "type": "string"
        }
      },
      {
        "name": "updatedAt",
        "required": false,
        "in": "query",
        "schema": {
          "example": "gte(2025-09-04)",
          "type": "string"
        }
      },
      {
        "name": "name",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(name)",
          "type": "string"
        }
      },
      {
        "name": "email",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(email)",
          "type": "string"
        }
      },
      {
        "name": "active",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(true)",
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Success",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetCompanyUsersSuccessResponseDto"
            }
          }
        }
      },
      "400": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetCompanyUsersBadRequestResponseDto"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetCompanyUsersUnauthorizedResponseDto"
            }
          }
        }
      },
      "403": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetCompanyUsersForbiddenResponseDto"
            }
          }
        }
      },
      "404": {
        "description": "Not Found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetCompanyUsersNotFoundResponseDto"
            }
          }
        }
      },
      "500": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetCompanyUsersInternalServerErrorResponseDto"
            }
          }
        }
      }
    },
    "security": [
      {
        "accessToken": []
      }
    ],
    "summary": "Get all company users",
    "tags": [
      "Company Users"
    ]
  }
}
```

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

### Get Company Users Not Found Response

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Structure for a 'Not Found' response, indicating that the requested company resource could not be located. Includes a specific message and the corresponding HTTP status code.

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Company not found"
    },
    "error": {
      "type": "string",
      "example": "Not Found"
    },
    "statusCode": {
      "type": "number",
      "example": 404
    }
  },
  "required": [
    "message",
    "error",
    "statusCode"
  ]
}
```

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

### Get All Partners

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Retrieves a list of all partners with support for filtering by company name, CNPJ, subscription status, observation, postal code, street name, address number, city, neighborhood, state, and active status. This endpoint is secured with an access token.

```json
{
  "get": {
    "tags": [
      "Partners"
    ],
    "summary": "Get all partners",
    "operationId": "PartnersController_getAllPartners",
    "parameters": [
      {
        "name": "companyName",
        "required": false,
        "in": "query",
        "schema": {
          "example": "cont(Company Name)",
          "type": "string"
        }
      },
      {
        "name": "cnpj",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(00000000000000)",
          "type": "string"
        }
      },
      {
        "name": "statusSubscription",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(123456)",
          "type": "string"
        }
      },
      {
        "name": "observation",
        "required": false,
        "in": "query",
        "schema": {
          "example": "cont(observation)",
          "type": "string"
        }
      },
      {
        "name": "postalCode",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(000000000)",
          "type": "string"
        }
      },
      {
        "name": "streetName",
        "required": false,
        "in": "query",
        "schema": {
          "example": "cont(streetName)",
          "type": "string"
        }
      },
      {
        "name": "addressNumber",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(123)",
          "type": "string"
        }
      },
      {
        "name": "city",
        "required": false,
        "in": "query",
        "schema": {
          "example": "cont(city)",
          "type": "string"
        }
      },
      {
        "name": "neighborhood",
        "required": false,
        "in": "query",
        "schema": {
          "example": "cont(neighborhood)",
          "type": "string"
        }
      },
      {
        "name": "state",
        "required": false,
        "in": "query",
        "schema": {
          "example": "cont(state)",
          "type": "string"
        }
      },
      {
        "name": "active",
        "required": false,
        "in": "query",
        "schema": {
          "example": "eq(true)",
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Success",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllPartnersSuccessResponseDto"
            }
          }
        }
      },
      "400": {
        "description": "Bad request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllPartnersBadRequestResponseDto"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllPartnersUnauthorizedResponseDto"
            }
          }
        }
      },
      "403": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllPartnersForbiddenResponseDto"
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAllPartnersInternalServerErrorResponseDto"
            }
          }
        }
      }
    },
    "security": [
      {
        "accessToken": []
      }
    ]
  }
}
```

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

### Get One Company User

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Retrieves detailed information for a specific company user using their company ID and user ID. Returns comprehensive user data including personal details, role, and status. Supports various HTTP status codes for different response scenarios.

```json
{
  "get": {
    "description": "Endpoint to retrieve detailed information about a specific company user by their unique identifier. Returns comprehensive user data including personal information, role, status, and associated company details. This endpoint is used for viewing individual user profiles and managing user-specific operations within the company context.",
    "operationId": "CompanyUsersController_getOne",
    "parameters": [
      {
        "name": "companyId",
        "required": true,
        "in": "path",
        "schema": {
          "example": 1,
          "type": "number"
        }
      },
      {
        "name": "userId",
        "required": true,
        "in": "path",
        "schema": {
          "example": 1,
          "type": "number"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Success",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOneCompanyUserSuccessResponseDto"
            }
          }
        }
      },
      "400": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOneCompanyUserBadRequestResponseDto"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOneCompanyUserUnauthorizedResponseDto"
            }
          }
        }
      },
      "403": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOneCompanyUserForbiddenResponseDto"
            }
          }
        }
      },
      "404": {
        "description": "Not Found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOneCompanyUserNotFoundResponseDto"
            }
          }
        }
      },
      "500": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetOneCompanyUserInternalServerErrorResponseDto"
            }
          }
        }
      }
    },
    "security": [
      {
        "accessToken": []
      }
    ],
    "summary": "Get one company user",
    "tags": [
      "Company Users"
    ]
  }
}
```

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

### Get One Partner Forbidden Response

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Response structure indicating a forbidden request when trying to get a single partner. This means the authenticated user does not have the necessary permissions.

```json
{
  "message": {
    "type": "string",
    "example": "Not allowed"
  },
  "error": {
    "type": "string",
    "example": "Forbidden"
  },
  "statusCode": {
    "type": "number",
    "example": 403
  }
}
```

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

### User Sign-Up

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Facilitates the registration of new administrator users. Requires name, email, and password. Provides a success message upon registration or error responses for invalid input or server issues.

```JSON
{
  "name": "Fulano de tal",
  "email": "fulano@email.com",
  "password": "********"
}
```

```JSON
{
  "message": "User registered successfully",
  "statusCode": 201
}
```

```JSON
{
  "message": [
    "Invalid email",
    "Invalid password"
  ],
  "error": "Bad Request",
  "statusCode": 400
}
```

```JSON
{
  "message": "Internal server error",
  "error": "Internal server error",
  "statusCode": 500
}
```

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

### Get One Partner Unauthorized Response

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Response structure for an unauthorized request when trying to get a single partner. This occurs due to invalid, revoked, or expired tokens.

```json
{
  "message": {
    "type": "string",
    "example": "Unauthorized | Invalid token | Revoked token | Expired token"
  },
  "error": {
    "type": "string",
    "example": "Unauthorized"
  },
  "statusCode": {
    "type": "number",
    "example": 401
  }
}
```

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

### Administrator Registration API

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Facilitates the secure creation of new system administrator accounts within the Directa Shop platform. It validates credentials, enforces strong password policies, assigns roles, and initiates the email verification process. Includes data validation, duplicate email checks, secure password hashing, and verification token generation.

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/admin/users": {
      "post": {
        "description": "Secure registration endpoint for creating new system administrator accounts in the Directa Shop platform. This endpoint validates administrator credentials, enforces strong password policies, creates user records with proper role assignments, and initiates the email verification process. The registration includes comprehensive data validation, duplicate email checking, secure password hashing, and automatic generation of verification tokens for account activation.",
        "operationId": "UsersController_createUser",
        "parameters": [],
        "requestBody": {
          "required": true,
          "description": "Request body credentials ( Required )",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SignUpBodyDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Sign up successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignUpSuccessResponse"
                }
              }
            }
          },
          "400": {
            "description": "Sign In Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignUpBadRequestResponse"
                }
              }
            }
          },
          "500": {
            "description": "Sign In Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignUpInternalServerErrorResponse"
                }
              }
            }
          }
        },
        "summary": "Administrator Registration",
        "tags": [
          "Users"
        ]
      }
    }
  }
}
```

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

### Create Partner

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Creates a new partner in the system, requiring all necessary details including company information, contact data, address, and commission rates. The request body must contain all required fields. Handles various error responses.

```json
{
  "post": {
    "description": "Creates a new partner in the system with all required information including company details, contact information, address data, and commission rates. All fields in the request body are required for partner creation.",
    "operationId": "PartnersController_createPartner",
    "parameters": [],
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/CreatePartnerBodyDto"
          }
        }
      }
    },
    "responses": {
      "201": {
        "description": "Success",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CreatePartnerSuccessResponseDto"
            }
          }
        }
      },
      "400": {
        "description": "Bad request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CreatePartnerBadRequestResponseDto"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CreatePartnerUnauthorizedResponseDto"
            }
          }
        }
      },
      "403": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CreatePartnerForbiddenResponseDto"
            }
          }
        }
      },
      "404": {
        "description": "Not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CreatePartnerNotFoundResponseDto"
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CreatePartnerInternalServerErrorResponseDto"
            }
          }
        }
      }
    },
    "security": [
      {
        "accessToken": []
      }
    ],
    "summary": "Create a new partner",
    "tags": [
      "Partners"
    ]
  }
}
```

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

### Get One Partner Internal Server Error Response

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Response structure for an internal server error when trying to get a single partner. This could be due to server-side issues or payload errors.

```json
{
  "message": {
    "type": "string",
    "example": "Internal server error | Payload error"
  },
  "error": {
    "type": "string",
    "example": "Internal server error"
  },
  "statusCode": {
    "type": "number",
    "example": 500
  }
}
```

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

### User Sign-In

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Handles the authentication of administrator users. Requires email and password. Returns an access token upon successful sign-in, or appropriate error responses for bad requests, unauthorized access, or internal server errors.

```JSON
{
  "email": "fulano@email.com",
  "password": "********"
}
```

```JSON
{
  "acessToken": "xyz...",
  "payload": {
    "user": {
      "type": "admin_user",
      "name": "You name",
      "email": "you@email.com",
      "emailVerified": false
    }
  }
}
```

```JSON
{
  "message": [
    "Invalid email",
    "Invalid password"
  ],
  "error": "Bad Request",
  "statusCode": 400
}
```

```JSON
{
  "message": "Invalid credentials",
  "error": "Unauthorized",
  "statusCode": 401
}
```

```JSON
{
  "message": "Internal server error",
  "error": "Internal server error",
  "statusCode": 500
}
```

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

### Get One Partner Bad Request Response

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Response structure for a bad request when trying to get a single partner. Indicates issues with the provided partner ID or email verification status.

```json
{
  "message": {
    "type": "string",
    "example": "Please enter a valid partner id | Email not verified"
  },
  "error": {
    "type": "string",
    "example": "Bad request"
  },
  "statusCode": {
    "type": "number",
    "example": 400
  }
}
```

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

### Administrator Sign In API

Source: https://api.directashop.com.br/api-docs/admin/swagger-json

Handles secure authentication for Directa Shop administrators. It validates credentials, performs email verification, generates JWT tokens with Redis session management, and establishes role-based access control for administrative sessions. Includes comprehensive security validations and audit logging.

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/admin/users/sign-in": {
      "post": {
        "description": "Secure authentication endpoint exclusively for system administrators to access the Directa Shop administrative platform. This endpoint validates administrator credentials, performs email verification checks, generates JWT tokens with Redis-based session management, and establishes secure administrative sessions with role-based access control. The authentication process includes comprehensive security validations, audit logging, and ensures only verified administrative users can access sensitive platform management functions.",
        "operationId": "UsersController_login",
        "parameters": [],
        "requestBody": {
          "required": true,
          "description": "Request body credentials ( Required )",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SignInBodyDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Sign in successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignInSuccessResponse"
                }
              }
            }
          },
          "400": {
            "description": "Sign In Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignInBadRequestResponse"
                }
              }
            }
          },
          "401": {
            "description": "Sign in unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignInUnauthorizedResponse"
                }
              }
            }
          },
          "500": {
            "description": "Sign In Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignInInternalServerErrorResponse"
                }
              }
            }
          }
        },
        "summary": "Administrator Sign In",
        "tags": [
          "Users"
        ]
      }
    }
  }
}
```