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 Promotions Platform API

The Promotions Platform API from Wish — 6 operation(s) for promotions platform.

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

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

This API exposes 8 operations across 6 paths, and defines 18 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.

8 operations 6 paths 18 schemas 5 GET1 POST2 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 Promotions Platform 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 8

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

Promotions Platform 8
GET
/api/v3/promotions/eligible_products
Get eligible products
getPromotionsEligibleProducts 7 params → 200400
PUT
/api/v3/promotions/campaigns/{id}/cancel
Cancel a promotion campaign
cancelPromotionsCampaign 1 param body → 200400
POST
/api/v3/promotions/campaigns
Create a promotion campaign
createPromotionsCampaign body → 200400
GET
/api/v3/promotions/campaigns
List promotion campaigns
listPromotionsCampaigns 12 params → 200400
PUT
/api/v3/promotions/campaigns/{id}
Update a promotion campaign
updatePromotionsCampaign 1 param body → 200400
GET
/api/v3/promotions/campaigns/{id}
Get a single promotion campaign
getPromotionsCampaign 1 param → 200400
GET
/api/v3/promotions/events
List promotion events
listPromotionEvents 6 params → 200400
GET
/api/v3/promotions/eligible_products/count
Get eligible products count
getPromotionsEligibleProductsCount 4 params → 200400

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are PromotionsCampaign (14 properties), PromotionEvent (10 properties), CreatePromotionsCampaign (7 properties), VariationDiscountData (6 properties). Each schema is shown below with its type and property counts.

APIError
object
2 properties 2 required
PromotionEligibleProduct
object
Eligible product for Promotions Platform
2 properties
CancelReason
string
Reason of cancelling campaign.
PromotionType
string
Promotion type of the campaign. 'DISCOUNT' campaigns support basic discount on variations. 'FLASHSALE' campaigns support significant discount on products for a…
UnqualifiedReason
string
Reason of unqualified product variations. 'NOTINSTOCK': product out of stock. 'LOWRATING': product rating is too low (Minimum of 3 for Discount promotions, or…
VariationsDiscountData
object
Campaign discount data. Only used when promotiontype is 'DISCOUNT' or 'FLASHSALE'.
3 properties 1 required
UnqualifiedVariation
object
Unqualified product variation.
3 properties
PromotionsCampaign
object
14 properties
PromotionsEligibleVariation
object
Eligible variation for Promotions Platform.
1 property
UpdatePromotionsCampaign
object
1 property
CreatePromotionsCampaign
object
7 properties 1 required
PromotionsCampaignState
string
Campaign State. 'PENDING' campaigns are created but pending for approval. 'APPROVED' campaigns are approved. 'CANCELLED' campaigns are cancelled.
PromotionEvent
object
10 properties
PromotionsEligibleCountries
array
List of countries that are eligible for the campaign. The default value (not provided or empty list) are all countries that the products can be shipped to.
MerchantCancelReason
string
Reason of merchant cancelling campaign.
CancelPromotionsCampaign
object
2 properties 1 required
PromotionsCampaignCancelComment
string
A detailed reason for the campaign cancellation. Used by Wish to collect feedbacks.
VariationDiscountData
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wish-promotions-platform-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 ProductBoost API