API Reference
  1. WSHOP API
  2. Promo Codes

Create promo codes in bulk

post
https://{instance}.wshop.cloud/api/v1/promocode/bulkcreate

The body is an array of generation requests. Each request generates qty promo codes named <prefix><code> (or <prefix> + 8 random digits). Invalid requests are skipped and reported.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Prefix of the generated codes (uppercase). Must be allowed on the platform. ECRM segment names, FID, BVL and RSC (customer service) are specific prefixes.

string

Suffix appended to the prefix. When omitted, 8 random digits are used. Not applicable to RSC codes.

string

Name of the codes. Defaults to <prefix> YYYYMMDD - Generate <code>.

integer
required
1 to 20000

Number of codes to generate (max 20 000)

date
required
date
required
number

Minimum cart amount

number

Discount value

integer
Defaults to 0

Number of uses allowed per code

integer
Defaults to 2

Promo code format ID

string
enum
Defaults to no

Free shipping: yes, no or partial (shipping discount)

Allowed:
number

Shipping discount. Required if shippingCost is partial.

string
enum
Defaults to all
Allowed:
targetEmail
array of strings

Unique emails of existing clients. Required if target is manual or the prefix is an ECRM segment name.

targetEmail
string
enum
Defaults to all
Allowed:
selectionProduct
array of strings

Unique internal or external product references. Required if selection is product.

selectionProduct
boolean

Send the replacement mail (C2) to targetEmail. Requires the RSC prefix and targetEmail.

boolean

Send the reclamation mail (C5) to targetEmail. Requires the RSC prefix and targetEmail.

integer

Site ID. Defaults to the main site.

Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?