Skip to content

lferrerraventos/beezup-ruby-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
docs
docs
 
 
lib
lib
 
 
spec
spec
 
 
Gemfile
Gemfile
 
 
README.md
README.md
 
 
Rakefile
Rakefile
 
 
git_push.sh
git_push.sh
 
 
swagger_client.gemspec
swagger_client.gemspec
 
 

Repository files navigation

swagger_client

SwaggerClient - the Ruby gem for the BeezUP API

The REST API of BeezUP system ## Overview The REST APIs provide programmatic access to read and write BeezUP data. Basically, with this API you will be able to do everything like you were with your browser on https://go.beezup.com ! The main features are: - Register and manage your account - Create and manage and share your stores with your friends/co-workers. - Import your product catalog and schedule the auto importation - Search the channels your want to use - Configure your channels for your catalogs to export your product information: - cost and general settings - category and columns mappings - your will be able to create and manage your custom column - put in place exlusion filters based on simple conditions on your product data - override product values - get product vision for a channel catalog scope - Analyze and optimize your performance of your catalogs on all yours channels with different type of reportings by day, channel, category and by product. - Automatize your optimisation by using rules! - And of course... Manage your orders harvested from all your marketplaces: - Synchronize your orders in an uniformized way - Get the available actions and update the order status - ...and more! ## Authentication credentials The public API with the base path /v2/public have been put in place to give you an entry point to our system for the user registration, login and lost password. The public API does not require any credentials. We give you the some public list of values and public channels for our public commercial web site www.beezup.com. The user API with the base path /v2/user requires a token which is available on this page: https://go.beezup.com/Account/MyAccount ## Things to keep in mind ### API Rate Limits - The BeezUP REST API is limited to 100 calls/minute. ### Media type The default media type for requests and responses is application/json. Where noted, some operations support other content types. If no additional content type is mentioned for a specific operation, then the media type is application/json. ### Required content type The required and default encoding for the request and responses is UTF8. ### Required date time format All our date time are formatted in ISO 8601 format: 2014-06-24T16:25:00Z. ### Base URL The Base URL of the BeezUP API Order Management REST API conforms to the following template. https://api.beezup.com All URLs returned by the BeezUP API are relative to this base URL, and all requests to the REST API must use this base URL template. You can test our API on https://api-docs.beezup.com/swagger-ui\\ You can contact us on gitter, #BeezUP/API

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 2.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build swagger_client.gemspec

Then either install the gem locally:

gem install ./swagger_client-1.0.0.gem

(for development, run gem install --dev ./swagger_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'swagger_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:

gem 'swagger_client', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'swagger_client'

# Setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
end

api_instance = SwaggerClient::AnalyticsGlobalApi.new

begin
  #Get the Analytics API operation index
  result = api_instance.analytics_index
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling AnalyticsGlobalApi->analytics_index: #{e}"
end

Documentation for API Endpoints

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

Class Method HTTP request Description
SwaggerClient::AnalyticsGlobalApi analytics_index GET /user/analytics/ Get the Analytics API operation index
SwaggerClient::AnalyticsGlobalApi analytics_store_index GET /user/analytics/{storeId} Get the Analytics API operation index for one store
SwaggerClient::AnalyticsOptimisationsApi copy_optimisation POST /user/analytics/{storeId}/optimisations/copy Copy product optimisations between 2 channels
SwaggerClient::AnalyticsOptimisationsApi optimise POST /user/analytics/{storeId}/optimisations/{actionName} Optimise products by page
SwaggerClient::AnalyticsOptimisationsApi optimise_all POST /user/analytics/{storeId}/optimisations/all/{actionName} Optimise all products
SwaggerClient::AnalyticsOptimisationsApi optimise_by_category POST /user/analytics/{storeId}/optimisations/bycategory/{catalogCategoryId}/{actionName} Optimise products by category
SwaggerClient::AnalyticsOptimisationsApi optimise_by_channel POST /user/analytics/{storeId}/optimisations/bychannel/{channelId}/{actionName} Optimise products by channel
SwaggerClient::AnalyticsOptimisationsApi optimise_by_product POST /user/analytics/{storeId}/optimisations/byproduct/{productId}/{actionName} Optimise product
SwaggerClient::AnalyticsReportsApi delete_report_filter DELETE /user/analytics/{storeId}/reports/filters/{reportFilterId} Delete the report filter
SwaggerClient::AnalyticsReportsApi get_report_filter GET /user/analytics/{storeId}/reports/filters/{reportFilterId} Get the report filter description
SwaggerClient::AnalyticsReportsApi get_report_filters GET /user/analytics/{storeId}/reports/filters Get report filter list for the given store
SwaggerClient::AnalyticsReportsApi save_report_filter PUT /user/analytics/{storeId}/reports/filters/{reportFilterId} Save the report filter
SwaggerClient::AnalyticsRulesApi create_rule POST /user/analytics/{storeId}/rules Rule creation
SwaggerClient::AnalyticsRulesApi delete_rule DELETE /user/analytics/{storeId}/rules/{ruleId} Delete Rule
SwaggerClient::AnalyticsRulesApi disable_rule POST /user/analytics/{storeId}/rules/{ruleId}/disable Disable rule
SwaggerClient::AnalyticsRulesApi enable_rule POST /user/analytics/{storeId}/rules/{ruleId}/enable Enable rule
SwaggerClient::AnalyticsRulesApi get_rule GET /user/analytics/{storeId}/rules/{ruleId} Gets the rule
SwaggerClient::AnalyticsRulesApi get_rules GET /user/analytics/{storeId}/rules Gets the list of rules for a given store
SwaggerClient::AnalyticsRulesApi get_rules_executions GET /user/analytics/{storeId}/rules/executions Get the rules execution history
SwaggerClient::AnalyticsRulesApi move_down_rule POST /user/analytics/{storeId}/rules/{ruleId}/movedown Move the rule down
SwaggerClient::AnalyticsRulesApi move_up_rule POST /user/analytics/{storeId}/rules/{ruleId}/moveup Move the rule up
SwaggerClient::AnalyticsRulesApi run_rule POST /user/analytics/{storeId}/rules/{ruleId}/run Run rule
SwaggerClient::AnalyticsRulesApi run_rules POST /user/analytics/{storeId}/rules/run Run all rules for this store
SwaggerClient::AnalyticsRulesApi update_rule PATCH /user/analytics/{storeId}/rules/{ruleId} Update Rule
SwaggerClient::AnalyticsStatisticsApi get_store_report_by_category POST /user/analytics/{storeId}/reports/bycategory Get the report by category
SwaggerClient::AnalyticsStatisticsApi get_store_report_by_channel POST /user/analytics/{storeId}/reports/bychannel Get the report by channel
SwaggerClient::AnalyticsStatisticsApi get_store_report_by_day POST /user/analytics/{storeId}/reports/byday Get the report by day
SwaggerClient::AnalyticsStatisticsApi get_store_report_by_product POST /user/analytics/{storeId}/reports/byproduct Get the report by product
SwaggerClient::AnalyticsTrackingApi get_store_tracked_clicks GET /user/analytics/{storeId}/tracking/clicks Get the latest tracked clicks
SwaggerClient::AnalyticsTrackingApi get_store_tracked_external_orders GET /user/analytics/{storeId}/tracking/externalorders Get the latest tracked external orders
SwaggerClient::AnalyticsTrackingApi get_store_tracked_orders GET /user/analytics/{storeId}/tracking/orders Get the latest tracked orders
SwaggerClient::AnalyticsTrackingApi get_store_tracking_status GET /user/analytics/{storeId}/tracking/status Get the synchronization status of clicks and orders of a store
SwaggerClient::AnalyticsTrackingApi get_tracking_status GET /user/analytics/tracking/status Get the global synchronization status of clicks and orders
SwaggerClient::CatalogsAutoApi auto_configure_auto_import_interval POST /user/catalogs/{storeId}/autoImport/scheduling/interval Configure Auto Import Interval
SwaggerClient::CatalogsAutoApi auto_delete_auto_import DELETE /user/catalogs/{storeId}/autoImport Delete Auto Import
SwaggerClient::CatalogsAutoApi auto_get_auto_import_configuration GET /user/catalogs/{storeId}/autoImport Get the auto import configuration
SwaggerClient::CatalogsAutoApi auto_pause_auto_import POST /user/catalogs/{storeId}/autoImport/pause Pause Auto Import
SwaggerClient::CatalogsAutoApi auto_resume_auto_import POST /user/catalogs/{storeId}/autoImport/resume Resume Auto Import
SwaggerClient::CatalogsAutoApi auto_schedule_auto_import POST /user/catalogs/{storeId}/autoImport/scheduling/schedules Configure Auto Import Schedules
SwaggerClient::CatalogsAutoApi auto_start_auto_import POST /user/catalogs/{storeId}/autoImport/start Start Auto Import Manually
SwaggerClient::CatalogsAutoApi importation_activate_auto_import POST /user/catalogs/{storeId}/autoImport/activate Activate the auto importation of the last successful manual catalog importation.
SwaggerClient::CatalogsCatalogApi catalog_change_catalog_column_user_name POST /user/catalogs/{storeId}/catalogColumns/{columnId}/rename Change Catalog Column User Name
SwaggerClient::CatalogsCatalogApi catalog_change_custom_column_expression PUT /user/catalogs/{storeId}/customColumns/{columnId}/expression Change custom column expression
SwaggerClient::CatalogsCatalogApi catalog_change_custom_column_user_name POST /user/catalogs/{storeId}/customColumns/{columnId}/rename Change Custom Column User Name
SwaggerClient::CatalogsCatalogApi catalog_compute_expression POST /user/catalogs/{storeId}/customColumns/computeExpression Compute the expression for this catalog.
SwaggerClient::CatalogsCatalogApi catalog_delete_custom_column DELETE /user/catalogs/{storeId}/customColumns/{columnId} Delete custom column
SwaggerClient::CatalogsCatalogApi catalog_get_catalog_columns GET /user/catalogs/{storeId}/catalogColumns Get catalog column list
SwaggerClient::CatalogsCatalogApi catalog_get_categories GET /user/catalogs/{storeId}/categories Get category list
SwaggerClient::CatalogsCatalogApi catalog_get_custom_column_expression GET /user/catalogs/{storeId}/customColumns/{columnId}/expression Get the encrypted custom column expression
SwaggerClient::CatalogsCatalogApi catalog_get_custom_columns GET /user/catalogs/{storeId}/customColumns Get custom column list
SwaggerClient::CatalogsCatalogApi catalog_get_product_by_product_id GET /user/catalogs/{storeId}/products/{productId} Get product by ProductId
SwaggerClient::CatalogsCatalogApi catalog_get_product_by_sku GET /user/catalogs/{storeId}/products Get product by Sku
SwaggerClient::CatalogsCatalogApi catalog_get_products POST /user/catalogs/{storeId}/products/list Get product list
SwaggerClient::CatalogsCatalogApi catalog_get_random_products GET /user/catalogs/{storeId}/products/random Get random product list
SwaggerClient::CatalogsCatalogApi catalog_save_custom_column PUT /user/catalogs/{storeId}/customColumns/{columnId} Create or replace a custom column
SwaggerClient::CatalogsCatalogApi catalog_store_index GET /user/catalogs/{storeId} Get the index of the catalog API for this store
SwaggerClient::CatalogsCatalogApi importation_get_manual_update_last_input_config GET /user/catalogs/{storeId}/inputConfiguration Get the last input configuration
SwaggerClient::CatalogsGlobalApi catalog_get_beez_up_columns GET /user/catalogs/beezupColumns Get the BeezUP columns
SwaggerClient::CatalogsGlobalApi catalog_index GET /user/catalogs/ Get the index of the catalog API
SwaggerClient::CatalogsImportationCatalogInfoApi importation_configure_catalog_column POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId} Configure catalog column
SwaggerClient::CatalogsImportationCatalogInfoApi importation_delete_custom_column DELETE /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId} Delete Custom Column
SwaggerClient::CatalogsImportationCatalogInfoApi importation_get_custom_column_expression GET /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/expression Get the encrypted custom column expression in this importation
SwaggerClient::CatalogsImportationCatalogInfoApi importation_get_custom_columns GET /user/catalogs/{storeId}/importations/{executionId}/customColumns Get custom columns currently place in this importation
SwaggerClient::CatalogsImportationCatalogInfoApi importation_get_detected_catalog_columns GET /user/catalogs/{storeId}/importations/{executionId}/catalogColumns Get detected catalog columns during this importation.
SwaggerClient::CatalogsImportationCatalogInfoApi importation_get_product_sample GET /user/catalogs/{storeId}/importations/{executionId}/productSamples/{productSampleIndex} Get the product sample related to this importation with all columns (catalog and custom)
SwaggerClient::CatalogsImportationCatalogInfoApi importation_get_product_sample_custom_column_value GET /user/catalogs/{storeId}/importations/{executionId}/productSamples/{productSampleIndex}/customColumns/{columnId} Get product sample custom column value related to this importation.
SwaggerClient::CatalogsImportationCatalogInfoApi importation_ignore_column POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/ignore Ignore Column
SwaggerClient::CatalogsImportationCatalogInfoApi importation_map_catalog_column POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/map Map catalog column to a BeezUP column
SwaggerClient::CatalogsImportationCatalogInfoApi importation_map_custom_column POST /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/map Map custom column to a BeezUP column
SwaggerClient::CatalogsImportationCatalogInfoApi importation_reattend_column POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/reattend Reattend Column
SwaggerClient::CatalogsImportationCatalogInfoApi importation_save_custom_column PUT /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId} Create or replace a custom column
SwaggerClient::CatalogsImportationCatalogInfoApi importation_unmap_catalog_column POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/unmap Unmap catalog column
SwaggerClient::CatalogsImportationCatalogInfoApi importation_unmap_custom_column POST /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/unmap Unmap custom column
SwaggerClient::CatalogsImportationProcessApi importation_cancel POST /user/catalogs/{storeId}/importations/{executionId}/cancel Cancel importation
SwaggerClient::CatalogsImportationProcessApi importation_commit POST /user/catalogs/{storeId}/importations/{executionId}/commit Commit Importation
SwaggerClient::CatalogsImportationProcessApi importation_commit_columns POST /user/catalogs/{storeId}/importations/{executionId}/commitColumns Commit columns
SwaggerClient::CatalogsImportationProcessApi importation_configure_remaining_catalog_columns POST /user/catalogs/{storeId}/importations/{executionId}/configureRemainingCatalogColumns Configure remaining catalog columns
SwaggerClient::CatalogsImportationProcessApi importation_get_importation_monitoring GET /user/catalogs/{storeId}/importations/{executionId} Get the importation status
SwaggerClient::CatalogsImportationProcessApi importation_get_reportings GET /user/catalogs/{storeId}/importations Get the latest catalog importation reporting
SwaggerClient::CatalogsImportationProcessApi importation_start_manual_update POST /user/catalogs/{storeId}/importations/start Start Manual Import
SwaggerClient::CatalogsImportationProcessApi importation_technical_progression GET /user/catalogs/{storeId}/importations/{executionId}/technicalProgression Get technical progression
SwaggerClient::ChannelCatalogsCategoriesApi configure_channel_catalog_category POST /user/channelCatalogs/{channelCatalogId}/categories/configure Configure channel catalog category
SwaggerClient::ChannelCatalogsCategoriesApi disable_channel_catalog_category_mapping POST /user/channelCatalogs/{channelCatalogId}/categories/disableMapping Disable a channel catalog category mapping
SwaggerClient::ChannelCatalogsCategoriesApi get_channel_catalog_categories GET /user/channelCatalogs/{channelCatalogId}/categories Get channel catalog categories
SwaggerClient::ChannelCatalogsCategoriesApi reenable_channel_catalog_category_mapping POST /user/channelCatalogs/{channelCatalogId}/categories/reenableMapping Reenable a channel catalog category mapping
SwaggerClient::ChannelCatalogsColumnMappingsApi configure_channel_catalog_column_mappings PUT /user/channelCatalogs/{channelCatalogId}/columnMappings Configure channel catalog column mappings
SwaggerClient::ChannelCatalogsExclusionFiltersApi configure_channel_catalog_exclusion_filters PUT /user/channelCatalogs/{channelCatalogId}/exclusionFilters Configure channel catalog exclusion filters
SwaggerClient::ChannelCatalogsExclusionFiltersApi get_channel_catalog_exclusion_filter_operators GET /user/channelCatalogs/exclusionFilterOperators Get channel catalog exclusion filter operators
SwaggerClient::ChannelCatalogsExclusionFiltersApi get_channel_catalog_exclusion_filters GET /user/channelCatalogs/{channelCatalogId}/exclusionFilters Get channel catalog exclusion filters
SwaggerClient::ChannelCatalogsExportationsApi clear_channel_catalog_exportation_cache POST /user/channelCatalogs/{channelCatalogId}/exportations/cache/clear Clear the exportation cache
SwaggerClient::ChannelCatalogsExportationsApi get_channel_catalog_exportation_cache_info GET /user/channelCatalogs/{channelCatalogId}/exportations/cache Get the exportation cache information
SwaggerClient::ChannelCatalogsExportationsApi get_channel_catalog_exportation_history GET /user/channelCatalogs/{channelCatalogId}/exportations/history Get the exportation history
SwaggerClient::ChannelCatalogsGlobalApi add_channel_catalog POST /user/channelCatalogs/ Add a new channel catalog
SwaggerClient::ChannelCatalogsGlobalApi delete_channel_catalog DELETE /user/channelCatalogs/{channelCatalogId} Delete the channel catalog
SwaggerClient::ChannelCatalogsGlobalApi get_channel_catalog GET /user/channelCatalogs/{channelCatalogId} Get the channel catalog information
SwaggerClient::ChannelCatalogsGlobalApi get_channel_catalogs GET /user/channelCatalogs/ List all your current channel catalogs
SwaggerClient::ChannelCatalogsProductsApi export_channel_catalog_product_info_list POST /user/channelCatalogs/{channelCatalogId}/products/export Export channel catalog product information list
SwaggerClient::ChannelCatalogsProductsApi get_channel_catalog_product_by_channel_catalog POST /user/channelCatalogs/products Get channel catalog products related to these channel catalogs
SwaggerClient::ChannelCatalogsProductsApi get_channel_catalog_product_info GET /user/channelCatalogs/{channelCatalogId}/products/{productId} Get channel catalog product information
SwaggerClient::ChannelCatalogsProductsApi get_channel_catalog_product_info_list POST /user/channelCatalogs/{channelCatalogId}/products Get channel catalog product information list
SwaggerClient::ChannelCatalogsProductsApi get_channel_catalog_products_counters GET /user/channelCatalogs/{channelCatalogId}/products/counters Get channel catalog products' counters
SwaggerClient::ChannelCatalogsProductsOptimisationApi disable_channel_catalog_product POST /user/channelCatalogs/{channelCatalogId}/products/{productId}/disable Disable channel catalog product
SwaggerClient::ChannelCatalogsProductsOptimisationApi reenable_channel_catalog_product POST /user/channelCatalogs/{channelCatalogId}/products/{productId}/reenable Reenable channel catalog product
SwaggerClient::ChannelCatalogsProductsOverridesApi configure_channel_catalog_product_value_override_copy POST /user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides/copy Copy channel catalog product value override
SwaggerClient::ChannelCatalogsProductsOverridesApi delete_channel_catalog_product_value_override DELETE /user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides/{channelColumnId} Delete a specific channel catalog product value override
SwaggerClient::ChannelCatalogsProductsOverridesApi get_channel_catalog_product_value_override_copy GET /user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides/copy Get channel catalog product value override compatibilities status
SwaggerClient::ChannelCatalogsProductsOverridesApi override_channel_catalog_product_values PUT /user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides Override channel catalog product values
SwaggerClient::ChannelCatalogsSettingsApi configure_channel_catalog_cost_settings PUT /user/channelCatalogs/{channelCatalogId}/settings/cost Configure channel catalog cost settings
SwaggerClient::ChannelCatalogsSettingsApi configure_channel_catalog_general_settings PUT /user/channelCatalogs/{channelCatalogId}/settings/general Configure channel catalog general settings
SwaggerClient::ChannelCatalogsSettingsApi disable_channel_catalog POST /user/channelCatalogs/{channelCatalogId}/disable Disable a channel catalog
SwaggerClient::ChannelCatalogsSettingsApi enable_channel_catalog POST /user/channelCatalogs/{channelCatalogId}/enable Enable a channel catalog
SwaggerClient::ChannelsChannelsGlobalApi get_available_channels GET /user/channels/ List all available channel for this store
SwaggerClient::ChannelsChannelsGlobalApi get_channel_categories GET /user/channels/{channelId}/categories Get channel categories
SwaggerClient::ChannelsChannelsGlobalApi get_channel_columns POST /user/channels/{channelId}/columns Get channel columns
SwaggerClient::ChannelsChannelsGlobalApi get_channel_info GET /user/channels/{channelId} Get channel information
SwaggerClient::CustomerAccountApi activate_user_account POST /user/customer/account/activate Activate the user account
SwaggerClient::CustomerAccountApi change_password POST /user/customer/account/changePassword Change user password
SwaggerClient::CustomerAccountApi get_credit_card_info GET /user/customer/account/creditCardInfo Get credit card information
SwaggerClient::CustomerAccountApi get_profile_picture_info GET /user/customer/account/profilePictureInfo Get profile picture information
SwaggerClient::CustomerAccountApi get_user_account_info GET /user/customer/account Get user account information
SwaggerClient::CustomerAccountApi resend_email_activation POST /user/customer/account/resendEmailActivation Resend email activation
SwaggerClient::CustomerAccountApi save_company_info PUT /user/customer/account/companyInfo Change company information
SwaggerClient::CustomerAccountApi save_credit_card_info PUT /user/customer/account/creditCardInfo Save user credit card info
SwaggerClient::CustomerAccountApi save_personal_info PUT /user/customer/account/personalInfo Save user personal information
SwaggerClient::CustomerAccountApi save_profile_picture_info PUT /user/customer/account/profilePictureInfo Change user picture information
SwaggerClient::CustomerAlertsApi get_store_alerts GET /user/customer/stores/{storeId}/alerts Get store's alerts
SwaggerClient::CustomerAlertsApi save_store_alerts POST /user/customer/stores/{storeId}/alerts Save store alerts
SwaggerClient::CustomerContractsApi create_contract POST /user/customer/contracts Create a new contract
SwaggerClient::CustomerContractsApi delete_next_contract DELETE /user/customer/contracts/next Delete your next contract
SwaggerClient::CustomerContractsApi get_billing_periods GET /user/customer/billingPeriods Get billing periods conditions
SwaggerClient::CustomerContractsApi get_contracts GET /user/customer/contracts Get contract list
SwaggerClient::CustomerContractsApi get_offer POST /user/customer/offers Get offer pricing
SwaggerClient::CustomerContractsApi get_standard_offers GET /user/customer/offers Get all standard offers
SwaggerClient::CustomerContractsApi reactivate_current_contract POST /user/customer/contracts/current/reenableAutoRenewal Reactivate your terminated contract.
SwaggerClient::CustomerContractsApi terminate_current_contract POST /user/customer/contracts/current/disableAutoRenewal Schedule termination of your current contract at the end of the commitment.
SwaggerClient::CustomerFriendsApi get_friend_info GET /user/customer/friends/{userId} Get friend information
SwaggerClient::CustomerGlobalApi get_customer_index GET /user/customer/ The index of all operations and LOV
SwaggerClient::CustomerInvoicesApi get_invoices GET /user/customer/invoices Get all your invoices
SwaggerClient::CustomerRightsApi get_rights GET /user/customer/stores/{storeId}/rights Get store's rights
SwaggerClient::CustomerSecurityApi logout POST /user/customer/security/logout Log out the current user from go2
SwaggerClient::CustomerSharesApi delete_store_share DELETE /user/customer/stores/{storeId}/shares/{userId} Delete a share of a store to another user
SwaggerClient::CustomerSharesApi get_store_shares GET /user/customer/stores/{storeId}/shares Get shares related to this store
SwaggerClient::CustomerSharesApi share_store POST /user/customer/stores/{storeId}/shares Share a store to another user
SwaggerClient::CustomerStoresApi create_store POST /user/customer/stores Create a new store
SwaggerClient::CustomerStoresApi delete_store DELETE /user/customer/stores/{storeId} Delete a store
SwaggerClient::CustomerStoresApi get_store GET /user/customer/stores/{storeId} Get store's information
SwaggerClient::CustomerStoresApi get_stores GET /user/customer/stores Get store list
SwaggerClient::CustomerStoresApi update_store PATCH /user/customer/stores/{storeId} Update some store's information.
SwaggerClient::MarketplacesChannelCatalogsGlobalApi get_marketplace_channel_catalogs GET /user/marketplaces/channelcatalogs/ Get your marketplace channel catalog list
SwaggerClient::MarketplacesChannelCatalogsPublicationsApi get_publications GET /user/marketplaces/channelcatalogs/publications/{marketplaceTechnicalCode}/{accountId}/history Fetch the publication history for an account, sorted by descending start date
SwaggerClient::MarketplacesChannelCatalogsSettingsApi get_channel_catalog_marketplace_properties GET /user/marketplaces/channelcatalogs/{channelCatalogId}/properties Get the marketplace properties for a channel catalog
SwaggerClient::MarketplacesChannelCatalogsSettingsApi get_channel_catalog_marketplace_settings GET /user/marketplaces/channelcatalogs/{channelCatalogId}/settings Get the marketplace settings for a channel catalog
SwaggerClient::MarketplacesChannelCatalogsSettingsApi set_channel_catalog_marketplace_settings POST /user/marketplaces/channelcatalogs/{channelCatalogId}/settings Save new marketplace settings for a channel catalog
SwaggerClient::MarketplacesOrdersAutoTransitionsApi configure_automatic_transitions POST /user/marketplaces/orders/automaticTransitions Configure new or existing automatic Order status transition
SwaggerClient::MarketplacesOrdersAutoTransitionsApi get_automatic_transitions GET /user/marketplaces/orders/automaticTransitions Get list of configured automatic Order status transitions
SwaggerClient::MarketplacesOrdersBatchesApi change_order_list POST /user/marketplaces/orders/batches/changeOrders/{changeOrderType} Send a batch of operations to change your marketplace Order information (accept, ship, etc.)
SwaggerClient::MarketplacesOrdersBatchesApi clear_merchant_order_info_list POST /user/marketplaces/orders/batches/clearMerchantOrderInfos Send a batch of operations to clear an Order's merchant information (max 100 items per call)
SwaggerClient::MarketplacesOrdersBatchesApi set_merchant_order_info_list POST /user/marketplaces/orders/batches/setMerchantOrderInfos Send a batch of operations to set an Order's merchant information (max 100 items per call)
SwaggerClient::MarketplacesOrdersExportsApi export_orders POST /user/marketplaces/orders/exportations Request a new Order report exportation to be generated
SwaggerClient::MarketplacesOrdersExportsApi get_order_exportations GET /user/marketplaces/orders/exportations Get a paginated list of Order report exportations
SwaggerClient::MarketplacesOrdersGlobalApi get_marketplace_accounts_synchronization GET /user/marketplaces/orders/status Get current synchronization status between your marketplaces and BeezUP accounts
SwaggerClient::MarketplacesOrdersGlobalApi get_order_index GET /user/marketplaces/orders/ Get all actions you can do on the order API
SwaggerClient::MarketplacesOrdersGlobalApi harvest_all POST /user/marketplaces/orders/harvest Send harvest request to all your marketplaces
SwaggerClient::MarketplacesOrdersListApi get_order_list_full POST /user/marketplaces/orders/list/full Get a paginated list of all Orders with all Order and Order Item(s) properties
SwaggerClient::MarketplacesOrdersListApi get_order_list_light POST /user/marketplaces/orders/list/light Get a paginated list of all Orders without details
SwaggerClient::MarketplacesOrdersOrderApi change_order POST /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/{changeOrderType} Change your marketplace Order Information (accept, ship, etc.)
SwaggerClient::MarketplacesOrdersOrderApi clear_merchant_order_info POST /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/clearMerchantOrderInfo Clear an Order's merchant information
SwaggerClient::MarketplacesOrdersOrderApi get_order GET /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId} Get full Order and Order Item(s) properties
SwaggerClient::MarketplacesOrdersOrderApi get_order_history GET /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/history Get an Order's harvest and change history
SwaggerClient::MarketplacesOrdersOrderApi harvest_order POST /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/harvest Send harvest request for a single Order
SwaggerClient::MarketplacesOrdersOrderApi head_order HEAD /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId} Get the meta information about the order (ETag, Last-Modified)
SwaggerClient::MarketplacesOrdersOrderApi set_merchant_order_info POST /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/setMerchantOrderInfo Set an Order's merchant information
SwaggerClient::MarketplacesOrdersSubscriptionsApi activate_subscription POST /user/marketplaces/orders/subscriptions/{id}/activate Activate a subscription to the orders
SwaggerClient::MarketplacesOrdersSubscriptionsApi create_subscription POST /user/marketplaces/orders/subscriptions Creates a subscription to the orders
SwaggerClient::MarketplacesOrdersSubscriptionsApi deactivate_subscription POST /user/marketplaces/orders/subscriptions/{id}/deactivate Deactivate a subscription to the orders
SwaggerClient::MarketplacesOrdersSubscriptionsApi delete_subscription DELETE /user/marketplaces/orders/subscriptions/{id} Delete a subscription to the orders
SwaggerClient::MarketplacesOrdersSubscriptionsApi get_subscription GET /user/marketplaces/orders/subscriptions/{id} Get a subscription to the orders
SwaggerClient::MarketplacesOrdersSubscriptionsApi get_subscription_list GET /user/marketplaces/orders/subscriptions Get the subscription list
SwaggerClient::PublicChannelsPublicChannelsApi get_channels GET /public/channels/{countryIsoCode} The channel list for one country
SwaggerClient::PublicChannelsPublicChannelsApi get_channels_index GET /public/channels/ Get public channel index
SwaggerClient::PublicListOfValuesLOVApi get_public_list_of_values GET /public/lov/{listName} Get the list of values related to this list name
SwaggerClient::PublicListOfValuesLOVApi get_public_lov_index GET /public/lov/ Get all list names
SwaggerClient::PublicSecuritySecurityApi login POST /public/security/login Login
SwaggerClient::PublicSecuritySecurityApi lost_password POST /public/security/lostpassword Lost password
SwaggerClient::PublicSecuritySecurityApi register POST /public/security/register User Registration
SwaggerClient::UserListOfValuesLOVApi get_user_list_of_values GET /user/lov/{listName} Get the list of values related to this list name
SwaggerClient::UserListOfValuesLOVApi get_user_lov_index GET /user/lov/ Get all list names

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

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages