Download the PHP package beezup/api-php-client without Composer

On this page you can find all versions of the php package beezup/api-php-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of beezup/api-php-client

Informations about the package api-php-client

SwaggerClient-php

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:

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 PHP package is automatically generated by the Swagger Codegen project:

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

Then run composer install

Manual Installation

Download the files and include autoload.php:

Tests

To run the unit tests:

Getting Started

Please follow the installation procedure and then run the following:

Documentation for API Endpoints

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

Class Method HTTP request Description
CatalogsAutoApi autoConfigureAutoImportInterval POST /user/catalogs/{storeId}/autoImport/scheduling/interval Configure Auto Import Interval
CatalogsAutoApi autoDeleteAutoImport DELETE /user/catalogs/{storeId}/autoImport Delete Auto Import
CatalogsAutoApi autoGetAutoImportConfiguration GET /user/catalogs/{storeId}/autoImport Get the auto import configuration
CatalogsAutoApi autoPauseAutoImport POST /user/catalogs/{storeId}/autoImport/pause Pause Auto Import
CatalogsAutoApi autoResumeAutoImport POST /user/catalogs/{storeId}/autoImport/resume Resume Auto Import
CatalogsAutoApi autoScheduleAutoImport POST /user/catalogs/{storeId}/autoImport/scheduling/schedules Configure Auto Import Schedules
CatalogsAutoApi autoStartAutoImport POST /user/catalogs/{storeId}/autoImport/start Start Auto Import Manually
CatalogsAutoApi importationActivateAutoImport POST /user/catalogs/{storeId}/autoImport/activate Activate the auto importation of the last successful manual catalog importation.
CatalogsCatalogApi catalogChangeCatalogColumnUserName POST /user/catalogs/{storeId}/catalogColumns/{columnId}/rename Change Catalog Column User Name
CatalogsCatalogApi catalogChangeCustomColumnExpression PUT /user/catalogs/{storeId}/customColumns/{columnId}/expression Change custom column expression
CatalogsCatalogApi catalogChangeCustomColumnUserName POST /user/catalogs/{storeId}/customColumns/{columnId}/rename Change Custom Column User Name
CatalogsCatalogApi catalogComputeExpression POST /user/catalogs/{storeId}/customColumns/computeExpression Compute the expression for this catalog.
CatalogsCatalogApi catalogDeleteCustomColumn DELETE /user/catalogs/{storeId}/customColumns/{columnId} Delete custom column
CatalogsCatalogApi catalogGetCatalogColumns GET /user/catalogs/{storeId}/catalogColumns Get catalog column list
CatalogsCatalogApi catalogGetCategories GET /user/catalogs/{storeId}/categories Get category list
CatalogsCatalogApi catalogGetCustomColumnExpression GET /user/catalogs/{storeId}/customColumns/{columnId}/expression Get the encrypted custom column expression
CatalogsCatalogApi catalogGetCustomColumns GET /user/catalogs/{storeId}/customColumns Get custom column list
CatalogsCatalogApi catalogGetProductByProductId GET /user/catalogs/{storeId}/products/{productId} Get product by ProductId
CatalogsCatalogApi catalogGetProductBySku GET /user/catalogs/{storeId}/products Get product by Sku
CatalogsCatalogApi catalogGetProducts POST /user/catalogs/{storeId}/products/list Get product list
CatalogsCatalogApi catalogGetRandomProducts GET /user/catalogs/{storeId}/products/random Get random product list
CatalogsCatalogApi catalogSaveCustomColumn PUT /user/catalogs/{storeId}/customColumns/{columnId} Create or replace a custom column
CatalogsCatalogApi catalogStoreIndex GET /user/catalogs/{storeId} Get the index of the catalog API for this store
CatalogsCatalogApi importationGetManualUpdateLastInputConfig GET /user/catalogs/{storeId}/inputConfiguration Get the last input configuration
CatalogsGlobalApi catalogGetBeezUPColumns GET /user/catalogs/beezupColumns Get the BeezUP columns
CatalogsGlobalApi catalogIndex GET /user/catalogs/ Get the index of the catalog API
CatalogsImportationCatalogInfoApi importationConfigureCatalogColumn POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId} Configure catalog column
CatalogsImportationCatalogInfoApi importationDeleteCustomColumn DELETE /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId} Delete Custom Column
CatalogsImportationCatalogInfoApi importationGetCustomColumnExpression GET /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/expression Get the encrypted custom column expression in this importation
CatalogsImportationCatalogInfoApi importationGetCustomColumns GET /user/catalogs/{storeId}/importations/{executionId}/customColumns Get custom columns currently place in this importation
CatalogsImportationCatalogInfoApi importationGetDetectedCatalogColumns GET /user/catalogs/{storeId}/importations/{executionId}/catalogColumns Get detected catalog columns during this importation.
CatalogsImportationCatalogInfoApi importationGetProductSample GET /user/catalogs/{storeId}/importations/{executionId}/productSamples/{productSampleIndex} Get the product sample related to this importation with all columns (catalog and custom)
CatalogsImportationCatalogInfoApi importationGetProductSampleCustomColumnValue GET /user/catalogs/{storeId}/importations/{executionId}/productSamples/{productSampleIndex}/customColumns/{columnId} Get product sample custom column value related to this importation.
CatalogsImportationCatalogInfoApi importationIgnoreColumn POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/ignore Ignore Column
CatalogsImportationCatalogInfoApi importationMapCatalogColumn POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/map Map catalog column to a BeezUP column
CatalogsImportationCatalogInfoApi importationMapCustomColumn POST /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/map Map custom column to a BeezUP column
CatalogsImportationCatalogInfoApi importationReattendColumn POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/reattend Reattend Column
CatalogsImportationCatalogInfoApi importationSaveCustomColumn PUT /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId} Create or replace a custom column
CatalogsImportationCatalogInfoApi importationUnmapCatalogColumn POST /user/catalogs/{storeId}/importations/{executionId}/catalogColumns/{columnId}/unmap Unmap catalog column
CatalogsImportationCatalogInfoApi importationUnmapCustomColumn POST /user/catalogs/{storeId}/importations/{executionId}/customColumns/{columnId}/unmap Unmap custom column
CatalogsImportationProcessApi importationCancel POST /user/catalogs/{storeId}/importations/{executionId}/cancel Cancel importation
CatalogsImportationProcessApi importationCommit POST /user/catalogs/{storeId}/importations/{executionId}/commit Commit Importation
CatalogsImportationProcessApi importationCommitColumns POST /user/catalogs/{storeId}/importations/{executionId}/commitColumns Commit columns
CatalogsImportationProcessApi importationConfigureRemainingCatalogColumns POST /user/catalogs/{storeId}/importations/{executionId}/configureRemainingCatalogColumns Configure remaining catalog columns
CatalogsImportationProcessApi importationGetImportationMonitoring GET /user/catalogs/{storeId}/importations/{executionId} Get the importation status
CatalogsImportationProcessApi importationGetReportings GET /user/catalogs/{storeId}/importations Get the latest catalog importation reporting
CatalogsImportationProcessApi importationStartManualUpdate POST /user/catalogs/{storeId}/importations/start Start Manual Import
CatalogsImportationProcessApi importationTechnicalProgression GET /user/catalogs/{storeId}/importations/{executionId}/technicalProgression Get technical progression
ChannelCatalogsCategoriesApi configureChannelCatalogCategory POST /user/channelCatalogs/{channelCatalogId}/categories/configure Configure channel catalog category
ChannelCatalogsCategoriesApi disableChannelCatalogCategoryMapping POST /user/channelCatalogs/{channelCatalogId}/categories/disableMapping Disable a channel catalog category mapping
ChannelCatalogsCategoriesApi getChannelCatalogCategories GET /user/channelCatalogs/{channelCatalogId}/categories Get channel catalog categories
ChannelCatalogsCategoriesApi reenableChannelCatalogCategoryMapping POST /user/channelCatalogs/{channelCatalogId}/categories/reenableMapping Reenable a channel catalog category mapping
ChannelCatalogsColumnMappingsApi configureChannelCatalogColumnMappings PUT /user/channelCatalogs/{channelCatalogId}/columnMappings Configure channel catalog column mappings
ChannelCatalogsExclusionFiltersApi configureChannelCatalogExclusionFilters PUT /user/channelCatalogs/{channelCatalogId}/exclusionFilters Configure channel catalog exclusion filters
ChannelCatalogsExclusionFiltersApi getChannelCatalogExclusionFilterOperators GET /user/channelCatalogs/exclusionFilterOperators Get channel catalog exclusion filter operators
ChannelCatalogsExclusionFiltersApi getChannelCatalogExclusionFilters GET /user/channelCatalogs/{channelCatalogId}/exclusionFilters Get channel catalog exclusion filters
ChannelCatalogsExportationsApi clearChannelCatalogExportationCache POST /user/channelCatalogs/{channelCatalogId}/exportations/cache/clear Clear the exportation cache
ChannelCatalogsExportationsApi getChannelCatalogExportationCacheInfo GET /user/channelCatalogs/{channelCatalogId}/exportations/cache Get the exportation cache information
ChannelCatalogsExportationsApi getChannelCatalogExportationHistory GET /user/channelCatalogs/{channelCatalogId}/exportations/history Get the exportation history
ChannelCatalogsGlobalApi addChannelCatalog POST /user/channelCatalogs/ Add a new channel catalog
ChannelCatalogsGlobalApi deleteChannelCatalog DELETE /user/channelCatalogs/{channelCatalogId} Delete the channel catalog
ChannelCatalogsGlobalApi getChannelCatalog GET /user/channelCatalogs/{channelCatalogId} Get the channel catalog information
ChannelCatalogsGlobalApi getChannelCatalogs GET /user/channelCatalogs/ List all your current channel catalogs
ChannelCatalogsProductsApi exportChannelCatalogProductInfoList POST /user/channelCatalogs/{channelCatalogId}/products/export Export channel catalog product information list
ChannelCatalogsProductsApi getChannelCatalogProductByChannelCatalog POST /user/channelCatalogs/products Get channel catalog products related to these channel catalogs
ChannelCatalogsProductsApi getChannelCatalogProductInfo GET /user/channelCatalogs/{channelCatalogId}/products/{productId} Get channel catalog product information
ChannelCatalogsProductsApi getChannelCatalogProductInfoList POST /user/channelCatalogs/{channelCatalogId}/products Get channel catalog product information list
ChannelCatalogsProductsApi getChannelCatalogProductsCounters GET /user/channelCatalogs/{channelCatalogId}/products/counters Get channel catalog products' counters
ChannelCatalogsProductsOptimisationApi disableChannelCatalogProduct POST /user/channelCatalogs/{channelCatalogId}/products/{productId}/disable Disable channel catalog product
ChannelCatalogsProductsOptimisationApi reenableChannelCatalogProduct POST /user/channelCatalogs/{channelCatalogId}/products/{productId}/reenable Reenable channel catalog product
ChannelCatalogsProductsOverridesApi configureChannelCatalogProductValueOverrideCopy POST /user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides/copy Copy channel catalog product value override
ChannelCatalogsProductsOverridesApi deleteChannelCatalogProductValueOverride DELETE /user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides/{channelColumnId} Delete a specific channel catalog product value override
ChannelCatalogsProductsOverridesApi getChannelCatalogProductValueOverrideCopy GET /user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides/copy Get channel catalog product value override compatibilities status
ChannelCatalogsProductsOverridesApi overrideChannelCatalogProductValues PUT /user/channelCatalogs/{channelCatalogId}/products/{productId}/overrides Override channel catalog product values
ChannelCatalogsSettingsApi configureChannelCatalogCostSettings PUT /user/channelCatalogs/{channelCatalogId}/settings/cost Configure channel catalog cost settings
ChannelCatalogsSettingsApi configureChannelCatalogGeneralSettings PUT /user/channelCatalogs/{channelCatalogId}/settings/general Configure channel catalog general settings
ChannelCatalogsSettingsApi disableChannelCatalog POST /user/channelCatalogs/{channelCatalogId}/disable Disable a channel catalog
ChannelCatalogsSettingsApi enableChannelCatalog POST /user/channelCatalogs/{channelCatalogId}/enable Enable a channel catalog
ChannelsChannelsGlobalApi getAvailableChannels GET /user/channels/ List all available channel for this store
ChannelsChannelsGlobalApi getChannelCategories GET /user/channels/{channelId}/categories Get channel categories
ChannelsChannelsGlobalApi getChannelColumns POST /user/channels/{channelId}/columns Get channel columns
ChannelsChannelsGlobalApi getChannelInfo GET /user/channels/{channelId} Get channel information
CustomerAccountApi activateUserAccount POST /user/customer/account/activate Activate the user account
CustomerAccountApi changePassword POST /user/customer/account/changePassword Change user password
CustomerAccountApi getCreditCardInfo GET /user/customer/account/creditCardInfo Get credit card information
CustomerAccountApi getProfilePictureInfo GET /user/customer/account/profilePictureInfo Get profile picture information
CustomerAccountApi getUserAccountInfo GET /user/customer/account Get user account information
CustomerAccountApi resendEmailActivation POST /user/customer/account/resendEmailActivation Resend email activation
CustomerAccountApi saveCompanyInfo PUT /user/customer/account/companyInfo Change company information
CustomerAccountApi saveCreditCardInfo PUT /user/customer/account/creditCardInfo Save user credit card info
CustomerAccountApi savePersonalInfo PUT /user/customer/account/personalInfo Save user personal information
CustomerAccountApi saveProfilePictureInfo PUT /user/customer/account/profilePictureInfo Change user picture information
CustomerAlertsApi getStoreAlerts GET /user/customer/stores/{storeId}/alerts Get store's alerts
CustomerAlertsApi saveStoreAlerts POST /user/customer/stores/{storeId}/alerts Save store alerts
CustomerContractsApi createContract POST /user/customer/contracts Create a new contract
CustomerContractsApi deleteNextContract DELETE /user/customer/contracts/next Delete your next contract
CustomerContractsApi getBillingPeriods GET /user/customer/billingPeriods Get billing periods conditions
CustomerContractsApi getContracts GET /user/customer/contracts Get contract list
CustomerContractsApi getOffer POST /user/customer/offers Get offer pricing
CustomerContractsApi getStandardOffers GET /user/customer/offers Get all standard offers
CustomerContractsApi reactivateCurrentContract POST /user/customer/contracts/current/reenableAutoRenewal Reactivate your terminated contract.
CustomerContractsApi terminateCurrentContract POST /user/customer/contracts/current/disableAutoRenewal Schedule termination of your current contract at the end of the commitment.
CustomerFriendsApi getFriendInfo GET /user/customer/friends/{userId} Get friend information
CustomerGlobalApi getCustomerIndex GET /user/customer/ The index of all operations and LOV
CustomerInvoicesApi getInvoices GET /user/customer/invoices Get all your invoices
CustomerRightsApi getRights GET /user/customer/stores/{storeId}/rights Get store's rights
CustomerSecurityApi logout POST /user/customer/security/logout Log out the current user from go2
CustomerSharesApi deleteStoreShare DELETE /user/customer/stores/{storeId}/shares/{userId} Delete a share of a store to another user
CustomerSharesApi getStoreShares GET /user/customer/stores/{storeId}/shares Get shares related to this store
CustomerSharesApi shareStore POST /user/customer/stores/{storeId}/shares Share a store to another user
CustomerStoresApi createStore POST /user/customer/stores Create a new store
CustomerStoresApi deleteStore DELETE /user/customer/stores/{storeId} Delete a store
CustomerStoresApi getStore GET /user/customer/stores/{storeId} Get store's information
CustomerStoresApi getStores GET /user/customer/stores Get store list
CustomerStoresApi updateStore PATCH /user/customer/stores/{storeId} Update some store's information.
MarketplacesChannelCatalogsGlobalApi getMarketplaceChannelCatalogs GET /user/marketplaces/channelcatalogs/ Get your marketplace channel catalog list
MarketplacesChannelCatalogsPublicationsApi getPublications GET /user/marketplaces/channelcatalogs/publications/{marketplaceTechnicalCode}/{accountId}/history Fetch the publication history for an account, sorted by descending start date
MarketplacesChannelCatalogsSettingsApi getChannelCatalogMarketplaceProperties GET /user/marketplaces/channelcatalogs/{channelCatalogId}/properties Get the marketplace properties for a channel catalog
MarketplacesChannelCatalogsSettingsApi getChannelCatalogMarketplaceSettings GET /user/marketplaces/channelcatalogs/{channelCatalogId}/settings Get the marketplace settings for a channel catalog
MarketplacesChannelCatalogsSettingsApi setChannelCatalogMarketplaceSettings POST /user/marketplaces/channelcatalogs/{channelCatalogId}/settings Save new marketplace settings for a channel catalog
MarketplacesOrdersAutoTransitionsApi configureAutomaticTransitions POST /user/marketplaces/orders/automaticTransitions Configure new or existing automatic Order status transition
MarketplacesOrdersAutoTransitionsApi getAutomaticTransitions GET /user/marketplaces/orders/automaticTransitions Get list of configured automatic Order status transitions
MarketplacesOrdersBatchesApi changeOrderList POST /user/marketplaces/orders/batches/changeOrders/{changeOrderType} Send a batch of operations to change your marketplace Order information (accept, ship, etc.)
MarketplacesOrdersBatchesApi clearMerchantOrderInfoList POST /user/marketplaces/orders/batches/clearMerchantOrderInfos Send a batch of operations to clear an Order's merchant information (max 100 items per call)
MarketplacesOrdersBatchesApi setMerchantOrderInfoList POST /user/marketplaces/orders/batches/setMerchantOrderInfos Send a batch of operations to set an Order's merchant information (max 100 items per call)
MarketplacesOrdersExportsApi exportOrders POST /user/marketplaces/orders/exportations Request a new Order report exportation to be generated
MarketplacesOrdersExportsApi getOrderExportations GET /user/marketplaces/orders/exportations Get a paginated list of Order report exportations
MarketplacesOrdersGlobalApi getMarketplaceAccountsSynchronization GET /user/marketplaces/orders/status Get current synchronization status between your marketplaces and BeezUP accounts
MarketplacesOrdersGlobalApi getOrderIndex GET /user/marketplaces/orders/ Get all actions you can do on the order API
MarketplacesOrdersGlobalApi harvestAll POST /user/marketplaces/orders/harvest Send harvest request to all your marketplaces
MarketplacesOrdersListApi getOrderListFull POST /user/marketplaces/orders/list/full Get a paginated list of all Orders with all Order and Order Item(s) properties
MarketplacesOrdersListApi getOrderListLight POST /user/marketplaces/orders/list/light Get a paginated list of all Orders without details
MarketplacesOrdersOrderApi changeOrder POST /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/{changeOrderType} Change your marketplace Order Information (accept, ship, etc.)
MarketplacesOrdersOrderApi clearMerchantOrderInfo POST /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/clearMerchantOrderInfo Clear an Order's merchant information
MarketplacesOrdersOrderApi getOrder GET /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId} Get full Order and Order Item(s) properties
MarketplacesOrdersOrderApi getOrderHistory GET /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/history Get an Order's harvest and change history
MarketplacesOrdersOrderApi harvestOrder POST /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/harvest Send harvest request for a single Order
MarketplacesOrdersOrderApi headOrder HEAD /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId} Get the meta information about the order (ETag, Last-Modified)
MarketplacesOrdersOrderApi setMerchantOrderInfo POST /user/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/setMerchantOrderInfo Set an Order's merchant information
PublicChannelsPublicChannelsApi getChannels GET /public/channels/{countryIsoCode} The channel list for one country
PublicChannelsPublicChannelsApi getChannelsIndex GET /public/channels/ Get public channel index
PublicListOfValuesLOVApi getPublicListOfValues GET /public/lov/{listName} Get the list of values related to this list name
PublicListOfValuesLOVApi getPublicLovIndex GET /public/lov/ Get all list names
PublicSecuritySecurityApi login POST /public/security/login Login
PublicSecuritySecurityApi lostPassword POST /public/security/lostpassword Lost password
PublicSecuritySecurityApi register POST /public/security/register User Registration
UserListOfValuesLOVApi getUserListOfValues GET /user/lov/{listName} Get the list of values related to this list name
UserListOfValuesLOVApi getUserLovIndex GET /user/lov/ Get all list names

Documentation For Models

Documentation For Authorization

api_key

Author

[email protected]

All versions of api-php-client with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package beezup/api-php-client contains the following files

Loading the files please wait ....