beezup-merchant-api

name	beezup-merchant-api
description	BeezUP Merchant API skill. Use when working with BeezUP Merchant for public, user, orders. Covers 249 endpoints.
version	1.0.0
generator	lapsh

BeezUP Merchant API

API version: 2.0

Auth

ApiKey Ocp-Apim-Subscription-Key in header

Base URL

https://api.beezup.com

Setup

1. Set your API key in the appropriate header
2. GET /v2/public/channels/ -- verify access
3. POST /v2/public/security/login -- create first login

Endpoints

249 endpoints across 3 groups. See references/api-spec.lap for full details.

public

Method	Path	Description
POST	/v2/public/security/login	Login
POST	/v2/public/security/login/mfa	Login
POST	/v2/public/security/register	User Registration
POST	/v2/public/security/lostpassword	Lost password
GET	/v2/public/channels/	Get public channel index
GET	/v2/public/channels/{countryIsoCode}	The channel list for one country
GET	/v2/public/lov/	Get all list names
GET	/v2/public/lov/{listName}	Get the list of values related to this list name

user

Method	Path	Description
GET	/v2/user/lov/	Get all list names
GET	/v2/user/lov/{listName}	Get the list of values related to this list name
GET	/v2/user/customer/	The index of all operations and LOV
GET	/v2/user/customer/account	Get user account information
POST	/v2/user/customer/account/resendEmailActivation	Resend email activation
POST	/v2/user/customer/account/activate	Activate the user account
PUT	/v2/user/customer/account/personalInfo	Save user personal information
PUT	/v2/user/customer/account/companyInfo	Change company information
GET	/v2/user/customer/account/profilePictureInfo	Get profile picture information
PUT	/v2/user/customer/account/profilePictureInfo	Change user picture information
GET	/v2/user/customer/account/creditCardInfo	Get credit card information
PUT	/v2/user/customer/account/creditCardInfo	Save user credit card info
POST	/v2/user/customer/account/changeEmail	Change user email
POST	/v2/user/customer/account/changePassword	Change user password
POST	/v2/user/customer/security/logout	Log out the current user from go2
GET	/v2/user/customer/zendeskToken	Zendesk token
GET	/v2/user/customer/stores	Get store list
POST	/v2/user/customer/stores	Create a new store
GET	/v2/user/customer/stores/{storeId}	Get store's information
PATCH	/v2/user/customer/stores/{storeId}	Update some store's information.
DELETE	/v2/user/customer/stores/{storeId}	Delete a store
GET	/v2/user/customer/stores/{storeId}/rights	Get store's rights

orders

Method	Path	Description
GET	/orders/v3//lov/orderManagementReadyMarketplaceBusinessCode	Get the list of MarketplaceBusinessCode ready for Order Management
GET	/orders/v3//status	Get current synchronization status between your marketplaces and BeezUP accounts
POST	/orders/v3//harvest	Send harvest request to all your marketplaces
POST	/orders/v3//list/full	Get a paginated list of all Orders with all Order and Order Item(s) properties
POST	/orders/v3//list/light	Get a paginated list of all Orders without details
HEAD	/orders/v3//{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}	Get the meta information about the order (ETag, Last-Modified)
GET	/orders/v3//{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}	Get full Order and Order Item(s) properties
POST	/orders/v3//{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/{changeOrderType}	Change your marketplace Order Information (accept, ship, etc.)
POST	/orders/v3//{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/closeIncident	Mark an order incident as resolved
GET	/orders/v3//{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/history	Get an Order's harvest and change history
POST	/orders/v3//{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/harvest	Send harvest request for a single Order
POST	/orders/v3//{marketplaceTechnicalCode}/{accountId}/harvest	Send harvest request for an Account
GET	/orders/v3//{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/history/{orderChangeExecutionUUID}	Get the order change reporting
POST	/orders/v3//{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/setMerchantOrderInfo	Set an Order's merchant information
POST	/orders/v3//{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/clearMerchantOrderInfo	Clear an Order's merchant information
POST	/orders/v3//batches/setMerchantOrderInfos	Send a batch of operations to set an Order's merchant information (max 100 items per call)

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a login?" -> POST /v2/public/security/login
• "Create a mfa?" -> POST /v2/public/security/login/mfa
• "Create a register?" -> POST /v2/public/security/register
• "Create a lostpassword?" -> POST /v2/public/security/lostpassword
• "List all channels?" -> GET /v2/public/channels/
• "Get channel details?" -> GET /v2/public/channels/{countryIsoCode}
• "List all lov?" -> GET /v2/public/lov/
• "Get lov details?" -> GET /v2/public/lov/{listName}
• "List all lov?" -> GET /v2/user/lov/
• "Get lov details?" -> GET /v2/user/lov/{listName}
• "List all customer?" -> GET /v2/user/customer/
• "List all account?" -> GET /v2/user/customer/account
• "Create a resendEmailActivation?" -> POST /v2/user/customer/account/resendEmailActivation
• "Create a activate?" -> POST /v2/user/customer/account/activate
• "List all profilePictureInfo?" -> GET /v2/user/customer/account/profilePictureInfo
• "List all creditCardInfo?" -> GET /v2/user/customer/account/creditCardInfo
• "Create a changeEmail?" -> POST /v2/user/customer/account/changeEmail
• "Create a changePassword?" -> POST /v2/user/customer/account/changePassword
• "Create a logout?" -> POST /v2/user/customer/security/logout
• "List all zendeskToken?" -> GET /v2/user/customer/zendeskToken
• "List all stores?" -> GET /v2/user/customer/stores
• "Create a store?" -> POST /v2/user/customer/stores
• "Get store details?" -> GET /v2/user/customer/stores/{storeId}
• "Partially update a store?" -> PATCH /v2/user/customer/stores/{storeId}
• "Delete a store?" -> DELETE /v2/user/customer/stores/{storeId}
• "List all rights?" -> GET /v2/user/customer/stores/{storeId}/rights
• "List all alerts?" -> GET /v2/user/customer/stores/{storeId}/alerts
• "Create a alert?" -> POST /v2/user/customer/stores/{storeId}/alerts
• "List all shares?" -> GET /v2/user/customer/stores/{storeId}/shares
• "Create a share?" -> POST /v2/user/customer/stores/{storeId}/shares
• "Delete a share?" -> DELETE /v2/user/customer/stores/{storeId}/shares/{userId}
• "Get friend details?" -> GET /v2/user/customer/friends/{userId}
• "List all billingPeriods?" -> GET /v2/user/customer/billingPeriods
• "List all offers?" -> GET /v2/user/customer/offers
• "Create a offer?" -> POST /v2/user/customer/offers
• "List all contracts?" -> GET /v2/user/customer/contracts
• "Create a contract?" -> POST /v2/user/customer/contracts
• "Create a disableAutoRenewal?" -> POST /v2/user/customer/contracts/current/disableAutoRenewal

Response Tips

• Check response schemas in references/api-spec.lap for field details
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP