# openapi.api.CheckoutOrdersApi ## Load the API package ```dart import 'package:openapi/api.dart'; ``` All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- [**callGet**](CheckoutOrdersApi.md#callget) | **GET** /api/checkout/orders/{id} | Get order by ID [**changeFulfillmentStatus**](CheckoutOrdersApi.md#changefulfillmentstatus) | **POST** /api/checkout/orders/{orderId}/fulfillments/{fulfillmentId}/status | Change fulfilled items status [**changeRefundStatus**](CheckoutOrdersApi.md#changerefundstatus) | **POST** /api/checkout/orders/{orderId}/refunds/{refundId}/status | Change refunded items status [**changeReturnStatus**](CheckoutOrdersApi.md#changereturnstatus) | **POST** /api/checkout/orders/{orderId}/returns/{returnId}/status | Change returned items status [**complateOrder**](CheckoutOrdersApi.md#complateorder) | **POST** /api/checkout/orders/{id}/complete | Complete order [**createComment**](CheckoutOrdersApi.md#createcomment) | **POST** /api/checkout/orders/{orderId}/comment | Comment on an order [**createFulfillmentTracking**](CheckoutOrdersApi.md#createfulfillmenttracking) | **PUT** /api/checkout/orders/{orderId}/fulfillments/{fulfillmentId} | ِAdd/Update tracking number [**createReturnTracking**](CheckoutOrdersApi.md#createreturntracking) | **PUT** /api/checkout/orders/{orderId}/returns/{returnId} | Add/Update returned items tracking number [**createTag**](CheckoutOrdersApi.md#createtag) | **POST** /api/checkout/orders/tags | Create a new tag [**deleteComment**](CheckoutOrdersApi.md#deletecomment) | **DELETE** /api/checkout/orders/{orderId}/comment/{id} | Delete a comment from an order [**fulfill**](CheckoutOrdersApi.md#fulfill) | **POST** /api/checkout/orders/{orderId}/fulfill | Fulfill items [**getAll**](CheckoutOrdersApi.md#getall) | **GET** /api/checkout/orders | Get all orders [**getAllCustomerInvoices**](CheckoutOrdersApi.md#getallcustomerinvoices) | **GET** /api/checkout/orders/invoices/customer/{customerId} | Get customer's invoices [**getAllFleets**](CheckoutOrdersApi.md#getallfleets) | **GET** /api/checkout/orders/logistics/fleets | Get all fleets [**getAllInvoices**](CheckoutOrdersApi.md#getallinvoices) | **GET** /api/checkout/orders/invoices | Get all invoices [**getAllLogistics**](CheckoutOrdersApi.md#getalllogistics) | **GET** /api/checkout/orders/logistics | Get all logistics [**getAllTags**](CheckoutOrdersApi.md#getalltags) | **GET** /api/checkout/orders/tags | Get all tags [**getByUid**](CheckoutOrdersApi.md#getbyuid) | **POST** /api/checkout/orders/link/{uid} | [**getCartFromLink**](CheckoutOrdersApi.md#getcartfromlink) | **GET** /api/checkout/orders/link/{link} | [**getFulfillmentStatuses**](CheckoutOrdersApi.md#getfulfillmentstatuses) | **GET** /api/checkout/orders/fulfillments/statuses | Get all fulfillment statuses [**getFulfillments**](CheckoutOrdersApi.md#getfulfillments) | **GET** /api/checkout/orders/{orderId}/fulfill | Get fulfilled items [**getRefundStatuses**](CheckoutOrdersApi.md#getrefundstatuses) | **GET** /api/checkout/orders/refunds/statuses | Get all refunds statuses [**getReturnStatuses**](CheckoutOrdersApi.md#getreturnstatuses) | **GET** /api/checkout/orders/returns/statuses | Get all returns statuses [**getUnfulfilled**](CheckoutOrdersApi.md#getunfulfilled) | **GET** /api/checkout/orders/{orderId}/unfulfill | Get unfulfilled items [**markPaymentAsPaid**](CheckoutOrdersApi.md#markpaymentaspaid) | **PATCH** /api/checkout/orders/{orderId}/mark-as-paid | Mark an order as paid [**refund**](CheckoutOrdersApi.md#refund) | **POST** /api/checkout/orders/{orderId}/refund | Refund items [**returnProduct**](CheckoutOrdersApi.md#returnproduct) | **POST** /api/checkout/orders/{orderId}/return | Return items [**sendInvoice**](CheckoutOrdersApi.md#sendinvoice) | **POST** /api/checkout/orders/{orderId}/send-invoice | Send Invoice [**updateOrderNotes**](CheckoutOrdersApi.md#updateordernotes) | **PATCH** /api/checkout/orders/{orderId}/notes | Update order's notes [**updateOrderTags**](CheckoutOrdersApi.md#updateordertags) | **PATCH** /api/checkout/orders/{orderId}/tag | Update order's tags # **callGet** > GetOrderResponseDto callGet(id) Get order by ID ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num id = 8.14; // num | Order ID try { final response = api.callGet(id); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->callGet: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **num**| Order ID | ### Return type [**GetOrderResponseDto**](GetOrderResponseDto.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) # **changeFulfillmentStatus** > FulfillmentStatusEntity changeFulfillmentStatus(orderId, fulfillmentId, fulfillmentStatusEntity) Change fulfilled items status ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID final num fulfillmentId = 8.14; // num | Fulfillment ID final FulfillmentStatusEntity fulfillmentStatusEntity = ; // FulfillmentStatusEntity | try { final response = api.changeFulfillmentStatus(orderId, fulfillmentId, fulfillmentStatusEntity); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->changeFulfillmentStatus: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | **fulfillmentId** | **num**| Fulfillment ID | **fulfillmentStatusEntity** | [**FulfillmentStatusEntity**](FulfillmentStatusEntity.md)| | ### Return type [**FulfillmentStatusEntity**](FulfillmentStatusEntity.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) # **changeRefundStatus** > RefundStatusEntity changeRefundStatus(orderId, refundId, refundStatusEntity) Change refunded items status ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID final num refundId = 8.14; // num | Refund ID final RefundStatusEntity refundStatusEntity = ; // RefundStatusEntity | try { final response = api.changeRefundStatus(orderId, refundId, refundStatusEntity); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->changeRefundStatus: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | **refundId** | **num**| Refund ID | **refundStatusEntity** | [**RefundStatusEntity**](RefundStatusEntity.md)| | ### Return type [**RefundStatusEntity**](RefundStatusEntity.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) # **changeReturnStatus** > ReturnStatusEntity changeReturnStatus(orderId, returnId, returnStatusEntity) Change returned items status ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID final num returnId = 8.14; // num | Return ID final ReturnStatusEntity returnStatusEntity = ; // ReturnStatusEntity | try { final response = api.changeReturnStatus(orderId, returnId, returnStatusEntity); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->changeReturnStatus: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | **returnId** | **num**| Return ID | **returnStatusEntity** | [**ReturnStatusEntity**](ReturnStatusEntity.md)| | ### Return type [**ReturnStatusEntity**](ReturnStatusEntity.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) # **complateOrder** > GetOrderResponseDto complateOrder(id) Complete order ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num id = 8.14; // num | Order ID try { final response = api.complateOrder(id); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->complateOrder: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **num**| Order ID | ### Return type [**GetOrderResponseDto**](GetOrderResponseDto.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) # **createComment** > OrderCommentEntity createComment(orderId, orderCommentEntity) Comment on an order ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID final OrderCommentEntity orderCommentEntity = ; // OrderCommentEntity | try { final response = api.createComment(orderId, orderCommentEntity); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->createComment: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | **orderCommentEntity** | [**OrderCommentEntity**](OrderCommentEntity.md)| | ### Return type [**OrderCommentEntity**](OrderCommentEntity.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) # **createFulfillmentTracking** > FulfillmentEntity createFulfillmentTracking(orderId, fulfillmentId, createFulfillmentTrackingBody) ِAdd/Update tracking number ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID final num fulfillmentId = 8.14; // num | Fulfillment ID final CreateFulfillmentTrackingBody createFulfillmentTrackingBody = ; // CreateFulfillmentTrackingBody | try { final response = api.createFulfillmentTracking(orderId, fulfillmentId, createFulfillmentTrackingBody); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->createFulfillmentTracking: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | **fulfillmentId** | **num**| Fulfillment ID | **createFulfillmentTrackingBody** | [**CreateFulfillmentTrackingBody**](CreateFulfillmentTrackingBody.md)| | ### Return type [**FulfillmentEntity**](FulfillmentEntity.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) # **createReturnTracking** > OrderReturnEntity createReturnTracking(orderId, returnId, createReturnTrackingBody) Add/Update returned items tracking number ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID final num returnId = 8.14; // num | Return ID final CreateReturnTrackingBody createReturnTrackingBody = ; // CreateReturnTrackingBody | try { final response = api.createReturnTracking(orderId, returnId, createReturnTrackingBody); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->createReturnTracking: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | **returnId** | **num**| Return ID | **createReturnTrackingBody** | [**CreateReturnTrackingBody**](CreateReturnTrackingBody.md)| | ### Return type [**OrderReturnEntity**](OrderReturnEntity.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) # **createTag** > OrderTagEntity createTag(createOrderTagBody) Create a new tag ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final CreateOrderTagBody createOrderTagBody = ; // CreateOrderTagBody | try { final response = api.createTag(createOrderTagBody); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->createTag: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createOrderTagBody** | [**CreateOrderTagBody**](CreateOrderTagBody.md)| | ### Return type [**OrderTagEntity**](OrderTagEntity.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) # **deleteComment** > OkRes deleteComment(orderId, id) Delete a comment from an order ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID final num id = 8.14; // num | try { final response = api.deleteComment(orderId, id); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->deleteComment: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | **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) # **fulfill** > FulfillOrderRes fulfill(orderId, fulfillmentEntity) Fulfill items ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID final FulfillmentEntity fulfillmentEntity = ; // FulfillmentEntity | try { final response = api.fulfill(orderId, fulfillmentEntity); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->fulfill: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | **fulfillmentEntity** | [**FulfillmentEntity**](FulfillmentEntity.md)| | ### Return type [**FulfillOrderRes**](FulfillOrderRes.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) # **getAll** > GetAllOrdersResponse getAll(page, limit, search, sort, status, paymentProviderIds) Get all orders ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num page = 8.14; // num | final num limit = 8.14; // num | final String search = search_example; // String | final GetAllordersSort sort = ; // GetAllordersSort | sort of orders final GetAllOrdersStatusEnum status = ; // GetAllOrdersStatusEnum | status of order final BuiltList paymentProviderIds = ; // BuiltList | Payment provider IDS that you want to get try { final response = api.getAll(page, limit, search, sort, status, paymentProviderIds); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->getAll: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page** | **num**| | [optional] [default to 1] **limit** | **num**| | [optional] [default to 10] **search** | **String**| | [optional] **sort** | [**GetAllordersSort**](.md)| sort of orders | [optional] **status** | [**GetAllOrdersStatusEnum**](.md)| status of order | [optional] **paymentProviderIds** | [**BuiltList<num>**](num.md)| Payment provider IDS that you want to get | [optional] ### Return type [**GetAllOrdersResponse**](GetAllOrdersResponse.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) # **getAllCustomerInvoices** > GetAllCustomerInvoicesRes getAllCustomerInvoices(page, limit, customerId, sort, search, from, to) Get customer's invoices ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num page = 8.14; // num | Page number final num limit = 8.14; // num | Number of results to be returned final num customerId = 8.14; // num | final GetAllInvoiceSort sort = ; // GetAllInvoiceSort | Sort Of Invoices final String search = search_example; // String | final DateTime from = 2013-10-20T19:20:30+01:00; // DateTime | final DateTime to = 2013-10-20T19:20:30+01:00; // DateTime | try { final response = api.getAllCustomerInvoices(page, limit, customerId, sort, search, from, to); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->getAllCustomerInvoices: $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] **customerId** | **num**| | **sort** | [**GetAllInvoiceSort**](.md)| Sort Of Invoices | [optional] **search** | **String**| | [optional] **from** | **DateTime**| | [optional] **to** | **DateTime**| | [optional] ### Return type [**GetAllCustomerInvoicesRes**](GetAllCustomerInvoicesRes.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) # **getAllFleets** > GetAllFleetsResponse getAllFleets(page, limit, search, sort, customerIds, from, to) Get all fleets ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num page = 8.14; // num | final num limit = 8.14; // num | final String search = search_example; // String | final GetAllCustomerSort sort = ; // GetAllCustomerSort | sort of customer final BuiltList customerIds = ; // BuiltList | customerIds of customer final DateTime from = 2013-10-20T19:20:30+01:00; // DateTime | final DateTime to = 2013-10-20T19:20:30+01:00; // DateTime | try { final response = api.getAllFleets(page, limit, search, sort, customerIds, from, to); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->getAllFleets: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page** | **num**| | [optional] [default to 1] **limit** | **num**| | [optional] [default to 10] **search** | **String**| | [optional] **sort** | [**GetAllCustomerSort**](.md)| sort of customer | [optional] **customerIds** | [**BuiltList<num>**](num.md)| customerIds of customer | [optional] **from** | **DateTime**| | [optional] **to** | **DateTime**| | [optional] ### Return type [**GetAllFleetsResponse**](GetAllFleetsResponse.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) # **getAllInvoices** > GetAllInvoicesResponse getAllInvoices() Get all invoices ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); try { final response = api.getAllInvoices(); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->getAllInvoices: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**GetAllInvoicesResponse**](GetAllInvoicesResponse.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) # **getAllLogistics** > GetAllLogisticsResponse getAllLogistics(page, limit, search, sort, status, type) Get all logistics ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); 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 GetAllLogisticsStatusEnum status = ; // GetAllLogisticsStatusEnum | final String type = type_example; // String | try { final response = api.getAllLogistics(page, limit, search, sort, status, type); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->getAllLogistics: $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** | [**GetAllLogisticsStatusEnum**](.md)| | [optional] **type** | **String**| | [optional] ### Return type [**GetAllLogisticsResponse**](GetAllLogisticsResponse.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) # **getAllTags** > GetAllOrderTagsResponse getAllTags() Get all tags ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); try { final response = api.getAllTags(); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->getAllTags: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**GetAllOrderTagsResponse**](GetAllOrderTagsResponse.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) # **getByUid** > FindOrderByUidRes getByUid(uid) ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final String uid = uid_example; // String | try { final response = api.getByUid(uid); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->getByUid: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **uid** | **String**| | ### Return type [**FindOrderByUidRes**](FindOrderByUidRes.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) # **getCartFromLink** > GetCustomerCartResponseDto getCartFromLink(link) ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final String link = link_example; // String | try { final response = api.getCartFromLink(link); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->getCartFromLink: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **link** | **String**| | ### Return type [**GetCustomerCartResponseDto**](GetCustomerCartResponseDto.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) # **getFulfillmentStatuses** > BuiltList getFulfillmentStatuses() Get all fulfillment statuses ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); try { final response = api.getFulfillmentStatuses(); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->getFulfillmentStatuses: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**BuiltList<FulfillmentStatusEntity>**](FulfillmentStatusEntity.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) # **getFulfillments** > GetAllFulfillmentsResponse getFulfillments(orderId) Get fulfilled items Get all fulfilled items grouped by statuses and digitals/physicals ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID try { final response = api.getFulfillments(orderId); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->getFulfillments: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | ### Return type [**GetAllFulfillmentsResponse**](GetAllFulfillmentsResponse.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) # **getRefundStatuses** > BuiltList getRefundStatuses() Get all refunds statuses ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); try { final response = api.getRefundStatuses(); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->getRefundStatuses: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**BuiltList<RefundStatusEntity>**](RefundStatusEntity.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) # **getReturnStatuses** > BuiltList getReturnStatuses() Get all returns statuses ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); try { final response = api.getReturnStatuses(); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->getReturnStatuses: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**BuiltList<ReturnStatusEntity>**](ReturnStatusEntity.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) # **getUnfulfilled** > GetAllUnfulfilledResponse getUnfulfilled(orderId) Get unfulfilled items Get all fulfilled items grouped by digitals/physicals ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID try { final response = api.getUnfulfilled(orderId); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->getUnfulfilled: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | ### Return type [**GetAllUnfulfilledResponse**](GetAllUnfulfilledResponse.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) # **markPaymentAsPaid** > OkRes markPaymentAsPaid(orderId) Mark an order as paid ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID try { final response = api.markPaymentAsPaid(orderId); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->markPaymentAsPaid: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | ### 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) # **refund** > OrderRefundEntity refund(orderId, orderRefundEntity) Refund items ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID final OrderRefundEntity orderRefundEntity = ; // OrderRefundEntity | try { final response = api.refund(orderId, orderRefundEntity); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->refund: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | **orderRefundEntity** | [**OrderRefundEntity**](OrderRefundEntity.md)| | ### Return type [**OrderRefundEntity**](OrderRefundEntity.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) # **returnProduct** > OrderReturnEntity returnProduct(orderId, orderReturnEntity) Return items ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID final OrderReturnEntity orderReturnEntity = ; // OrderReturnEntity | try { final response = api.returnProduct(orderId, orderReturnEntity); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->returnProduct: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | **orderReturnEntity** | [**OrderReturnEntity**](OrderReturnEntity.md)| | ### Return type [**OrderReturnEntity**](OrderReturnEntity.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) # **sendInvoice** > OkRes sendInvoice(orderId) Send Invoice ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | try { final response = api.sendInvoice(orderId); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->sendInvoice: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **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) # **updateOrderNotes** > OrderEntity updateOrderNotes(orderId, updateOrderNoteBody) Update order's notes ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID final UpdateOrderNoteBody updateOrderNoteBody = ; // UpdateOrderNoteBody | try { final response = api.updateOrderNotes(orderId, updateOrderNoteBody); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->updateOrderNotes: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | **updateOrderNoteBody** | [**UpdateOrderNoteBody**](UpdateOrderNoteBody.md)| | ### Return type [**OrderEntity**](OrderEntity.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) # **updateOrderTags** > OrderEntity updateOrderTags(orderId, updateOrderTagsBody) Update order's tags ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getCheckoutOrdersApi(); final num orderId = 8.14; // num | Order ID final UpdateOrderTagsBody updateOrderTagsBody = ; // UpdateOrderTagsBody | try { final response = api.updateOrderTags(orderId, updateOrderTagsBody); print(response); } catch on DioError (e) { print('Exception when calling CheckoutOrdersApi->updateOrderTags: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **num**| Order ID | **updateOrderTagsBody** | [**UpdateOrderTagsBody**](UpdateOrderTagsBody.md)| | ### Return type [**OrderEntity**](OrderEntity.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)