# openapi.api.ProductsVariantsApi

## Load the API package
```dart
import 'package:openapi/api.dart';
```

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createInventoryHistory**](ProductsVariantsApi.md#createinventoryhistory) | **POST** /api/product/variant/inventory/history | 
[**deleteVariant**](ProductsVariantsApi.md#deletevariant) | **DELETE** /api/product/variant/{id} | 
[**getAlLVariantsInInventoryHistory**](ProductsVariantsApi.md#getallvariantsininventoryhistory) | **GET** /api/product/variant/inventory/history | Get All Variants Histories
[**getAllVariants**](ProductsVariantsApi.md#getallvariants) | **GET** /api/product/variant/inventory | Get All Variants In Inventory
[**getVariantsByIds**](ProductsVariantsApi.md#getvariantsbyids) | **GET** /api/product/variant | 


# **createInventoryHistory**
> ShippingHistoryEntity createInventoryHistory(createVariantInventoryBody)



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getProductsVariantsApi();
final CreateVariantInventoryBody createVariantInventoryBody = ; // CreateVariantInventoryBody | 

try {
    final response = api.createInventoryHistory(createVariantInventoryBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling ProductsVariantsApi->createInventoryHistory: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **createVariantInventoryBody** | [**CreateVariantInventoryBody**](CreateVariantInventoryBody.md)|  | 

### Return type

[**ShippingHistoryEntity**](ShippingHistoryEntity.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteVariant**
> OkRes deleteVariant(id)



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getProductsVariantsApi();
final num id = 8.14; // num | 

try {
    final response = api.deleteVariant(id);
    print(response);
} catch on DioError (e) {
    print('Exception when calling ProductsVariantsApi->deleteVariant: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **num**|  | 

### Return type

[**OkRes**](OkRes.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getAlLVariantsInInventoryHistory**
> GetAllVariantHistory getAlLVariantsInInventoryHistory(inventoryId, locationId, page, limit)

Get All Variants Histories

### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getProductsVariantsApi();
final num inventoryId = 8.14; // num | 
final num locationId = 8.14; // num | 
final num page = 8.14; // num | Page number
final num limit = 8.14; // num | Number of results to be returned

try {
    final response = api.getAlLVariantsInInventoryHistory(inventoryId, locationId, page, limit);
    print(response);
} catch on DioError (e) {
    print('Exception when calling ProductsVariantsApi->getAlLVariantsInInventoryHistory: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **inventoryId** | **num**|  | 
 **locationId** | **num**|  | 
 **page** | **num**| Page number | [default to 1]
 **limit** | **num**| Number of results to be returned | [default to 10]

### Return type

[**GetAllVariantHistory**](GetAllVariantHistory.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getAllVariants**
> GetAllInventoriesResponse getAllVariants(page, limit, search, sort, locationId)

Get All Variants In Inventory

### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getProductsVariantsApi();
final num page = 8.14; // num | Page number
final num limit = 8.14; // num | Number of results to be returned
final String search = search_example; // String | 
final GetAllVariantsSort sort = ; // GetAllVariantsSort | sort of variants
final num locationId = 8.14; // num | 

try {
    final response = api.getAllVariants(page, limit, search, sort, locationId);
    print(response);
} catch on DioError (e) {
    print('Exception when calling ProductsVariantsApi->getAllVariants: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **page** | **num**| Page number | [default to 1]
 **limit** | **num**| Number of results to be returned | [default to 10]
 **search** | **String**|  | [optional] 
 **sort** | [**GetAllVariantsSort**](.md)| sort of variants | [optional] 
 **locationId** | **num**|  | [optional] 

### Return type

[**GetAllInventoriesResponse**](GetAllInventoriesResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getVariantsByIds**
> BuiltList<ProductVariantEntity> getVariantsByIds(variantIds)



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getProductsVariantsApi();
final BuiltList<num> variantIds = ; // BuiltList<num> | 

try {
    final response = api.getVariantsByIds(variantIds);
    print(response);
} catch on DioError (e) {
    print('Exception when calling ProductsVariantsApi->getVariantsByIds: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **variantIds** | [**BuiltList&lt;num&gt;**](num.md)|  | 

### Return type

[**BuiltList&lt;ProductVariantEntity&gt;**](ProductVariantEntity.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)