# openapi.api.CheckoutCheckoutsApi

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

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**completeCheckout**](CheckoutCheckoutsApi.md#completecheckout) | **PATCH** /api/checkout/checkouts/complete | 
[**confirmOrderByPaypal**](CheckoutCheckoutsApi.md#confirmorderbypaypal) | **POST** /api/checkout/customer/{customerId}/checkouts/{id}/complete/paypal | 
[**createCheckoutInformation**](CheckoutCheckoutsApi.md#createcheckoutinformation) | **PATCH** /api/checkout/checkouts/information | 
[**createCheckoutPayment**](CheckoutCheckoutsApi.md#createcheckoutpayment) | **PATCH** /api/checkout/checkouts/payment | 
[**createCheckoutShipping**](CheckoutCheckoutsApi.md#createcheckoutshipping) | **PATCH** /api/checkout/checkouts/shipping | 
[**createDiscount**](CheckoutCheckoutsApi.md#creatediscount) | **POST** /api/checkout/checkouts/discount | 
[**findAll**](CheckoutCheckoutsApi.md#findall) | **GET** /api/checkout/customer/{customerId}/checkouts | 
[**findOne**](CheckoutCheckoutsApi.md#findone) | **GET** /api/checkout/customer/{customerId}/checkouts/{id} | 
[**getAbandoned**](CheckoutCheckoutsApi.md#getabandoned) | **GET** /api/checkout/checkouts/abandoned/{id} | 
[**getAllAbandoned**](CheckoutCheckoutsApi.md#getallabandoned) | **GET** /api/checkout/checkouts/abandoned | 
[**getCurrentCheckout**](CheckoutCheckoutsApi.md#getcurrentcheckout) | **GET** /api/checkout/checkouts/current | 
[**sendEmailToAbandoned**](CheckoutCheckoutsApi.md#sendemailtoabandoned) | **POST** /api/checkout/checkouts/send-email-to-abandoned | 


# **completeCheckout**
> CreateCheckoutResponseDto completeCheckout(completeCheckoutBody)



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

final api = Openapi().getCheckoutCheckoutsApi();
final CompleteCheckoutBody completeCheckoutBody = ; // CompleteCheckoutBody | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **completeCheckoutBody** | [**CompleteCheckoutBody**](CompleteCheckoutBody.md)|  | 

### Return type

[**CreateCheckoutResponseDto**](CreateCheckoutResponseDto.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)

# **confirmOrderByPaypal**
> JsonObject confirmOrderByPaypal(customerId, id)



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

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

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

### Parameters

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

### Return type

[**JsonObject**](JsonObject.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)

# **createCheckoutInformation**
> CreateCheckoutResponseDto createCheckoutInformation(createCheckoutInformationBodyDto)



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

final api = Openapi().getCheckoutCheckoutsApi();
final CreateCheckoutInformationBodyDto createCheckoutInformationBodyDto = ; // CreateCheckoutInformationBodyDto | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **createCheckoutInformationBodyDto** | [**CreateCheckoutInformationBodyDto**](CreateCheckoutInformationBodyDto.md)|  | 

### Return type

[**CreateCheckoutResponseDto**](CreateCheckoutResponseDto.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)

# **createCheckoutPayment**
> CreateCheckoutResponseDto createCheckoutPayment(createCheckoutPaymentBodyDto)



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

final api = Openapi().getCheckoutCheckoutsApi();
final CreateCheckoutPaymentBodyDto createCheckoutPaymentBodyDto = ; // CreateCheckoutPaymentBodyDto | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **createCheckoutPaymentBodyDto** | [**CreateCheckoutPaymentBodyDto**](CreateCheckoutPaymentBodyDto.md)|  | 

### Return type

[**CreateCheckoutResponseDto**](CreateCheckoutResponseDto.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)

# **createCheckoutShipping**
> CreateCheckoutResponseDto createCheckoutShipping(createCheckoutShippingBodyDto)



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

final api = Openapi().getCheckoutCheckoutsApi();
final CreateCheckoutShippingBodyDto createCheckoutShippingBodyDto = ; // CreateCheckoutShippingBodyDto | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **createCheckoutShippingBodyDto** | [**CreateCheckoutShippingBodyDto**](CreateCheckoutShippingBodyDto.md)|  | 

### Return type

[**CreateCheckoutResponseDto**](CreateCheckoutResponseDto.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)

# **createDiscount**
> CreateCheckoutResponseDto createDiscount(createCheckoutDiscountBodyDto)



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

final api = Openapi().getCheckoutCheckoutsApi();
final CreateCheckoutDiscountBodyDto createCheckoutDiscountBodyDto = ; // CreateCheckoutDiscountBodyDto | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **createCheckoutDiscountBodyDto** | [**CreateCheckoutDiscountBodyDto**](CreateCheckoutDiscountBodyDto.md)|  | 

### Return type

[**CreateCheckoutResponseDto**](CreateCheckoutResponseDto.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)

# **findAll**
> GetAllAbandonedsResponse findAll(customerId, page, limit, search, sort, status)



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

final api = Openapi().getCheckoutCheckoutsApi();
final num customerId = 8.14; // num | 
final num page = 8.14; // num | 
final num limit = 8.14; // num | 
final String search = search_example; // String | 
final GetAllDraftOrdersSort sort = ; // GetAllDraftOrdersSort | sort of draftOrders
final AbandonedStatus status = ; // AbandonedStatus | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **customerId** | **num**|  | 
 **page** | **num**|  | [optional] [default to 1]
 **limit** | **num**|  | [optional] [default to 10]
 **search** | **String**|  | [optional] 
 **sort** | [**GetAllDraftOrdersSort**](.md)| sort of draftOrders | [optional] 
 **status** | [**AbandonedStatus**](.md)|  | [optional] 

### Return type

[**GetAllAbandonedsResponse**](GetAllAbandonedsResponse.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)

# **findOne**
> GetAbandonedResponse findOne(customerId, id)



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

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

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

### Parameters

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

### Return type

[**GetAbandonedResponse**](GetAbandonedResponse.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)

# **getAbandoned**
> GetAbandonedResponse getAbandoned(id)



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

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

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

### Parameters

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

### Return type

[**GetAbandonedResponse**](GetAbandonedResponse.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)

# **getAllAbandoned**
> GetAllAbandonedsResponse getAllAbandoned(page, limit, search, sort, status)



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

final api = Openapi().getCheckoutCheckoutsApi();
final num page = 8.14; // num | 
final num limit = 8.14; // num | 
final String search = search_example; // String | 
final GetAllDraftOrdersSort sort = ; // GetAllDraftOrdersSort | sort of draftOrders
final AbandonedStatus status = ; // AbandonedStatus | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **page** | **num**|  | [optional] [default to 1]
 **limit** | **num**|  | [optional] [default to 10]
 **search** | **String**|  | [optional] 
 **sort** | [**GetAllDraftOrdersSort**](.md)| sort of draftOrders | [optional] 
 **status** | [**AbandonedStatus**](.md)|  | [optional] 

### Return type

[**GetAllAbandonedsResponse**](GetAllAbandonedsResponse.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)

# **getCurrentCheckout**
> CreateCheckoutResponseDto getCurrentCheckout()



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

final api = Openapi().getCheckoutCheckoutsApi();

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

### Parameters
This endpoint does not need any parameter.

### Return type

[**CreateCheckoutResponseDto**](CreateCheckoutResponseDto.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)

# **sendEmailToAbandoned**
> OkRes sendEmailToAbandoned(sendEmailToAbandonedBody)



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

final api = Openapi().getCheckoutCheckoutsApi();
final SendEmailToAbandonedBody sendEmailToAbandonedBody = ; // SendEmailToAbandonedBody | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **sendEmailToAbandonedBody** | [**SendEmailToAbandonedBody**](SendEmailToAbandonedBody.md)|  | 

### Return type

[**OkRes**](OkRes.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)