coretava_ecommerce_apis 1.0.3

SDKdartflutter
Platformandroidioswindowslinuxmacosweb

Coretava Ecommerce Apis

coretava_ecommerce_apis (EXPERIMENTAL)

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  coretava_ecommerce_apis: 1.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  coretava_ecommerce_apis:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  coretava_ecommerce_apis:
    path: /path/to/coretava_ecommerce_apis

Getting Started

Please follow the installation procedure and then run the following:

import 'package:coretava_ecommerce_apis/coretava_ecommerce_apis.dart';


final api = CoretavaEcommerceApis().getAppCashbackApi();
final String gamixAppId = gamixAppId_example; // String | 
final CashbackCreateRequest cashbackCreateRequest = ; // CashbackCreateRequest | 

try {
    final response = await api.appCashbackControllerCreate(gamixAppId, cashbackCreateRequest);
    print(response);
} catch on DioException (e) {
    print("Exception when calling AppCashbackApi->appCashbackControllerCreate: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://api.coretava.com

ClassMethodHTTP requestDescription
AppCashbackApiappCashbackControllerCreatePOST /v2/app-cashbackCreate AppCashback
AppCashbackApiappCashbackControllerDeleteDELETE /v2/app-cashback/{id}Delete AppCashback
AppCashbackApiappCashbackControllerGetGET /v2/app-cashback/{id}Get AppCashback
AppCashbackApiappCashbackControllerListGET /v2/app-cashbackList Apps Cashback
AppCashbackApiappCashbackControllerUpdatePATCH /v2/app-cashback/{id}Update AppCashback
AppEcommerceApiappEcommerceControllerCreatePOST /v2/app-ecommerceCreate App Ecommerce
AppEcommerceApiappEcommerceControllerDeleteDELETE /v2/app-ecommerce/{id}Delete App Ecommerce
AppEcommerceApiappEcommerceControllerGetGET /v2/app-ecommerceGet App Ecommerce
AppEcommerceApiappEcommerceControllerUpdatePATCH /v2/app-ecommerce/{id}Update App Ecommerce
AppFreeShippingApiappFreeShippingControllerCreatePOST /v2/free-shipping/appsCreate appFreeShipping
AppFreeShippingApiappFreeShippingControllerDeleteDELETE /v2/free-shipping/apps/{id}Delete app free shipping
AppFreeShippingApiappFreeShippingControllerEnablePATCH /v2/free-shipping/apps/enable/{id}Enable appFreeShipping
AppFreeShippingApiappFreeShippingControllerGetByIdGET /v2/free-shipping/apps/{id}Get appFreeShipping by id
AppFreeShippingApiappFreeShippingControllerListGET /v2/free-shipping/appsList appFreeShippings
AppFreeShippingApiappFreeShippingControllerUpdatePATCH /v2/free-shipping/apps/{id}Update appFreeShipping
CampaignNotificationApicampaignNotificationControllerCreatePOST /v2/ecommerce/campaign-notificationCreate Campaign Notification
CampaignNotificationApicampaignNotificationControllerDeleteDELETE /v2/ecommerce/campaign-notification/{id}Delete Campaign Notification
CampaignNotificationApicampaignNotificationControllerGetGET /v2/ecommerce/campaign-notification/{id}Get Campaign Notification
CampaignNotificationApicampaignNotificationControllerListByCampaignGET /v2/ecommerce/campaign-notification/campaign/{campaignId}List Campaign Notifications
CampaignNotificationApicampaignNotificationControllerUpdatePATCH /v2/ecommerce/campaign-notification/{id}Update Campaign Notification
CampaignsApicampaignsControllerCreatePOST /v2/ecommerce/campaignsCreate Campaign
CampaignsApicampaignsControllerDeleteDELETE /v2/ecommerce/campaigns/{id}Delete Campaigns
CampaignsApicampaignsControllerGenerateReportPOST /v2/ecommerce/campaigns/export/reportsend Campaign Report
CampaignsApicampaignsControllerGetGET /v2/ecommerce/campaigns/{id}Get Campaign By Id
CampaignsApicampaignsControllerGetByBoosterIdGET /v2/ecommerce/campaigns/booster/{id}Get Campaign By Booster Id
CampaignsApicampaignsControllerGetTargetCountGET /v2/ecommerce/campaigns/targets/count
CampaignsApicampaignsControllerListGET /v2/ecommerce/campaignsList Campaigns
CampaignsApicampaignsControllerSubmitPUT /v2/ecommerce/campaigns/{id}/submitSubmit the campaign
CampaignsApicampaignsControllerUpdatePATCH /v2/ecommerce/campaigns/{id}Update Campaigns
CampaignsApicampaignsControllerUploadCSVPOST /v2/ecommerce/campaigns/{id}/upload-csvUpload campaign user CSV
CartApicartControllerCompletePATCH /v2/ecommerce/cart/completeComplete Cart
CartApicartControllerCreateOrUpdatePOST /v2/ecommerce/cartCreate Or Update Cart
CartApicartControllerDeleteDELETE /v2/ecommerce/cart/{id}Delete Cart
CartApicartControllerGenerateReportPOST /v2/ecommerce/cart/export/reportsend Abandoned Cart Report
CashbackCampaignUsersApicampaignUsersControllerGetActiveCampaignUserRefereeGET /v2/ecommerce/campaign-users/refereeGet active campaign user referee
CashbackCampaignUsersApicampaignUsersControllerGetCampaignUserGET /v2/ecommerce/campaign-users/{id}Get Campaign user for specific campaign
CashbackCampaignUsersApicampaignUsersControllerGetCampaignUsersGET /v2/ecommerce/campaign-usersGet active campaign users by authorized user
CashbackPopupsApicashbackPopupControllerGetCashbackPopupGET /v2/ecommerce/app-cashback-popupsGet By UTM Campaign
CategoriesApicategoriesControllerGetCategoryGET /v2/categories/{id}Get Category by id
CategoriesApicategoriesControllerListCategoriesGET /v2/categoriesList Product Categories
DefaultApialertsControllerIndexGET /metrics
DefaultApiappControllerHealthCheckGET /health-check
DiscountCashbackValidatorApidiscountCashbackValidatorControllerCreateDiscountCashbackValidatorPOST /v2/ecommerce/discount-validatorCreate Discount codes
DiscountCashbackValidatorApidiscountCashbackValidatorControllerUpdateDiscountCashbackValidatorPUT /v2/ecommerce/discount-validator/{id}Update Discount codes
DiscountCashbackValidatorApidiscountCashbackValidatorControllerUploadCSVPOST /v2/ecommerce/discount-validator/upload-csvUpload Discount codes CSV
DiscountsApidiscountsControllerExportDataPOST /v2/ecommerce/discounts/exportexport discounts data
DiscountsApidiscountsControllerGetGET /v2/ecommerce/discounts/discount/{id}Get Discount By Id
DiscountsApidiscountsControllerGetCashbackSummaryGET /v2/ecommerce/discounts/summaryCashback Summary For User
DiscountsApidiscountsControllerGetCashbackSummaryByUserGET /v2/ecommerce/discounts/user/summaryCashback Summary by user
DiscountsApidiscountsControllerGetTotalsGET /v2/ecommerce/discounts/totalsGet discounts totals for analytics
DiscountsApidiscountsControllerListGET /v2/ecommerce/discounts/userList Discounts
DiscountsApidiscountsControllerListByAdminGET /v2/ecommerce/discountsList Discounts
DiscountsApidiscountsControllerUpdateDiscountPUT /v2/ecommerce/discounts/{discountId}Update Discount By Id
DiscountsApimanualDiscountsControllerApplyPUT /v2/ecommerce/discounts/manual/applyApply discount to items
DiscountsApimanualDiscountsControllerClearPUT /v2/ecommerce/discounts/manual/clearClear cart discounts
FreeShippingCodesApifreeShippingCodesControllerGetByIdGET /v2/free-shipping/codes/{id}get free shipping code by id
FreeShippingCodesApifreeShippingCodesControllerListByUserGET /v2/free-shipping/codeslist free shipping codes for user
FreeShippingCodesApifreeShippingCodesControllerRedeemPOST /v2/free-shipping/codesredeem free shipping code
FreeShippingCodesApifreeShippingCodesControllerUpdatePATCH /v2/free-shipping/codes/{id}update free shipping code
LiveSellingApiliveSellingControllerCreatePOST /v2/live-sellingCreate Live Selling
LiveSellingApiliveSellingControllerDeleteDELETE /v2/live-selling/{id}Delete Live Selling
LiveSellingApiliveSellingControllerGetGET /v2/live-selling/{id}Get Live Selling
LiveSellingApiliveSellingControllerListGET /v2/live-sellingList Live Selling
LiveSellingApiliveSellingControllerUpdatePATCH /v2/live-selling/{id}Update Live Selling
OfflineOrdersApiofflineOrdersControllerCreatePOST /v2/offline-orders/{userId}Create offline order
OfflineOrdersApiofflineOrdersControllerListGET /v2/offline-ordersList Offline Orders
OfflineOrdersApiofflineOrdersControllerListPopulatedGET /v2/offline-orders/populatedlist Populated Purchases Details
OfflineOrdersApiofflineOrdersControllerReturnOfflineOrderDELETE /v2/offline-orders/{id}/returnreturn Offline order by id
OfflineOrdersApiofflineOrdersControllerSendOTPPOST /v2/offline-orders/otpCreate Offline Order OTP request
OfflineOrdersApiofflineOrdersControllerUpdatePATCH /v2/offline-orders/{id}Update Purchase
OfflineOrdersApiofflineOrdersControllerVerifyPUT /v2/offline-orders/otp/verifyVerify Offline order OTP request
OnlineOrdersApiordersControllerCreatePOST /v2/ordersCreate Order
OnlineOrdersApiordersControllerDeleteDELETE /v2/orders/{id}Delete Order
OnlineOrdersApiordersControllerExportDataPOST /v2/orders/exportexport orders data
OnlineOrdersApiordersControllerHookPerAgentPOST /v2/orders/{agent}/hook
OnlineOrdersApiordersControllerHooksPOST /v2/orders/apps/{appId}/hooks
OnlineOrdersApiordersControllerListGET /v2/ordersList Orders
OrdersHubApigenericOrdersControllerCreatePOST /v2/ecommerce/orders-hubCreate order
OrdersHubApigenericOrdersControllerGetGET /v2/ecommerce/orders-hub/{id}Get Order
OrdersHubApigenericOrdersControllerGetChartsDataGET /v2/ecommerce/orders-hub/analytics/charts
OrdersHubApigenericOrdersControllerGetCustomerDetailsGET /v2/ecommerce/orders-hub/customer/{customerId}Get customer
OrdersHubApigenericOrdersControllerGetOverviewDataGET /v2/ecommerce/orders-hub/analytics/overview
OrdersHubApigenericOrdersControllerGetSalesStatisticsGET /v2/ecommerce/orders-hub/analytics/statistics
OrdersHubApigenericOrdersControllerUploadCSVPOST /v2/ecommerce/orders-hub/upload-csv
ProductsApiproductsControllerGetGET /v2/products/{id}Get Product
ProductsApiproductsControllerGetByExternalIdGET /v2/products/external-id/{externalId}Get Product By ExternalId
ProductsApiproductsControllerListGET /v2/productsList Products
ProductsApiproductsControllerPopularGET /v2/products/popularPopular Products
ProductsApiproductsControllerPopularCategoriesGET /v2/products/category/popularPopular Products Categories
ProductsApiproductsControllerSearchGET /v2/products/searchProducts Search
ProductsApiproductsControllerUpdatePOST /v2/products/apps/{appId}/hooks
ProductsApiproductsControllerUpdateByExternalIdPUT /v2/products/external-id/{externalId}/reloadUpdate Product By ExternalId
ProspectDiscountApiprospectDiscountControllerIgnoreGET /v2/ecommerce/prospect-discountUpdate Prospect Discount ignored Status
PurchasesApiappPurchasesControllerCreatePOST /v2/purchasesCreate App Purchase
PurchasesApiappPurchasesControllerDeleteDELETE /v2/purchases/{id}Delete App Purchase
PurchasesApiappPurchasesControllerGetGET /v2/purchasesGet App Purchase
PurchasesApiappPurchasesControllerUpdatePATCH /v2/purchases/{id}Update App Purchase
RedeemAPIApiredeemApiControllerCreateArchiveApiConfigPOST /v2/ecommerce/integrations/redeem-api/discount/deleteThis endpoint allows you to save an API endpoint for creating discount codes.
RedeemAPIApiredeemApiControllerCreatePromotionApiConfigPOST /v2/ecommerce/integrations/redeem-api/promotionThis endpoint allows you to save an API endpoint for creating promotions.
RedeemAPIApiredeemApiControllerCreateRedeemApiConfigPOST /v2/ecommerce/integrations/redeem-api/discount/createThis endpoint allows you to save an API endpoint for creating discount codes.
RedeemAPIApiredeemApiControllerGetGET /v2/ecommerce/integrations/redeem-apiGet Redeem API
RedeemAPIApiredeemApiControllerUpdatePATCH /v2/ecommerce/integrations/redeem-api/{id}Update Redeem API
SalesRepGroupsApisalesRepGroupsControllerCreatePOST /v2/ecommerce/sales-reps-groupscreate sales reps group
SalesRepGroupsApisalesRepGroupsControllerGetByIdGET /v2/ecommerce/sales-reps-groups/{id}get sales reps groups
SalesRepGroupsApisalesRepGroupsControllerListGET /v2/ecommerce/sales-reps-groupslist sales reps groups
SalesRepGroupsApisalesRepGroupsControllerUpdatePATCH /v2/ecommerce/sales-reps-groups/{id}Update salesRep group
SalesRepsApisalesRepsControllerAddPOST /v2/ecommerce/sales-reps/addadd a sales rep to the group
SalesRepsApisalesRepsControllerCreatePOST /v2/ecommerce/sales-repsCreate sales rep
SalesRepsApisalesRepsControllerDeleteDELETE /v2/ecommerce/sales-reps/{id}Delete sales rep
SalesRepsApisalesRepsControllerGetGET /v2/ecommerce/sales-reps/{id}get sales reps by id
SalesRepsApisalesRepsControllerListGET /v2/ecommerce/sales-repslist sales reps of an admin
SalesRepsApisalesRepsControllerListAllGET /v2/ecommerce/sales-reps/list/by-groupslist sales reps by group
SalesRepsApisalesRepsControllerListByAdminIdGET /v2/ecommerce/sales-reps/group/{adminId}Get sales rep admin group
SalesRepsApisalesRepsControllerUpdatePUT /v2/ecommerce/sales-reps/{id}Update sales rep
TotvsBonusApitotvsBonusControllerCancelPOST /v2/totvs/bonuses/cancelreturn order
TotvsBonusApitotvsBonusControllerFinalizePOST /v2/totvs/bonuses/finalizefinalize order with bonus
TotvsBonusApitotvsBonusControllerGetApplicableBonusPOST /v2/totvs/bonuses/bonusGet applicable discount
TotvsIdentificationApiidentificationControllerAuthenticateIdentifiedUserPOST /v2/totvs/identifications/authenticationAuthenticate totvs user - validate otp
TotvsIdentificationApiidentificationControllerGetIdentificationFormsGET /v2/totvs/identifications/formsGet totvs identification forms
TotvsIdentificationApiidentificationControllerIdentifyUserPOST /v2/totvs/identifications/identificationIdentify totvs user - send otp
TotvsOrderApitotvsCampaignControllerGetCampaignPOST /v2/totvs/campaignGet totvs campaign
TotvsOrderApitotvsOrdersControllerOrderPOST /v2/totvs/orderCreate totvs order
TotvsPartnerApitotvsPartnerControllerCreatePartnerPOST /v2/totvs/partnerCreate totvs parnter
TotvsPartnerApitotvsPartnerControllerGetPartnerPOST /v2/totvs/partner/getGet totvs parnter
UserFreeShippingApiuserFreeShippingControllerGetActiveUserFreeShippingGET /v2/free-shipping/usersGet current user free shipping
UserFreeShippingApiuserFreeShippingControllerListByUserGET /v2/free-shipping/users/allList user free shipping
UserOrdersHubApiuserOrdersControllerGetTotalByUserGET /v2/ecommerce/orders-hub/user/totalsGet order totals by users
WelcomeGiftApiwelcomeGiftControllerCreatePOST /v2/ecommerce/welcome-giftcreate welcome gift configuration
WelcomeGiftApiwelcomeGiftControllerCreateUserWelcomeGiftPOST /v2/ecommerce/welcome-gift/discountcreate welcome gift discount
WelcomeGiftApiwelcomeGiftControllerGetByAppGET /v2/ecommerce/welcome-giftget welcome gift configuration by app
WelcomeGiftApiwelcomeGiftControllerUpdatePATCH /v2/ecommerce/welcome-gift/{id}update welcome gift configuration

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

serviceAccountHeader

  • Type: API key
  • API key parameter name: x-coretava-access-token
  • Location: HTTP header

totvsHeader

  • Type: API key
  • API key parameter name: authorizationcode
  • Location: HTTP header

adminToken

  • Type: HTTP Bearer Token authentication (Bearer)

userToken

  • Type: HTTP Bearer Token authentication (Bearer)

serviceToken

  • Type: HTTP Bearer Token authentication (Bearer)

Author