Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wish ProductBoost API

The ProductBoost API from Wish — 7 operation(s) for productboost.

Wish ProductBoost API is one of 21 APIs that Wish publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ProductBoost. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 9 operations across 7 paths, and defines 23 schemas. It is described by OpenAPI 3.0.0, at version 3.0.65.

Requests are made against a single base URL, https://merchant.wish.com.

9 operations 7 paths 23 schemas 7 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.65
Base URL
https://merchant.wish.com/api/v3
Authentication
OpenID Connect, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Wish ProductBoost API declares 2 security schemes for authenticating requests. It supports OpenID Connect (OpenID) discovered at https://merchant.wish.com/oidc/.well-known/openid-configuration. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 37 scopes. By default, every request must be authenticated.

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 7 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ProductBoost 9
GET
/api/v3/product_boost/keywords
Get information for the given keywords or keywords that match the query
getKeywords 3 params → 200400
POST
/api/v3/product_boost/campaigns
Create a ProductBoost campaign
createCampaign body → 200400
GET
/api/v3/product_boost/campaigns
List ProductBoost campaigns
listCampaigns 17 params → 200400
GET
/api/v3/product_boost/campaigns/{id}/product_feedback
List products' feedback in a ProductBoost campaign
ListProductFeedback 2 params → 200400
GET
/api/v3/product_boost/budget
Get the ProductBoost budget breakdown
getBudget 1 param → 200400
PUT
/api/v3/product_boost/campaigns/{id}
Update a ProductBoost campaign
updateCampaign 1 param body → 200400
GET
/api/v3/product_boost/campaigns/{id}
Get a single ProductBoost campaign
getCampaign 1 param → 200400
GET
/api/v3/product_boost/campaigns/{id}/metrics
Obtain campaign metrics
listCampaignMetrics 4 params → 200400
GET
/api/v3/product_boost/balance_updates
List ProductBoost account balance updates
listBalanceUpdates 4 params → 200400

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Campaign (32 properties), ProductDailyPerformance (13 properties), UpdateCampaign (11 properties), CreateCampaign (10 properties). Each schema is shown below with its type and property counts.

BalanceUpdateType
string
The type of the transaction. 'DEPOSIT' means credits are added to user's balance, and 'WITHDRAW' means Wish deducts from user's balance.
APIError
object
2 properties 2 required
Keywords
array
CampaignType
string
CLASSICBOOST campaigns allow users to provide bidding for a list of keywords. SIMPLEBOOST campaigns do not need keywords and bidding provided
ProductDailyPerformance
object
13 properties
Campaign
object
32 properties
BudgetBreakdown
object
7 properties
BalanceUpdates
array
BalanceUpdate
object
5 properties 3 required
CampaignState
string
The state you want to change your campaign to. 'PENDING' campaigns can be changed to the state 'NEW' or 'CANCELLED'. 'NEW' or 'SAVED' campaigns can be changed…
CampaignMetrics
object
1 property
Keyword
object
2 properties
CampaignProductFeedback
object
4 properties
Campaigns
array
UpdateCampaignProduct
object
2 properties 1 required
Money
object
2 properties 2 required
CampaignProduct
object
7 properties
ImpressionFeeBreakdown
object
4 properties
CampaignDailyPerformance
object
2 properties
UpdateCampaign
object
11 properties
CampaignProductFeedbacks
array
CreateCampaign
object
10 properties 5 required
ImpressionFeeState
string
State of impression fees

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wish-productboost-api-openapi.yml Raw ↑

Other APIs Wish publishes across the network.

Wish Brands API
Wish Bulk Products API
Wish Currencies API
Wish EU Product Compliance API
Wish France EPR Compliance API
Wish Germany EPR Compliance API
Wish Merchant API
Wish OAuth API
Wish Orders API
Wish Payments API
Wish Penalties API
Wish Products API