Vonexio API

https://vonex.io/swagger/
Admin
Documentation for API customers that describes various API endpoints for managing orders, products,...
Tokens:9,945
Snippets:51
Trust Score:2.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get All Webhooks

Source: https://vonex.io/swagger/customer/swagger.json

Retrieves a list of all configured webhooks.

```APIDOC
## GET /api/WebHooks

### Description
Retrieves a list of all configured webhooks.

### Method
GET

### Endpoint
/api/WebHooks

### Response
#### Success Response (200)
- **WebHook** (array) - A list of webhook objects.
```

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

### Get All Products

Source: https://vonex.io/swagger/customer/swagger.json

Retrieves a list of all available products.

```APIDOC
## GET /api/Products

### Description
Retrieves a list of all available products.

### Method
GET

### Endpoint
/api/Products

### Response
#### Success Response (200)
- An array of ProductDTO objects.

#### Response Example
{
  "example": "[\n  {\n    \"id\": 1,\n    \"name\": \"Example Product\",\n    \"description\": \"This is an example product.\",\n    \"price\": 19.99\n  }\n]"
}
```

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

### Get All Stock Items

Source: https://vonex.io/swagger/customer/swagger.json

Retrieves a list of all stock items.

```APIDOC
## GET /api/Stock/allstocks

### Description
Retrieves a list of all stock items.

### Method
GET

### Endpoint
/api/Stock/allstocks

### Response
#### Success Response (200)
- items (StockDTO[]) - A list of stock items.
```

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

### Get All Shipping Methods

Source: https://vonex.io/swagger/customer/swagger.json

Retrieves a list of all available shipping methods.

```APIDOC
## GET /api/ShippingMethods

### Description
Retrieves a list of all available shipping methods.

### Method
GET

### Endpoint
/api/ShippingMethods

### Response
#### Success Response (200)
- items (ShippingMethod[]) - A list of shipping methods.
```

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

### Get Product by ID

Source: https://vonex.io/swagger/customer/swagger.json

Retrieves a specific product's details using its unique identifier.

```APIDOC
## GET /api/Products/{id}

### Description
Retrieves a specific product's details using its unique identifier.

### Method
GET

### Endpoint
/api/Products/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the product.

### Response
#### Success Response (200)
- **ProductDTO** - The details of the requested product.
```

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

### Get Webhook by ID

Source: https://vonex.io/swagger/customer/swagger.json

Retrieves a specific webhook by its ID.

```APIDOC
## GET /api/WebHooks/{id}

### Description
Retrieves a specific webhook by its ID.

### Method
GET

### Endpoint
/api/WebHooks/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the webhook.
```

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

### Get My User Data

Source: https://vonex.io/swagger/customer/swagger.json

Retrieves the current authenticated user's data.

```APIDOC
## GET /api/Users/MyData

### Description
Retrieves the current authenticated user's data.

### Method
GET

### Endpoint
/api/Users/MyData

### Response
#### Success Response (200)
- **FullUserDTO** (object) - The user's full data object.
```

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

### Get Order by ID

Source: https://vonex.io/swagger/customer/swagger.json

Retrieves a specific order by its unique identifier.

```APIDOC
## GET /api/Orders/{id}

### Description
Retrieves a specific order by its unique identifier.

### Method
GET

### Endpoint
/api/Orders/{id}

#### Path Parameters
- **id** (integer) - Required - The unique identifier of the order.
```

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

### Get Raw Data by Feature Name

Source: https://vonex.io/swagger/customer/swagger.json

Retrieves raw data records based on a specified feature name.

```APIDOC
## POST /api/RawData/feature/{featureName}

### Description
Retrieves raw data records associated with a specific feature.

### Method
POST

### Endpoint
/api/RawData/feature/{featureName}

### Parameters
#### Path Parameters
- **featureName** (string) - Required - The name of the feature to filter by.
```

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

### Get Shipping Method by ID

Source: https://vonex.io/swagger/customer/swagger.json

Retrieves a specific shipping method by its unique identifier.

```APIDOC
## GET /api/ShippingMethods/{id}

### Description
Retrieves a specific shipping method by its unique identifier.

### Method
GET

### Endpoint
/api/ShippingMethods/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the shipping method.
```

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

### Get Raw Data by ID

Source: https://vonex.io/swagger/customer/swagger.json

Retrieves a specific raw data record by its unique identifier.

```APIDOC
## GET /api/RawData/{id}

### Description
Retrieves a single raw data record using its ID.

### Method
GET

### Endpoint
/api/RawData/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the raw data record.
```

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

### Create Products

Source: https://vonex.io/swagger/customer/swagger.json

Creates new products for users. Accepts an array of ProductRequestForUserDTO.

```APIDOC
## POST /api/Products

### Description
Creates new products for users. Accepts an array of ProductRequestForUserDTO.

### Method
POST

### Endpoint
/api/Products

### Request Body
- An array of ProductRequestForUserDTO objects.

### Request Example
{
  "example": "[\n  {\n    \"name\": \"New Product\",\n    \"description\": \"A newly added product.\",\n    \"price\": 25.50\n  }\n]"
}

### Response
#### Success Response (200)
- An array of created ProductDTO objects.

#### Response Example
{
  "example": "[\n  {\n    \"id\": 2,\n    \"name\": \"New Product\",\n    \"description\": \"A newly added product.\",\n    \"price\": 25.50\n  }\n]"
}
```

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

### Create Webhook

Source: https://vonex.io/swagger/customer/swagger.json

Creates a new webhook subscription.

```APIDOC
## POST /api/WebHooks

### Description
Creates a new webhook subscription.

### Method
POST

### Endpoint
/api/WebHooks

### Request Body
- **CreateWebHookRequest** (object) - The request body containing details for the new webhook.

### Response
#### Success Response (200)
- **WebHook** (object) - The newly created webhook object.
```

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

### Create Webhook

Source: https://vonex.io/swagger/customer/swagger.json

Allows the creation of a new webhook subscription for specific event types. Requires the event type and the URL to send notifications to.

```APIDOC
## POST /webhooks

### Description
Creates a new webhook subscription.

### Method
POST

### Endpoint
/webhooks

### Request Body
- **eventType** (string) - Optional - The type of event to subscribe to.
- **endpointUrl** (string) - Optional - The URL where notifications will be sent.
- **token** (string) - Optional - A token for authentication of the webhook endpoint.
```

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

### Create Order

Source: https://vonex.io/swagger/customer/swagger.json

Creates a new order for a user. Requires order details in the request body.

```APIDOC
## POST /api/Orders

### Description
Creates a new order for a user. Requires order details in the request body.

### Method
POST

### Endpoint
/api/Orders

#### Request Body
- **OrderRequestForUserDTO** - Required - The details of the order to be created.
```

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

### ProductDTO

Source: https://vonex.io/swagger/customer/swagger.json

Represents a product with detailed information, including its EAN, name, SKU, pricing, dimensions, and associated user data.

```APIDOC
## ProductDTO

### Description
Represents a product with detailed information, including its EAN, name, SKU, pricing, dimensions, and associated user data.

### Properties
- **id** (integer) - The unique identifier for the product.
- **userId** (integer) - The identifier of the user who owns the product.
- **sku** (string) - Required. The Stock Keeping Unit for the product.
- **sku2** (string, nullable) - An alternative SKU for the product.
- **ean** (string) - Required. The European Article Number for the product.
- **name** (string) - Required. The name of the product.
- **description** (string, nullable) - A detailed description of the product.
- **type** (ProductType) - The type of the product.
- **nameEnglish** (string, nullable) - The English name of the product.
- **descriptionEnglish** (string, nullable) - The English description of the product.
- **price** (float) - The price of the product.
- **set** (boolean) - Indicates if the product is a set.
- **quantityIc** (integer) - Inventory count for the product.
- **quantityOc** (integer) - Order count for the product.
- **weight** (float) - The weight of the product.
- **width** (float) - The width of the product.
- **height** (float) - The height of the product.
- **length** (float) - The length of the product.
- **packUnit** (string, nullable) - The packaging unit for the product.
- **active** (boolean) - Indicates if the product is active.
- **createdAt** (string, date-time) - The timestamp when the product was created.
- **updatedAt** (string, date-time) - The timestamp when the product was last updated.
- **setItems** (array, nullable) - A list of items included in the product set.
- **user** (UserDTO) - The user associated with the product.
- **test** (boolean) - Indicates if this is a test product.
- **hsCode** (string, nullable) - The Harmonized System code for the product.
- **countryOfOrigin** (string, nullable) - The country of origin for the product.
```

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

### Products Management

Source: https://vonex.io/swagger/index.html?urls.primaryName=My%20API%20-%20admin

Endpoints for managing products, including retrieval, update, creation, and filtering.

```APIDOC
## GET /api/Products/{id}

### Description
Retrieves a specific product by its ID.

### Method
GET

### Endpoint
/api/Products/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the product to retrieve.

### Response
#### Success Response (200)
- **ProductDTO** (object) - Details of the product.

## PUT /api/Products/{id}

### Description
Updates an existing product by its ID.

### Method
PUT

### Endpoint
/api/Products/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the product to update.

#### Request Body
- **ProductRequestDTO** (object) - Required - The updated product details.

### Response
#### Success Response (200)
- **ProductDTO** (object) - Details of the updated product.

## PATCH /api/Products/{id}

### Description
Partially updates an existing product by its ID.

### Method
PATCH

### Endpoint
/api/Products/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the product to partially update.

#### Request Body
- **PatchProductDTO** (object) - Optional - The fields to update in the product.

### Response
#### Success Response (200)
- **ProductDTO** (object) - Details of the partially updated product.

## GET /api/Products

### Description
Retrieves a list of all products.

### Method
GET

### Endpoint
/api/Products

### Response
#### Success Response (200)
- **ProductDTO[]** (array) - A list of products.

## POST /api/Products

### Description
Creates a new product.

### Method
POST

### Endpoint
/api/Products

#### Request Body
- **ProductRequestDTO** (object) - Required - The details of the new product.

### Response
#### Success Response (200)
- **ProductDTO** (object) - Details of the newly created product.

## POST /api/Products/genericFilter

### Description
Filters products based on provided criteria.

### Method
POST

### Endpoint
/api/Products/genericFilter

#### Request Body
- **GenericFilterModel** (object) - Required - The filter criteria.

### Response
#### Success Response (200)
- **GenericFilterModelCollection** (object) - A collection of products matching the filter criteria.
```

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

### ProductRequestDTO

Source: https://vonex.io/swagger/customer/swagger.json

Used for creating or updating product information, containing essential details required for product management.

```APIDOC
## ProductRequestDTO

### Description
Used for creating or updating product information, containing essential details required for product management.

### Properties
- **sku** (string) - Required. The Stock Keeping Unit for the product.
- **sku2** (string, nullable) - An alternative SKU for the product.
- **ean** (string) - Required. The European Article Number for the product.
- **name** (string) - Required. The name of the product.
- **description** (string, nullable) - A detailed description of the product.
- **type** (ProductType) - The type of the product.
- **nameEnglish** (string, nullable) - The English name of the product.
- **descriptionEnglish** (string, nullable) - The English description of the product.
- **price** (float) - The price of the product.
- **set** (boolean) - Indicates if the product is a set.
- **quantityIc** (integer) - Inventory count for the product.
- **quantityOc** (integer) - Order count for the product.
- **weight** (float) - The weight of the product.
- **width** (float) - The width of the product.
- **height** (float) - The height of the product.
- **length** (float) - The length of the product.
- **packUnit** (string, nullable) - The packaging unit for the product.
- **active** (boolean) - Indicates if the product is active.
- **setItems** (array, nullable) - A list of items included in the product set.
```

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

### WebHook Object

Source: https://vonex.io/swagger/customer/swagger.json

Represents a webhook configuration, used for receiving event notifications from the system.

```APIDOC
## WebHook Object

### Description
Represents a webhook configuration, allowing the system to send event notifications to a specified endpoint.

### Properties
- **id** (integer) - Unique identifier for the webhook.
- **eventType** (string, nullable) - The type of event to trigger the webhook.
- **endpointUrl** (string, nullable) - The URL of the endpoint to send notifications to.
- **token** (string, nullable) - An optional token for webhook authentication.
- **isActive** (boolean) - Indicates if the webhook is currently active.
- **user** (User) - The user associated with this webhook.
- **userId** (integer) - The ID of the user associated with this webhook.
```

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

### OrderRequestForUserDTO

Source: https://vonex.io/swagger/customer/swagger.json

Represents the data structure for creating or updating an order for a user.

```APIDOC
## OrderRequestForUserDTO

### Description
This DTO is used to represent an order placed by a user, including details such as order number, addresses, line items, and shipping information.

### Properties
- **orderNumber** (string) - Required - The unique identifier for the order.
- **status** (OrderStatus) - Optional - The current status of the order.
- **billingAddress** (BillingAddressRequestDTO) - Optional - The billing address for the order.
- **shippingAddress** (ShippingAddressRequestDTO) - Optional - The shipping address for the order.
- **lineItems** (array of LineItemRequestDTO) - Optional - A list of items included in the order.
- **tags** (array of string) - Optional - Tags associated with the order.
- **shippingMethod** (integer) - Optional - The ID of the shipping method.
- **shippingMethodName** (string) - Required - The name of the shipping method.
- **shippingDate** (string, format: date-time) - Optional - The date the order is scheduled to ship.
- **deliveryDate** (string, format: date-time) - Optional - The expected delivery date of the order.
- **customerComment** (string) - Optional - Any comments provided by the customer.
- **tracking** (array of TrackingRequestDTO) - Optional - Tracking information for the shipment.
- **customerNumber** (string) - Optional - The customer's account number.
- **customerOrderNumber** (string) - Optional - The customer's own order number.
- **orderPriority** (OrderPriority) - Optional - The priority level of the order.
- **salesChannel** (string) - Optional - The sales channel through which the order was placed.
- **test** (boolean) - Optional - Indicates if this is a test order.
- **gln** (string) - Optional - The Global Location Number.
- **userId** (integer) - Optional - The ID of the user placing the order.
- **userWinlineNumber** (string) - Optional - The user's Winline number.
```

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

### User Object

Source: https://vonex.io/swagger/customer/swagger.json

Represents a user within the system, including their authentication details, role, and associated products/orders.

```APIDOC
## User Object

### Description
Represents a user with their essential information, including authentication tokens, contact details, and associated data like products and orders.

### Properties
- **id** (integer) - Unique identifier for the user.
- **username** (string) - The user's chosen username.
- **token** (string) - Authentication token associated with the user.
- **email** (string) - The user's email address.
- **winlineNumber** (string) - Associated wineline number.
- **role** (TokenTypeEnum) - The role assigned to the user.
- **products** (array, nullable) - A list of products associated with the user.
- **orders** (array, nullable) - A list of orders placed by the user.
```

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

### OrderStatus

Source: https://vonex.io/swagger/customer/swagger.json

Enumeration of possible order statuses.

```APIDOC
## OrderStatus

### Description
This enum defines the possible states an order can be in throughout its lifecycle.

### Enum Values
- **Imported**
- **Picking**
- **Picked**
- **Fulfilled**
- **Cancelled**
- **CancellationRequest**
- **CancellationInProgress**
- **ConfirmationUpdate**
```

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

### User Management

Source: https://vonex.io/swagger/index.html?urls.primaryName=My%20API%20-%20admin

Endpoints for retrieving user-specific data and managing user tokens.

```APIDOC
## GET /api/Users/MyData

### Description
Retrieves the current user's data.

### Method
GET

### Endpoint
/api/Users/MyData

### Response
#### Success Response (200)
- **UserDTO** (object) - Details of the current user.

## GET /api/Users/RenewMyToken

### Description
Renews the current user's token.

### Method
GET

### Endpoint
/api/Users/RenewMyToken

### Response
#### Success Response (200)
- **TokenTypeEnum** (string) - The renewed token type.
```

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

### Update Product

Source: https://vonex.io/swagger/customer/swagger.json

Updates an existing product's information using its unique identifier.

```APIDOC
## PUT /api/Products/{id}

### Description
Updates an existing product's information using its unique identifier.

### Method
PUT

### Endpoint
/api/Products/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the product to update.

### Request Body
- **schema** (ProductRequestDTO) - Required - The data to update the product with.

### Response
#### Success Response (200)
- **ProductDTO** - The updated product details.
```

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

### Shipping Methods Management

Source: https://vonex.io/swagger/index.html?urls.primaryName=My%20API%20-%20admin

Endpoints for retrieving shipping methods.

```APIDOC
## GET /api/ShippingMethods

### Description
Retrieves a list of all available shipping methods.

### Method
GET

### Endpoint
/api/ShippingMethods

### Response
#### Success Response (200)
- **ShippingMethod[]** (array) - A list of shipping methods.

## GET /api/ShippingMethods/{id}

### Description
Retrieves a specific shipping method by its ID.

### Method
GET

### Endpoint
/api/ShippingMethods/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the shipping method to retrieve.

### Response
#### Success Response (200)
- **ShippingMethod** (object) - Details of the shipping method.
```

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

### Order Schema

Source: https://vonex.io/swagger/customer/swagger.json

Defines the structure of an Order object, including user information, addresses, and shipping details.

```APIDOC
## Order Object

### Description
Represents a customer order with details about billing and shipping addresses, order status, and associated user.

### Properties
- **id** (integer) - Unique identifier for the order.
- **userId** (integer) - Identifier for the user who placed the order.
- **orderNumber** (string) - The order number, must be at least 1 character long.
- **salesChannel** (string, nullable) - The sales channel through which the order was placed.
- **test** (boolean) - Flag indicating if this is a test order.
- **status** (OrderStatus) - The current status of the order.
- **billingAddressCountryCode** (string, nullable) - Country code for the billing address.
- **billingAddressFirstName** (string, nullable) - First name for the billing address.
- **billingAddressLastName** (string, nullable) - Last name for the billing address.
- **billingAddressZipCode** (string, nullable) - Zip code for the billing address.
- **billingAddressCity** (string, nullable) - City for the billing address.
- **billingAddressCompany** (string, nullable) - Company name for the billing address.
- **billingAddressStreet** (string, nullable) - Street address for the billing address.
- **billingAddressTitle** (string, nullable) - Title for the billing address.
- **billingAddressPhoneNumber** (string, nullable) - Phone number for the billing address.
- **billingAddressEmail** (string, nullable) - Email address for the billing address.
- **billingAddressAdditionalAddressLine1** (string, nullable) - Additional address line 1 for billing.
- **billingAddressAdditionalAddressLine2** (string, nullable) - Additional address line 2 for billing.
- **billingAddressGln** (string, nullable) - GLN for the billing address.
- **shippingAddressCountryCode** (string) - Country code for the shipping address, must be at least 1 character long.
- **shippingAddressFirstName** (string, nullable) - First name for the shipping address.
- **shippingAddressLastName** (string, nullable) - Last name for the shipping address.
- **shippingAddressZipCode** (string) - Zip code for the shipping address, must be at least 1 character long.
- **shippingAddressCity** (string) - City for the shipping address, must be at least 1 character long.
- **shippingAddressCompany** (string, nullable) - Company name for the shipping address.
- **shippingAddressStreet** (string) - Street address for the shipping address, must be at least 1 character long.
- **shippingAddressTitle** (string, nullable) - Title for the shipping address.
- **shippingAddressPhoneNumber** (string, nullable) - Phone number for the shipping address.
- **shippingAddressEmail** (string, nullable) - Email address for the shipping address.
- **shippingAddressAdditionalAddressLine1** (string, nullable) - Additional address line 1 for shipping.
- **shippingAddressAdditionalAddressLine2** (string, nullable) - Additional address line 2 for shipping.
- **shippingAddressGln** (string, nullable) - GLN for the shipping address.
- **orderDate** (string, date-time) - The date the order was placed.
- **createdAt** (string, date-time) - Timestamp when the order was created.
- **updatedAt** (string, date-time) - Timestamp when the order was last updated.
- **shippingMethod** (integer) - Identifier for the shipping method.
- **shippingMethodName** (string) - Name of the shipping method, must be at least 1 character long.
- **shippingDate** (string, date-time, nullable) - The date the order was shipped.
- **deliveryDate** (string, date-time, nullable) - The expected delivery date.
- **customerComment** (string, nullable) - Any comments from the customer.
- **user** (User) - The user associated with the order.
- **customerNumber** (string, nullable) - The customer's account number.
- **customerOrderNumber** (string, nullable) - The customer's reference number for the order.
```

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

### Orders Management

Source: https://vonex.io/swagger/index.html?urls.primaryName=My%20API%20-%20admin

Endpoints for managing orders, including retrieval, update, and creation.

```APIDOC
## GET /api/Orders/{id}

### Description
Retrieves a specific order by its ID.

### Method
GET

### Endpoint
/api/Orders/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the order to retrieve.

### Response
#### Success Response (200)
- **OrderDTO** (object) - Details of the order.

## PUT /api/Orders/{id}

### Description
Updates an existing order by its ID.

### Method
PUT

### Endpoint
/api/Orders/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the order to update.

#### Request Body
- **OrderRequestDTO** (object) - Required - The updated order details.

### Response
#### Success Response (200)
- **OrderDTO** (object) - Details of the updated order.

## PATCH /api/Orders/{id}

### Description
Partially updates an existing order by its ID.

### Method
PATCH

### Endpoint
/api/Orders/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the order to partially update.

#### Request Body
- **PatchOrderDTO** (object) - Optional - The fields to update in the order.

### Response
#### Success Response (200)
- **OrderDTO** (object) - Details of the partially updated order.

## POST /api/Orders

### Description
Creates a new order.

### Method
POST

### Endpoint
/api/Orders

#### Request Body
- **OrderRequestDTO** (object) - Required - The details of the new order.

### Response
#### Success Response (200)
- **OrderDTO** (object) - Details of the newly created order.

## POST /api/Orders/genericFilter

### Description
Filters orders based on provided criteria.

### Method
POST

### Endpoint
/api/Orders/genericFilter

#### Request Body
- **GenericFilterModel** (object) - Required - The filter criteria.

### Response
#### Success Response (200)
- **GenericFilterModelCollection** (object) - A collection of orders matching the filter criteria.
```

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

### WebHooks Management

Source: https://vonex.io/swagger/index.html?urls.primaryName=My%20API%20-%20admin

Endpoints for managing webhooks, including creation, retrieval, update, deletion, and activation.

```APIDOC
## GET /api/WebHooks

### Description
Retrieves a list of all configured webhooks.

### Method
GET

### Endpoint
/api/WebHooks

### Response
#### Success Response (200)
- **WebHook[]** (array) - A list of webhooks.

## POST /api/WebHooks

### Description
Creates a new webhook.

### Method
POST

### Endpoint
/api/WebHooks

#### Request Body
- **CreateWebHookRequest** (object) - Required - The details for the new webhook.

### Response
#### Success Response (200)
- **WebHook** (object) - Details of the created webhook.

## GET /api/WebHooks/{id}

### Description
Retrieves a specific webhook by its ID.

### Method
GET

### Endpoint
/api/WebHooks/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the webhook to retrieve.

### Response
#### Success Response (200)
- **WebHook** (object) - Details of the webhook.

## PUT /api/WebHooks/{id}

### Description
Updates an existing webhook by its ID.

### Method
PUT

### Endpoint
/api/WebHooks/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the webhook to update.

#### Request Body
- **UpdateWebHookRequest** (object) - Required - The updated webhook details.

### Response
#### Success Response (200)
- **WebHook** (object) - Details of the updated webhook.

## DELETE /api/WebHooks/{id}

### Description
Deletes a webhook by its ID.

### Method
DELETE

### Endpoint
/api/WebHooks/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the webhook to delete.

### Response
#### Success Response (200)
- **string** (string) - Confirmation message.

## PATCH /api/WebHooks/{id}/active

### Description
Activates or deactivates a webhook by its ID.

### Method
PATCH

### Endpoint
/api/WebHooks/{id}/active

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the webhook to update.

#### Request Body
- **PathActiveStatusRequest** (object) - Required - The activation status.

### Response
#### Success Response (200)
- **WebHook** (object) - Details of the updated webhook.
```

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

### Update Webhook

Source: https://vonex.io/swagger/customer/swagger.json

Updates an existing webhook.

```APIDOC
## PUT /api/WebHooks/{id}

### Description
Updates an existing webhook.

### Method
PUT

### Endpoint
/api/WebHooks/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the webhook to update.
```

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

### PatchProductDTO

Source: https://vonex.io/swagger/customer/swagger.json

Data Transfer Object for patching product details. Enables partial updates to product attributes such as SKU, EAN, name, description, pricing, and dimensions.

```APIDOC
## PatchProductDTO

### Description
Represents the data structure for updating product information. Allows for partial modifications to product attributes.

### Properties
- **sku** (string, nullable): Stock Keeping Unit for the product.
- **sku2** (string, nullable): Secondary SKU for the product.
- **ean** (string, nullable): European Article Number for the product.
- **name** (string, nullable): The name of the product.
- **description** (string, nullable): A detailed description of the product.
- **type** (ProductType, nullable): The type or category of the product.
- **nameEnglish** (string, nullable): The English name of the product.
- **descriptionEnglish** (string, nullable): The English description of the product.
- **price** (number, format: float, nullable): The price of the product.
- **set** (boolean, nullable): Indicates if the product is part of a set.
- **quantityIc** (integer, nullable): Quantity in inventory.
- **quantityOc** (integer, nullable): Quantity on order.
- **weight** (number, format: float, nullable): The weight of the product.
- **width** (number, format: float, nullable): The width of the product.
- **height** (number, format: float, nullable): The height of the product.
- **length** (number, format: float, nullable): The length of the product.
- **packUnit** (string, nullable): The packaging unit for the product.
```

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

### Filter Products

Source: https://vonex.io/swagger/customer/swagger.json

Filters products based on provided generic filter criteria.

```APIDOC
## POST /api/Products/genericFilter

### Description
Filters products based on provided generic filter criteria.

### Method
POST

### Endpoint
/api/Products/genericFilter

### Request Body
- A GenericFilterModelCollection object containing filter criteria.

### Request Example
{
  "example": "{\n  \"filters\": [\n    {\n      \"propertyName\": \"name\",\n      \"operator\": \"contains\",\n      \"value\": \"Example\"\n    }\n  ]\n}"
}

### Response
#### Success Response (200)
- An array of ProductDTO objects matching the filter criteria.

#### Response Example
{
  "example": "[\n  {\n    \"id\": 1,\n    \"name\": \"Example Product\",\n    \"description\": \"This is an example product.\",\n    \"price\": 19.99\n  }\n]"
}
```

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

### Stock Management

Source: https://vonex.io/swagger/index.html?urls.primaryName=My%20API%20-%20admin

Endpoints for retrieving stock information and filtering stock.

```APIDOC
## GET /api/Stock/allstocks

### Description
Retrieves all stock information.

### Method
GET

### Endpoint
/api/Stock/allstocks

### Response
#### Success Response (200)
- **StockDTO[]** (array) - A list of stock information.

## POST /api/Stock/genericFilter

### Description
Filters stock information based on provided criteria.

### Method
POST

### Endpoint
/api/Stock/genericFilter

#### Request Body
- **GenericFilterModel** (object) - Required - The filter criteria.

### Response
#### Success Response (200)
- **GenericFilterModelCollection** (object) - A collection of stock information matching the filter criteria.
```

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

### Raw Data Management

Source: https://vonex.io/swagger/index.html?urls.primaryName=My%20API%20-%20admin

Endpoints for managing raw data records, including creation, retrieval, update, deletion, and filtering.

```APIDOC
## POST /api/RawData

### Description
Creates a new raw data record.

### Method
POST

### Endpoint
/api/RawData

#### Request Body
- **RawDataRecord** (object) - Required - The raw data record to create.

### Response
#### Success Response (200)
- **RawDataRecord** (object) - Details of the created raw data record.

## POST /api/RawData/feature/{featureName}

### Description
Creates a new raw data record associated with a specific feature.

### Method
POST

### Endpoint
/api/RawData/feature/{featureName}

### Parameters
#### Path Parameters
- **featureName** (string) - Required - The name of the feature.

#### Request Body
- **RawDataRecord** (object) - Required - The raw data record to create.

### Response
#### Success Response (200)
- **RawDataRecord** (object) - Details of the created raw data record.

## GET /api/RawData/{id}

### Description
Retrieves a specific raw data record by its ID.

### Method
GET

### Endpoint
/api/RawData/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the raw data record to retrieve.

### Response
#### Success Response (200)
- **RawDataRecord** (object) - Details of the raw data record.

## PUT /api/RawData/{id}

### Description
Updates an existing raw data record by its ID.

### Method
PUT

### Endpoint
/api/RawData/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the raw data record to update.

#### Request Body
- **RawDataRecord** (object) - Required - The updated raw data record details.

### Response
#### Success Response (200)
- **RawDataRecord** (object) - Details of the updated raw data record.

## DELETE /api/RawData/{id}

### Description
Deletes a raw data record by its ID.

### Method
DELETE

### Endpoint
/api/RawData/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the raw data record to delete.

### Response
#### Success Response (200)
- **string** (string) - Confirmation message.

## PATCH /api/RawData/{id}

### Description
Partially updates an existing raw data record by its ID.

### Method
PATCH

### Endpoint
/api/RawData/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the raw data record to partially update.

#### Request Body
- **PatchRawDataRecordTimestamp** (object) - Optional - The fields to update in the raw data record.

### Response
#### Success Response (200)
- **RawDataRecord** (object) - Details of the partially updated raw data record.

## POST /api/RawData/genericFilter

### Description
Filters raw data records based on provided criteria.

### Method
POST

### Endpoint
/api/RawData/genericFilter

#### Request Body
- **GenericFilterModel** (object) - Required - The filter criteria.

### Response
#### Success Response (200)
- **GenericFilterModelCollection** (object) - A collection of raw data records matching the filter criteria.
```

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

### OrderTagDTO

Source: https://vonex.io/swagger/customer/swagger.json

Data Transfer Object for creating or updating an order tag.

```APIDOC
## OrderTagDTO

### Description
This DTO is used to manage tags associated with an order.

### Properties
- **tagName** (string) - Required - The name of the tag to be applied or removed from the order.
```

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

### Partially Update Product

Source: https://vonex.io/swagger/customer/swagger.json

Partially updates an existing product's information using its unique identifier.

```APIDOC
## PATCH /api/Products/{id}

### Description
Partially updates an existing product's information using its unique identifier.

### Method
PATCH

### Endpoint
/api/Products/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the product to partially update.

### Request Body
- **schema** (PatchProductDTO) - Required - The data to partially update the product with.

### Response
#### Success Response (200)
- **ProductDTO** - The updated product details.
```

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

### Update WebHook

Source: https://vonex.io/swagger/customer/swagger.json

Updates an existing webhook. This operation allows modification of webhook details.

```APIDOC
## PUT /api/WebHooks

### Description
Updates an existing webhook.

### Method
PUT

### Endpoint
/api/WebHooks

### Request Body
- **UpdateWebHookRequest** (object) - Required - The payload for updating the webhook.

### Response
#### Success Response (200)
- Description: Success
```

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

### PatchOrderDTO

Source: https://vonex.io/swagger/customer/swagger.json

Data Transfer Object for patching order details. Allows for partial updates to an order, including its status, addresses, line items, shipping information, and customer-specific details.

```APIDOC
## PatchOrderDTO

### Description
Represents the data structure for updating an existing order. Allows modification of various order attributes.

### Properties
- **orderNumber** (string, nullable): The unique identifier for the order.
- **status** (OrderStatus, nullable): The current status of the order.
- **billingAddress** (PatchAddressDTO, nullable): Updated billing address information.
- **shippingAddress** (PatchAddressDTO, nullable): Updated shipping address information.
- **lineItems** (array of LineItemRequestDTO, nullable): A list of line items to be updated or added.
- **tags** (array of string, nullable): Tags associated with the order.
- **shippingMethod** (integer, nullable): Identifier for the shipping method.
- **shippingMethodName** (string, nullable): Name of the shipping method.
- **shippingDate** (string, format: date-time, nullable): The scheduled shipping date.
- **deliveryDate** (string, format: date-time, nullable): The expected delivery date.
- **customerComment** (string, nullable): Comments provided by the customer.
- **tracking** (array of PatchTrackingDTO, nullable): Tracking information for the shipment.
- **customerNumber** (string, nullable): The customer's account number.
- **customerOrderNumber** (string, nullable): The customer's reference number for the order.
- **orderPriority** (OrderPriority, nullable): The priority level of the order.
```

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

### Filter Orders

Source: https://vonex.io/swagger/customer/swagger.json

Retrieves a list of orders based on specified filter criteria.

```APIDOC
## POST /api/Orders/genericFilter

### Description
Retrieves a list of orders based on generic filter criteria.

### Method
POST

### Endpoint
/api/Orders/genericFilter

### Request Body
- **schema** (GenericFilterModelCollection) - Required - The filter model collection to apply.

### Response
#### Success Response (200)
- **Array of OrderDTO** - A list of orders matching the filter criteria.
```

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

### User Request DTO

Source: https://vonex.io/swagger/customer/swagger.json

Data Transfer Object for creating or updating user information, specifying required fields for user registration or modification.

```APIDOC
## User Request DTO

### Description
Data Transfer Object used for user-related requests, such as creating or updating user profiles. It includes essential fields for these operations.

### Properties
- **username** (string, nullable) - The user's chosen username. Optional.
- **email** (string) - The user's email address. Required.
- **winlineNumber** (string) - Associated wineline number. Required.
- **role** (TokenTypeEnum) - The role assigned to the user. Required.
```

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

### Filter Stock Items

Source: https://vonex.io/swagger/customer/swagger.json

Filters stock items based on provided criteria.

```APIDOC
## POST /api/Stock/genericFilter

### Description
Filters stock items based on provided criteria.

### Method
POST

### Endpoint
/api/Stock/genericFilter

### Request Body
- (GenericFilterModelCollection) - The criteria for filtering stock items.

### Response
#### Success Response (200)
- items (StockDTO[]) - A list of filtered stock items.
```

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

### Update Raw Data by ID

Source: https://vonex.io/swagger/customer/swagger.json

Updates an existing raw data record identified by its ID.

```APIDOC
## PUT /api/RawData/{id}

### Description
Updates an existing raw data record identified by its ID.

### Method
PUT

### Endpoint
/api/RawData/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the raw data record to update.
```

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

### User DTO

Source: https://vonex.io/swagger/customer/swagger.json

Data Transfer Object for User information, typically used for returning user data without sensitive details.

```APIDOC
## User DTO

### Description
Data Transfer Object for user information, suitable for responses where full user details might not be necessary.

### Properties
- **id** (integer) - Unique identifier for the user.
- **username** (string) - The user's chosen username.
- **email** (string) - The user's email address.
- **winlineNumber** (string) - Associated wineline number.
- **role** (TokenTypeEnum) - The role assigned to the user.
```

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

### Filter Raw Data

Source: https://vonex.io/swagger/customer/swagger.json

Applies a generic filter to retrieve a collection of raw data records.

```APIDOC
## POST /api/RawData/genericFilter

### Description
Filters raw data records based on a provided generic filter model collection.

### Method
POST

### Endpoint
/api/RawData/genericFilter

### Request Body
- **GenericFilterModelCollection** (object) - Required - The filter criteria for retrieving raw data.
```

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

### Activate/Deactivate WebHook

Source: https://vonex.io/swagger/customer/swagger.json

Activates or deactivates a webhook. This endpoint allows toggling the active status of a webhook.

```APIDOC
## PATCH /api/WebHooks/{Id}/active

### Description
Activates or deactivates a webhook.

### Method
PATCH

### Endpoint
/api/WebHooks/{Id}/active

### Parameters
#### Path Parameters
- **Id** (integer) - Required - The unique identifier of the webhook.

### Request Body
- **PathActiveStatusRequest** (object) - Required - The payload to set the active status.

### Response
#### Success Response (200)
- Description: Success
```

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

### Renew My Auth Token

Source: https://vonex.io/swagger/customer/swagger.json

Renews the authentication token for the current user.

```APIDOC
## GET /api/Users/RenewMyToken

### Description
Renews the authentication token for the current user.

### Method
GET

### Endpoint
/api/Users/RenewMyToken

### Response
#### Success Response (200)
- **FullUserDTO** (object) - The user's full data object after token renewal.
```

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

### Patch Raw Data by ID

Source: https://vonex.io/swagger/customer/swagger.json

Partially updates a raw data record by its ID, typically used for timestamp modifications.

```APIDOC
## PATCH /api/RawData/{id}

### Description
Partially updates a raw data record identified by its ID. This is often used for updating timestamps.

### Method
PATCH

### Endpoint
/api/RawData/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the raw data record to partially update.

#### Request Body
- **PatchRawDataRecordTimestamp** (object) - Required - The payload containing fields to update, typically timestamp-related.
```

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

### Delete Stock Entry

Source: https://vonex.io/swagger/customer/swagger.json

Removes a specific stock entry from the system using its unique identifier.

```APIDOC
## DELETE /stock/{stockTableEntryId}

### Description
Deletes a stock entry by its ID.

### Method
DELETE

### Endpoint
/stock/{stockTableEntryId}

### Parameters
#### Path Parameters
- **stockTableEntryId** (integer) - Required - The ID of the stock entry to delete.
```

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

### Delete Raw Data by ID

Source: https://vonex.io/swagger/customer/swagger.json

Deletes a raw data record using its unique identifier.

```APIDOC
## DELETE /api/RawData/{id}

### Description
Deletes a raw data record based on its ID.

### Method
DELETE

### Endpoint
/api/RawData/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the raw data record to delete.
```

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

### Delete WebHook

Source: https://vonex.io/swagger/customer/swagger.json

Deletes a webhook by its ID. This action permanently removes the specified webhook.

```APIDOC
## DELETE /api/WebHooks/{id}

### Description
Deletes a webhook by its ID.

### Method
DELETE

### Endpoint
/api/WebHooks/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the webhook to delete.

### Response
#### Success Response (200)
- Description: Success
```

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

### Update Order

Source: https://vonex.io/swagger/customer/swagger.json

Updates an existing order using its unique identifier. Requires order details in the request body.

```APIDOC
## PUT /api/Orders/{id}

### Description
Updates an existing order using its unique identifier. Requires order details in the request body.

### Method
PUT

### Endpoint
/api/Orders/{id}

#### Path Parameters
- **id** (integer) - Required - The unique identifier of the order to update.

#### Request Body
- **OrderRequestDTO** - Required - The updated order details.
```

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

### Partially Update Order

Source: https://vonex.io/swagger/customer/swagger.json

Partially updates an existing order using its unique identifier. Requires partial order details in the request body.

```APIDOC
## PATCH /api/Orders/{id}

### Description
Partially updates an existing order using its unique identifier. Requires partial order details in the request body.

### Method
PATCH

### Endpoint
/api/Orders/{id}

#### Path Parameters
- **id** (integer) - Required - The unique identifier of the order to partially update.

#### Request Body
- **PatchOrderDTO** - Required - The partial order details for the update.
```
Tokens:
Raw