Skip to content

BeezUP/api-csharp-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

89 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

IO.Swagger - the C# library for the BeezUP API

This API will allow you to create your account and to get your tokens. \ If you lost your password, you have an operation to get it back.

This C# SDK is automatically generated by the Swagger Codegen project:

  • API version: 2.0
  • SDK version: 1.0.0
  • Build package: io.swagger.codegen.languages.CSharpClientCodegen

Frameworks supported

  • .NET 4.0 or later
  • Windows Phone 7.1 (Mango)

Dependencies

The DLLs included in the package may not be the latest version. We recommend using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out IO.Swagger.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Getting Started

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");

            var apiInstance = new BeezUPApi();
            var emailActivationId = emailActivationId_example;  // string | The email activation id received by email.

            try
            {
                // Activate the user account
                apiInstance.ActivateUserAccount(emailActivationId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BeezUPApi.ActivateUserAccount: " + e.Message );
            }
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.beezup.com/v2

Class Method HTTP request Description
BeezUPApi ActivateUserAccount POST /user/customer/account/activate Activate the user account
BeezUPApi AutoConfigureAutoImportInterval POST /user/catalogs/{storeId}/autoImport/scheduling/interval Configure Auto Import Interval
BeezUPApi AutoDeleteAutoImport DELETE /user/catalogs/{storeId}/autoImport Delete Auto Import
BeezUPApi AutoGetAutoImportConfiguration GET /user/catalogs/{storeId}/autoImport Get the auto import configuration
BeezUPApi AutoPauseAutoImport POST /user/catalogs/{storeId}/autoImport/pause Pause Auto Import
BeezUPApi AutoResumeAutoImport POST /user/catalogs/{storeId}/autoImport/resume Resume Auto Import
BeezUPApi AutoScheduleAutoImport POST /user/catalogs/{storeId}/autoImport/scheduling/schedules Configure Auto Import Schedules
BeezUPApi AutoStartAutoImport POST /user/catalogs/{storeId}/autoImport/start Start Auto Import Manually
BeezUPApi CatalogChangeCatalogColumnUserName POST /user/catalogs/{storeId}/catalogColumns/{columnId}/rename Change Catalog Column User Name
BeezUPApi CatalogChangeCustomColumnExpression PUT /user/catalogs/{storeId}/customColumns/{columnId}/expression Change custom column expression
BeezUPApi CatalogChangeCustomColumnUserName POST /user/catalogs/{storeId}/customColumns/{columnId}/rename Change Custom Column User Name
BeezUPApi CatalogComputeExpression POST /user/catalogs/{storeId}/customColumns/computeExpression Compute the expression for this catalog.
BeezUPApi CatalogDeleteCustomColumn DELETE /user/catalogs/{storeId}/customColumns/{columnId} Delete custom column
BeezUPApi CatalogGetBeezUPColumns GET /user/catalogs/beezupColumns Get the BeezUP columns
BeezUPApi CatalogGetCatalogColumns GET /user/catalogs/{storeId}/catalogColumns Get catalog column list
BeezUPApi CatalogGetCategories GET /user/catalogs/{storeId}/categories Get category list
BeezUPApi CatalogGetCustomColumnExpression GET /user/catalogs/{storeId}/customColumns/{columnId}/expression Get the encrypted custom column expression
BeezUPApi CatalogGetCustomColumns GET /user/catalogs/{storeId}/customColumns Get custom column list
BeezUPApi CatalogGetProduct GET /user/catalogs/{storeId}/products/{productId} Get product
BeezUPApi CatalogGetProducts POST /user/catalogs/{storeId}/products Get product list
BeezUPApi CatalogGetRandomProducts GET /user/catalogs/{storeId}/products/random Get random product list
BeezUPApi CatalogSaveCustomColumn PUT /user/catalogs/{storeId}/customColumns/{columnId} Create or replace a custom column
BeezUPApi ChangeOrder POST /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/{changeOrderType} Change your marketplace Order Information (accept, ship, etc.)
BeezUPApi ChangeOrderList POST /user/marketplaces/orders/batches/changeOrders/{changeOrderType} Send a batch of operations to change your marketplace Order information (accept, ship, etc.)
BeezUPApi ChangePassword POST /user/customer/account/changePassword Change user password
BeezUPApi ClearMerchantOrderInfo POST /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/clearMerchantOrderInfo Clear an Order's merchant information
BeezUPApi ClearMerchantOrderInfoList POST /user/marketplaces/orders/batches/clearMerchantOrderInfos Send a batch of operations to clear an Order's merchant information
BeezUPApi ConfigureAutomaticTransitions POST /user/marketplaces/orders/automaticTransitions Configure new or existing automatic Order status transition
BeezUPApi ConfigureChannelCatalogCostSettings POST /user/channelCatalogs/{channelCatalogId}/settings/cost Disable a channel catalog
BeezUPApi ConfigureChannelCatalogExclusionFilters PUT /user/channelCatalogs/{channelCatalogId}/exclusionFilters Configure channel catalog exclusion filters
BeezUPApi ConfigureChannelCatalogGeneralSettings POST /user/channelCatalogs/{channelCatalogId}/settings/general Disable a channel catalog
BeezUPApi CreateChannelCatalog POST /user/channelCatalogs/ Create a new channel catalog
BeezUPApi CreateContract POST /user/customer/contracts Create a new contract
BeezUPApi CreateRule POST /user/analytics/{storeId}/rules Rule creation
BeezUPApi CreateStore POST /user/customer/stores Create a new store
BeezUPApi DeleteChannelCatalog DELETE /user/channelCatalogs/{channelCatalogId} Delete the channel catalog
BeezUPApi DeleteChannelCatalogExportationCache DELETE /user/channelCatalogs/{channelCatalogId}/exportations/cache Delete the exportation cache
BeezUPApi DeleteChannelCatalogProductValueOverride DELETE /user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides/{channelColumnId} Delete a specific channel catalog product value override
BeezUPApi DeleteNextContract DELETE /user/customer/contracts/next Delete your next contract
BeezUPApi DeleteReportFilter DELETE /user/analytics/{storeId}/reports/filters/{reportFilterId} Delete the report filter
BeezUPApi DeleteRule DELETE /user/analytics/{storeId}/rules/{ruleId} Delete Rule
BeezUPApi DeleteShare DELETE /user/customer/stores/{storeId}/shares/{userId} Delete a share to another user
BeezUPApi DeleteStore DELETE /user/customer/stores/{storeId} Delete a store
BeezUPApi DisableChannelCatalog POST /user/channelCatalogs/{channelCatalogId}/disable Disable a channel catalog
BeezUPApi DisableChannelCatalogProduct POST /user/channelCatalogs/{channelCatalogId}/products/{productId}/disable Disable channel catalog product
BeezUPApi DisableRule POST /user/analytics/{storeId}/rules/{ruleId}/disable Disable rule
BeezUPApi EnableChannelCatalog POST /user/channelCatalogs/{channelCatalogId}/enable Enable a channel catalog
BeezUPApi EnableRule POST /user/analytics/{storeId}/rules/{ruleId}/enable Enable rule
BeezUPApi ExportOrders POST /user/marketplaces/orders/exportations Request a new Order report exportation to be generated
BeezUPApi ExportStoreReportByCategory POST /user/analytics/{storeId}/reports/bycategory/export Export the report by category
BeezUPApi ExportStoreReportByChannel POST /user/analytics/{storeId}/reports/bychannel/export Export the report by channel
BeezUPApi ExportStoreReportByProduct POST /user/analytics/{storeId}/reports/byproduct/export Export the report by product
BeezUPApi GetAutomaticTransitions GET /user/marketplaces/orders/automaticTransitions Get list of configured automatic Order status transitions
BeezUPApi GetAvailableChannels GET /user/channels/ List all available channel for this store
BeezUPApi GetBillingPeriods GET /user/customer/billingPeriods Get billing periods conditions
BeezUPApi GetChannelCatalog GET /user/channelCatalogs/{channelCatalogId} Get the channel catalog information
BeezUPApi GetChannelCatalogCategories GET /user/channelCatalogs/{channelCatalogId}/categoryMappings Get channel catalog categories
BeezUPApi GetChannelCatalogExclusionFilterOperators GET /user/channelCatalogs/exclusionFilterOperators Get channel catalog exclusion filter operators
BeezUPApi GetChannelCatalogExportationCacheInfo GET /user/channelCatalogs/{channelCatalogId}/exportations/cache Get the exportation cache information
BeezUPApi GetChannelCatalogExportationHistory GET /user/channelCatalogs/{channelCatalogId}/exportations/history Get the exportation history
BeezUPApi GetChannelCatalogMarketplaceProperties GET /user/marketplaces/channelcatalogs/{channelCatalogId}/properties Get the marketplace properties for a channel catalog
BeezUPApi GetChannelCatalogMarketplaceSettings GET /user/marketplaces/channelcatalogs/{channelCatalogId}/settings Get the marketplace settings for a channel catalog
BeezUPApi GetChannelCatalogProductByChannelCatalog POST /user/channelCatalogs/products/{productId} Get channel catalog products related to these channel catalogs
BeezUPApi GetChannelCatalogProductInfo GET /user/channelCatalogs/{channelCatalogId}/products/{productId} Get channel catalog product information
BeezUPApi GetChannelCatalogProductInfoList POST /user/channelCatalogs/{channelCatalogId}/products Get channel catalog product information list
BeezUPApi GetChannelCatalogs GET /user/channelCatalogs/ List all your current channel catalogs
BeezUPApi GetChannelCategories GET /user/channels/{channelId}/categories Get channel categories
BeezUPApi GetChannelColumns POST /user/channels/{channelId}/columns Get channel columns
BeezUPApi GetChannelInfo GET /user/channels/{channelId} Get channel information
BeezUPApi GetChannels GET /public/channels/{countryIsoCode} The channel list for one country
BeezUPApi GetChannelsIndex GET /public/channels/ Get public channel index
BeezUPApi GetContracts GET /user/customer/contracts Get contract list
BeezUPApi GetCreditCardInfo GET /user/customer/account/creditCardInfo Get credit card information
BeezUPApi GetFriendInfo GET /user/customer/friends/{userId} Get friend information
BeezUPApi GetInvoices GET /user/customer/invoices Get all your invoices
BeezUPApi GetMarketplaceAccountStores GET /user/marketplaces/channelcatalogs/ Get you marketplace channel catalog list
BeezUPApi GetMarketplaceAccountsSynchronization GET /user/marketplaces/orders/status Get current synchronization status between your marketplaces and BeezUP accounts
BeezUPApi GetOffer POST /user/customer/offers Get offer pricing
BeezUPApi GetOrder GET /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId} Get full Order and Order Item(s) properties
BeezUPApi GetOrderExportations GET /user/marketplaces/orders/exportations Get a paginated list of Order report exportations
BeezUPApi GetOrderHistory GET /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/history Get an Order's harvest and change history
BeezUPApi GetOrderIndex GET /user/marketplaces/orders/ Get all actions you can do on the order API
BeezUPApi GetOrderListFull POST /user/marketplaces/orders/list/full Get a paginated list of all Orders with all Order and Order Item(s) properties
BeezUPApi GetOrderListLight POST /user/marketplaces/orders/list/light Get a paginated list of all Orders without details
BeezUPApi GetProfilePictureInfo GET /user/customer/account/profilePictureInfo Get profile picture information
BeezUPApi GetPublicListOfValues GET /public/lov/{listName} Get the list of values related to this list name
BeezUPApi GetPublicLovIndex GET /public/lov/ Get all list names
BeezUPApi GetPublications GET /user/marketplaces/channelcatalogs/publications/{marketplaceTechnicalCode}/{accountId}/history Fetch the publication history for an account, sorted by descending start date
BeezUPApi GetReportFilter GET /user/analytics/{storeId}/reports/filters/{reportFilterId} Get the report filter description
BeezUPApi GetReportFilters GET /user/analytics/{storeId}/reports/filters Get report filter list for the given store
BeezUPApi GetRights POST /user/customer/stores/{storeId}/rights Get store's rights
BeezUPApi GetRule GET /user/analytics/{storeId}/rules/{ruleId} Gets the rule
BeezUPApi GetRules GET /user/analytics/{storeId}/rules Gets the list of rules for a given store
BeezUPApi GetRulesExecutions GET /user/analytics/{storeId}/rules/executions Get the rules execution history
BeezUPApi GetShares GET /user/customer/stores/{storeId}/shares Get shares related to this store
BeezUPApi GetStandardOffers GET /user/customer/offers Get all standard offers
BeezUPApi GetStore GET /user/customer/stores/{storeId} Get store's information
BeezUPApi GetStoreAlerts GET /user/customer/stores/{storeId}/alerts Get store's alerts
BeezUPApi GetStoreReportByCategory POST /user/analytics/{storeId}/reports/bycategory Get the report by category
BeezUPApi GetStoreReportByChannel POST /user/analytics/{storeId}/reports/bychannel Get the report by channel
BeezUPApi GetStoreReportByDay POST /user/analytics/{storeId}/reports/byday Get the report by day
BeezUPApi GetStoreReportByDayExport POST /user/analytics/{storeId}/reports/byday/export Get the report by day
BeezUPApi GetStoreReportByProduct POST /user/analytics/{storeId}/reports/byproduct Get the report by product
BeezUPApi GetStoreTrackedClicks GET /user/analytics/{storeId}/tracking/clicks Get the latest clicks tracked
BeezUPApi GetStoreTrackedExternalOrders GET /user/analytics/{storeId}/tracking/externalorders Get the latest external orders tracked
BeezUPApi GetStoreTrackedOrders GET /user/analytics/{storeId}/tracking/orders Get the latest orders tracked
BeezUPApi GetStoreTrackingStatus GET /user/analytics/{storeId}/tracking/status Get store tracking synchronization status
BeezUPApi GetStores GET /user/customer/stores Get store list
BeezUPApi GetTrackingStatus GET /user/analytics/tracking/status Display the synchronization status of the clicks and orders
BeezUPApi GetUserAccountInfo GET /user/customer/account Get user account information
BeezUPApi GetUserListOfValues GET /user/lov/{listName} Get the list of values related to this list name
BeezUPApi GetUserLovIndex GET /user/lov/ Get all list names
BeezUPApi HarvestAll POST /user/marketplaces/orders/harvest Send harvest request to all your marketplaces
BeezUPApi HarvestOrder POST /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/harvest Send harvest request for a single Order
BeezUPApi HeadOrder HEAD /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId} Get the meta information about the order (ETag, Last-Modified)
BeezUPApi ImportationActivateAutoImport POST /user/catalogs/{storeId}/autoImport Activate the auto importation of the last successful manual catalog importation.
BeezUPApi ImportationCancel DELETE /user/catalogs/{storeId}/importations/{executionId} Cancel importation
BeezUPApi ImportationCommit POST /user/catalogs/{storeId}/importations/{executionId}/commit Commit Importation
BeezUPApi ImportationCommitColumns POST /user/catalogs/{storeId}/importations/{executionId}/commitColumns Commit columns
BeezUPApi ImportationConfigureCatalogColumn POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId} Configure catalog column
BeezUPApi ImportationConfigureRemainingCatalogColumns POST /user/catalogs/{storeId}/importations/{executionId}/configureRemainingCatalogColumns Configure remaining catalog columns
BeezUPApi ImportationDeleteCustomColumn DELETE /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId} Delete Custom Column
BeezUPApi ImportationGetCustomColumnExpression GET /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/expression Get the encrypted custom column expression in this importation
BeezUPApi ImportationGetCustomColumns GET /user/catalogs/{storeId}/importations/{executionId}/customColumns Get custom columns currently place in this importation
BeezUPApi ImportationGetDetectedCatalogColumns GET /user/catalogs/{storeId}/importations/{executionId}/catalogColumns Get detected catalog columns during this importation.
BeezUPApi ImportationGetImportationMonitoring GET /user/catalogs/{storeId}/importations/{executionId} Get the importation status
BeezUPApi ImportationGetManualUpdateLastInputConfig GET /user/catalogs/{storeId}/inputConfiguration Get the last input configuration
BeezUPApi ImportationGetProductSample GET /user/catalogs/{storeId}/importations/{executionId}/productSamples/{productSampleIndex} Get the product sample related to this importation with all columns (catalog and custom)
BeezUPApi ImportationGetProductSampleCustomColumnValue GET /user/catalogs/{storeId}/importations/{executionId}/productSamples/{productSampleIndex}/customColumns/{columnId} Get product sample custom column value related to this importation.
BeezUPApi ImportationGetReportings GET /user/catalogs/{storeId}/importations Get the latest catalog importation reporting
BeezUPApi ImportationIgnoreColumn POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/ignore Ignore Column
BeezUPApi ImportationMapCatalogColumn POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/map Map catalog column to a BeezUP column
BeezUPApi ImportationMapCustomColumn POST /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/map Map custom column to a BeezUP column
BeezUPApi ImportationReattendColumn POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/reattend Reattend Column
BeezUPApi ImportationSaveCustomColumn PUT /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId} Create or replace a custom column
BeezUPApi ImportationStartManualUpdate POST /user/catalogs/{storeId}/importations Start Manual Import
BeezUPApi ImportationTechnicalProgression GET /user/catalogs/{storeId}/importations/{executionId}/technicalProgression Get technical progression
BeezUPApi ImportationUnmapCatalogColumn POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/unmap Unmap catalog column
BeezUPApi ImportationUnmapCustomColumn POST /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/unmap Unmap custom column
BeezUPApi Login POST /public/security/login Login
BeezUPApi Logout POST /user/customer/security/logout Log out the current user from go2
BeezUPApi LostPassword POST /public/security/lostpassword Lost password
BeezUPApi MapChannelCatalogCategory POST /user/channelCatalogs/{channelCatalogId}/categoryMappings/map Map channel catalog category
BeezUPApi MapChannelCatalogColumns PUT /user/channelCatalogs/{channelCatalogId}/columnMappings Configure channel catalog column mappings
BeezUPApi MoveDownRule POST /user/analytics/{storeId}/rules/{ruleId}/movedown Move the rule down
BeezUPApi MoveUpRule POST /user/analytics/{storeId}/rules/{ruleId}/moveup Move the rule up
BeezUPApi Optimise POST /user/analytics/{storeId}/optimisations/{actionName} Optimise products
BeezUPApi OptimiseByCategory POST /user/analytics/{storeId}/optimisations/bycategory/{catalogCategoryId}/{actionName} Optimise products's category
BeezUPApi OptimiseByChannel POST /user/analytics/{storeId}/optimisations/bychannel/{channelId}/{actionName} Optimise products's category
BeezUPApi OptimiseByProduct POST /user/analytics/{storeId}/optimisations/byproduct/{productId}/{actionName} Optimise products
BeezUPApi OverrideChannelCatalogProductOverrides PUT /user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides Override channel catalog product values
BeezUPApi ReactivateCurrentContract POST /user/customer/contracts/current/reenableAutoRenewal Reactivate your terminated contract.
BeezUPApi ReenableChannelCatalogProduct POST /user/channelCatalogs/{channelCatalogId}/products/{productId}/reenable Reenable channel catalog product
BeezUPApi Register POST /public/security/register User Registration
BeezUPApi ResendEmailActivation POST /user/customer/account/resendEmailActivation Resend email activation
BeezUPApi RunRule POST /user/analytics/{storeId}/rules/{ruleId}/run Run rule
BeezUPApi RunRules POST /user/analytics/{storeId}/rules/run Run all rules for this store
BeezUPApi SaveCompanyInfo PUT /user/customer/account/companyInfo Change company information
BeezUPApi SaveCreditCardInfo PUT /user/customer/account/creditCardInfo Save user credit card info
BeezUPApi SavePersonalInfo PUT /user/customer/account/personalInfo Save user personal information
BeezUPApi SaveProfilePictureInfo PUT /user/customer/account/profilePictureInfo Change user picture information
BeezUPApi SaveReportFilter PUT /user/analytics/{storeId}/reports/filters/{reportFilterId} Save the report filter
BeezUPApi SaveStoreAlert PUT /user/customer/stores/{storeId}/alerts/{alertId} Save store alert
BeezUPApi SetChannelCatalogMarketplaceSettings POST /user/marketplaces/channelcatalogs/{channelCatalogId}/settings Save new marketplace settings for a channel catalog
BeezUPApi SetMerchantOrderInfo POST /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/setMerchantOrderInfo Set an Order's merchant information
BeezUPApi SetMerchantOrderInfoList POST /user/marketplaces/orders/batches/setMerchantOrderInfos Send a batch of operations to set an Order's merchant information
BeezUPApi Share POST /user/customer/stores/{storeId}/shares Share a store to another user
BeezUPApi TerminateCurrentContract POST /user/customer/contracts/current/disableAutoRenewal Schedule termination of your current contract at the end of the commitment.
BeezUPApi UnmapChannelCatalogCategory POST /user/channelCatalogs/{channelCatalogId}/categoryMappings/unmap Unmap channel catalog category
BeezUPApi UpdateRule PATCH /user/analytics/{storeId}/rules/{ruleId} Update Rule
BeezUPApi UpdateStore PATCH /user/customer/stores/{storeId} Update some store's information.
BeezUPApi UserCustomerGet GET /user/customer/ The index of all operations and LOV

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key
  • API key parameter name: Ocp-Apim-Subscription-Key
  • Location: HTTP header

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages