core_loyalty_ecommerce_service (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.10.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:
  core_loyalty_ecommerce_service: 1.0.0

Github

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

dependencies:
  core_loyalty_ecommerce_service:
    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:
  core_loyalty_ecommerce_service:
    path: /path/to/core_loyalty_ecommerce_service

Getting Started

Please follow the installation procedure and then run the following:

import 'package:core_loyalty_ecommerce_service/core_loyalty_ecommerce_service.dart';


final api = CoreLoyaltyEcommerceService().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 http://localhost

Class Method HTTP request Description
AppCashbackApi appCashbackControllerCreate POST /v2/app-cashback Create AppCashback
AppCashbackApi appCashbackControllerDelete DELETE /v2/app-cashback/{id} Delete AppCashback
AppCashbackApi appCashbackControllerGet GET /v2/app-cashback/{id} Get AppCashback
AppCashbackApi appCashbackControllerList GET /v2/app-cashback List Apps Cashback
AppCashbackApi appCashbackControllerUpdate PATCH /v2/app-cashback/{id} Update AppCashback
AppEcommerceApi appEcommerceControllerCreate POST /v2/app-ecommerce Create App Ecommerce
AppEcommerceApi appEcommerceControllerDelete DELETE /v2/app-ecommerce/{id} Delete App Ecommerce
AppEcommerceApi appEcommerceControllerGet GET /v2/app-ecommerce Get App Ecommerce
AppEcommerceApi appEcommerceControllerUpdate PATCH /v2/app-ecommerce/{id} Update App Ecommerce
AppFreeShippingApi appFreeShippingControllerCreate POST /v2/free-shipping/apps Create appFreeShipping
AppFreeShippingApi appFreeShippingControllerDelete DELETE /v2/free-shipping/apps/{id} Delete app free shipping
AppFreeShippingApi appFreeShippingControllerEnable PATCH /v2/free-shipping/apps/enable/{id} Enable appFreeShipping
AppFreeShippingApi appFreeShippingControllerGetById GET /v2/free-shipping/apps/{id} Get appFreeShipping by id
AppFreeShippingApi appFreeShippingControllerList GET /v2/free-shipping/apps List appFreeShippings
AppFreeShippingApi appFreeShippingControllerUpdate PATCH /v2/free-shipping/apps/{id} Update appFreeShipping
CampaignNotificationApi campaignNotificationControllerCreate POST /v2/ecommerce/campaign-notification Create Campaign Notification
CampaignNotificationApi campaignNotificationControllerDelete DELETE /v2/ecommerce/campaign-notification/{id} Delete Campaign Notification
CampaignNotificationApi campaignNotificationControllerGet GET /v2/ecommerce/campaign-notification/{id} Get Campaign Notification
CampaignNotificationApi campaignNotificationControllerListByCampaign GET /v2/ecommerce/campaign-notification/campaign/{campaignId} List Campaign Notifications
CampaignNotificationApi campaignNotificationControllerUpdate PATCH /v2/ecommerce/campaign-notification/{id} Update Campaign Notification
CampaignUsersApi loyaltyCampaignUserControllerApplyCoupon POST /v2/loyalty-campaign-user/coupon/apply Apply coupon on user cart
CampaignUsersApi loyaltyCampaignUserControllerClaimExtraPoints POST /v2/loyalty-campaign-user/points/claim Claim extra points
CampaignUsersApi loyaltyCampaignUserControllerCreate POST /v2/loyalty-campaign-user Create Loyalty Campaign User
CampaignUsersApi loyaltyCampaignUserControllerGet GET /v2/loyalty-campaign-user/campaign/{loyaltyCampaignId}/users/{userId} Get Campaign User
CampaignUsersApi loyaltyCampaignUserControllerRedeem POST /v2/loyalty-campaign-user/redeem Redeem points for loyalty campaign
CampaignsApi campaignsControllerCreate POST /v2/ecommerce/campaigns Create Campaign
CampaignsApi campaignsControllerDelete DELETE /v2/ecommerce/campaigns/{id} Delete Campaigns
CampaignsApi campaignsControllerGenerateReport POST /v2/ecommerce/campaigns/export/report send Campaign Report
CampaignsApi campaignsControllerGet GET /v2/ecommerce/campaigns/{id} Get Campaign By Id
CampaignsApi campaignsControllerGetByBoosterId GET /v2/ecommerce/campaigns/booster/{id} Get Campaign By Booster Id
CampaignsApi campaignsControllerGetTargetCount GET /v2/ecommerce/campaigns/targets/count
CampaignsApi campaignsControllerList GET /v2/ecommerce/campaigns List Campaigns
CampaignsApi campaignsControllerPrepareBeneficiaries PUT /v2/ecommerce/campaigns/{id}/prepare Prepare the campaign beneficiaries
CampaignsApi campaignsControllerSubmit PUT /v2/ecommerce/campaigns/{id}/submit Submit the campaign
CampaignsApi campaignsControllerUpdate PATCH /v2/ecommerce/campaigns/{id} Update Campaigns
CampaignsApi campaignsControllerUploadCSV POST /v2/ecommerce/campaigns/{id}/upload-csv Upload campaign user CSV
CartApi cartControllerCreateOrUpdate POST /v2/ecommerce/cart Create Or Update Cart
CashbackCampaignUsersApi campaignUsersControllerGetActiveCampaignUserReferee GET /v2/ecommerce/campaign-users/referee Get active campaign user referee
CashbackCampaignUsersApi campaignUsersControllerGetCampaignUser GET /v2/ecommerce/campaign-users/{id} Get Campaign user for specific campaign
CashbackCampaignUsersApi campaignUsersControllerGetCampaignUsers GET /v2/ecommerce/campaign-users Get active campaign users by authorized user
CashbackPopupsApi cashbackPopupControllerGetCashbackPopup GET /v2/ecommerce/app-cashback-popups Get By UTM Campaign
CategoriesApi categoriesControllerGetCategory GET /v2/categories/{id} Get Category by id
CategoriesApi categoriesControllerListCategories GET /v2/categories List Product Categories
DefaultApi alertsControllerIndex GET /metrics
DefaultApi appControllerHealthCheck GET /health-check
DiscountCashbackValidatorApi discountCashbackValidatorControllerCreateDiscountCashbackValidator POST /v2/ecommerce/discount-validator Create Discount codes
DiscountCashbackValidatorApi discountCashbackValidatorControllerUpdateDiscountCashbackValidator PUT /v2/ecommerce/discount-validator/{id} Update Discount codes
DiscountCashbackValidatorApi discountCashbackValidatorControllerUploadCSV POST /v2/ecommerce/discount-validator/upload-csv Upload Discount codes CSV
DiscountsApi discountsControllerExportData POST /v2/ecommerce/discounts/export export discounts data
DiscountsApi discountsControllerGet GET /v2/ecommerce/discounts/discount/{id} Get Discount By Id
DiscountsApi discountsControllerGetCashbackSummary GET /v2/ecommerce/discounts/summary Cashback Summary For User
DiscountsApi discountsControllerGetCashbackSummaryByUser GET /v2/ecommerce/discounts/user/summary Cashback Summary by user
DiscountsApi discountsControllerGetTotals GET /v2/ecommerce/discounts/totals Get discounts totals for analytics
DiscountsApi discountsControllerList GET /v2/ecommerce/discounts/user List Discounts
DiscountsApi discountsControllerListByAdmin GET /v2/ecommerce/discounts List Discounts
DiscountsApi discountsControllerUpdateDiscount PUT /v2/ecommerce/discounts/{discountId} Update Discount By Id
DiscountsApi manualDiscountsControllerApplyDiscountValue PUT /v2/ecommerce/discounts/manual/apply Apply discount to items
DiscountsApi manualDiscountsControllerClearCartDiscounts PUT /v2/ecommerce/discounts/manual/clear Clear cart discounts
DiscountsApi manualDiscountsControllerGetDiscountValue GET /v2/ecommerce/discounts/manual/value Get discount value
FreeShippingCodesApi freeShippingCodesControllerGetById GET /v2/free-shipping/codes/{id} get free shipping code by id
FreeShippingCodesApi freeShippingCodesControllerListByUser GET /v2/free-shipping/codes list free shipping codes for user
FreeShippingCodesApi freeShippingCodesControllerRedeem POST /v2/free-shipping/codes redeem free shipping code
FreeShippingCodesApi freeShippingCodesControllerUpdate PATCH /v2/free-shipping/codes/{id} update free shipping code
LiveSellingApi liveSellingControllerCreate POST /v2/live-selling Create Live Selling
LiveSellingApi liveSellingControllerDelete DELETE /v2/live-selling/{id} Delete Live Selling
LiveSellingApi liveSellingControllerGet GET /v2/live-selling/{id} Get Live Selling
LiveSellingApi liveSellingControllerList GET /v2/live-selling List Live Selling
LiveSellingApi liveSellingControllerUpdate PATCH /v2/live-selling/{id} Update Live Selling
LoyaltyCampaignApi loyaltyCampaignControllerCreate POST /v2/loyalty-campaign Create loyalty Campaign
LoyaltyCampaignApi loyaltyCampaignControllerGet GET /v2/loyalty-campaign List all loyalty Campaigns
LoyaltyCampaignApi loyaltyCampaignControllerGetCurrentCampaign GET /v2/loyalty-campaign/current Get the current loyalty campaign
OfflineOrdersApi offlineOrdersControllerCreate POST /v2/offline-orders/{userId} Create offline order
OfflineOrdersApi offlineOrdersControllerList GET /v2/offline-orders List Offline Orders
OfflineOrdersApi offlineOrdersControllerListPopulated GET /v2/offline-orders/populated list Populated Purchases Details
OfflineOrdersApi offlineOrdersControllerReturnOfflineOrder DELETE /v2/offline-orders/{id}/return return Offline order by id
OfflineOrdersApi offlineOrdersControllerSendOTP POST /v2/offline-orders/otp Create Offline Order OTP request
OfflineOrdersApi offlineOrdersControllerUpdate PATCH /v2/offline-orders/{id} Update Purchase
OfflineOrdersApi offlineOrdersControllerVerify PUT /v2/offline-orders/otp/verify Verify Offline order OTP request
OnlineOrdersApi ordersControllerCreate POST /v2/orders Create Order
OnlineOrdersApi ordersControllerDelete DELETE /v2/orders/{id} Delete Order
OnlineOrdersApi ordersControllerExportData POST /v2/orders/export export orders data
OnlineOrdersApi ordersControllerHookPerAgent POST /v2/orders/{agent}/hook
OnlineOrdersApi ordersControllerHooks POST /v2/orders/apps/{appId}/hooks
OnlineOrdersApi ordersControllerList GET /v2/orders List Orders
OrdersHubApi genericOrdersControllerCreate POST /v2/ecommerce/orders-hub Create order
OrdersHubApi genericOrdersControllerGet GET /v2/ecommerce/orders-hub/{id} Get Order
OrdersHubApi genericOrdersControllerGetChartsData GET /v2/ecommerce/orders-hub/analytics/charts
OrdersHubApi genericOrdersControllerGetOverviewData GET /v2/ecommerce/orders-hub/analytics/overview
OrdersHubApi genericOrdersControllerGetSalesStatistics GET /v2/ecommerce/orders-hub/analytics/statistics
OrdersHubApi genericOrdersControllerUploadCSV POST /v2/ecommerce/orders-hub/upload-csv
ProductsApi productsControllerGet GET /v2/products/{id} Get Product
ProductsApi productsControllerGetByExternalId GET /v2/products/external-id/{externalId} Get Product By ExternalId
ProductsApi productsControllerList GET /v2/products List Products
ProductsApi productsControllerPopular GET /v2/products/popular Popular Products
ProductsApi productsControllerPopularCategories GET /v2/products/category/popular Popular Products Categories
ProductsApi productsControllerPopulate GET /v2/products/populate
ProductsApi productsControllerSearch GET /v2/products/search Products Search
ProductsApi productsControllerUpdate POST /v2/products/apps/{appId}/hooks
ProductsApi productsControllerUpdateByExternalId PUT /v2/products/external-id/{externalId}/reload Update Product By ExternalId
ProspectDiscountApi prospectDiscountControllerIgnore GET /v2/ecommerce/prospect-discount Update Prospect Discount ignored Status
PurchasesApi appPurchasesControllerCreate POST /v2/purchases Create App Purchase
PurchasesApi appPurchasesControllerDelete DELETE /v2/purchases/{id} Delete App Purchase
PurchasesApi appPurchasesControllerGet GET /v2/purchases Get App Purchase
PurchasesApi appPurchasesControllerUpdate PATCH /v2/purchases/{id} Update App Purchase
RedeemAPIApi redeemApiControllerCreateArchiveApiConfig POST /integrations/redeem-api/discount/delete This endpoint allows you to save an API endpoint for creating discount codes.
RedeemAPIApi redeemApiControllerCreateRedeemApiConfig POST /integrations/redeem-api/discount/create This endpoint allows you to save an API endpoint for creating discount codes.
RedeemAPIApi redeemApiControllerGet GET /integrations/redeem-api Get Redeem API
RedeemAPIApi redeemApiControllerUpdate PATCH /integrations/redeem-api/{id} Update Redeem API
SalesRepGroupsApi salesRepGroupsControllerCreate POST /v2/ecommerce/sales-reps-groups create sales reps group
SalesRepGroupsApi salesRepGroupsControllerGetById GET /v2/ecommerce/sales-reps-groups/{id} get sales reps groups
SalesRepGroupsApi salesRepGroupsControllerList GET /v2/ecommerce/sales-reps-groups list sales reps groups
SalesRepGroupsApi salesRepGroupsControllerUpdate PATCH /v2/ecommerce/sales-reps-groups/{id} Update salesRep group
SalesRepsApi salesRepsControllerAdd POST /v2/ecommerce/sales-reps/add add a sales rep to the group
SalesRepsApi salesRepsControllerCreate POST /v2/ecommerce/sales-reps Create sales rep
SalesRepsApi salesRepsControllerDelete DELETE /v2/ecommerce/sales-reps/{id} Delete sales rep
SalesRepsApi salesRepsControllerGet GET /v2/ecommerce/sales-reps/{id} get sales reps by id
SalesRepsApi salesRepsControllerList GET /v2/ecommerce/sales-reps list sales reps of an admin
SalesRepsApi salesRepsControllerListAll GET /v2/ecommerce/sales-reps/list/by-groups list sales reps by group
SalesRepsApi salesRepsControllerListByAdminId GET /v2/ecommerce/sales-reps/group/{adminId} Get sales rep admin group
SalesRepsApi salesRepsControllerUpdate PUT /v2/ecommerce/sales-reps/{id} Update sales rep
TotvsBonusApi totvsBonusControllerCancel POST /v2/totvs/bonuses/cancel return order
TotvsBonusApi totvsBonusControllerFinalize POST /v2/totvs/bonuses/finalize finalize order with bonus
TotvsBonusApi totvsBonusControllerGetApplicableBonus POST /v2/totvs/bonuses/bonus Get applicable discount
TotvsIdentificationApi identificationControllerAuthenticateIdentifiedUser POST /v2/totvs/identifications/authentication Authenticate totvs user - validate otp
TotvsIdentificationApi identificationControllerGetIdentificationForms GET /v2/totvs/identifications/forms Get totvs identification forms
TotvsIdentificationApi identificationControllerIdentifyUser POST /v2/totvs/identifications/identification Identify totvs user - send otp
TotvsOrderApi totvsCampaignControllerGetCampaign POST /v2/totvs/campaign Get totvs campaign
TotvsOrderApi totvsOrdersControllerOrder POST /v2/totvs/order Create totvs order
TotvsPartnerApi totvsPartnerControllerCreatePartner POST /v2/totvs/partner Create totvs parnter
TotvsPartnerApi totvsPartnerControllerGetPartner POST /v2/totvs/partner/get Get totvs parnter
UserFreeShippingApi userFreeShippingControllerGetActiveUserFreeShipping GET /v2/free-shipping/users Get current user free shipping
UserFreeShippingApi userFreeShippingControllerListByUser GET /v2/free-shipping/users/all List user free shipping
UserOrdersHubApi userOrdersControllerGetTotalByUser GET /v2/ecommerce/orders-hub/user/totals Get order totals by users
WelcomeGiftApi welcomeGiftControllerCreate POST /v2/ecommerce/welcome-gift create welcome gift configuration
WelcomeGiftApi welcomeGiftControllerCreateUserWelcomeGift POST /v2/ecommerce/welcome-gift/discount create welcome gift discount
WelcomeGiftApi welcomeGiftControllerGetByApp GET /v2/ecommerce/welcome-gift get welcome gift configuration by app
WelcomeGiftApi welcomeGiftControllerUpdate PATCH /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

Libraries

core_loyalty_ecommerce_service