API Reference
  1. WSHOP API
  2. Products

Create a product

post
https://{instance}.wshop.cloud/api/v1/products/create

Same rules as bulkcreate, for a single product object.

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

Unique product reference

string
required
length ≤ 100
string
length ≤ 200
string

Allows HTML tags: <b>, <i>, <u>, <br>, used without attributes. Malformed markup, or an HTML attribute carrying an inline JavaScript event handler (onclick, onerror, onload, etc.), is rejected with PDT0072 (PDT0189 for a translations entry).

integer
required

Season id from /seasons/get

string
required
^(00P|[HPEA][0-9]{2})$

00P (permanent) or season letter (H, P, E, A) followed by 2-digit year

integer
required

Department id from /departments/get

string
enum
required
Allowed:
number
required

cm

number
required

cm

number
required

cm

number
required

kg

number
required

Purchase price

number
required

Selling price, VAT included. Must be greater than price

number
string

Format (YYYY-MM-DD HH:II:SS)

string

Format (YYYY-MM-DD HH:II:SS)

number
number
required
integer
enum
required
Allowed:
integer
enum
Allowed:
integer
integer

Brand id

integer
enum
Allowed:
integer
enum
Allowed:
integer
enum
Allowed:
integer
enum
Allowed:
integer
enum
Allowed:
integer
enum
Allowed:
integer
enum
Allowed:
integer
enum
Allowed:
integer
enum
Allowed:
integer
enum
Allowed:
inventory
array of objects
required
inventory*
gallery
array of objects
gallery
attributes
array of objects
attributes
ranking
object
custom_data
array of objects

List of custom data values to attach for this product. Supports SIMPLE, GROUP and UNLINK modes. For a predefined-values custom data you may send either values (exact predefined strings) or valuesCode (integer predefined IDs), but not both simultaneously. See ProductCustomDataItem in components.schemas for the full contract and validation rules (CD0023, CD0025, CD0040, CD0041, CD0042, CD0067, CD0069, CD0078, CD0083, CD0084, CD0085, CD0086, CD0087, CD0088, CD0089, CD0090, CD0094, CD0095, CD0096).

custom_data
pricing_matrix
array of objects
pricing_matrix
string
enum
Allowed:
string
length ≤ 50
date-time
date-time
translations
object

Translations keyed by language code (e.g. 'fr', 'en', 'es'). The language code must exist in supportedLanguages.

integer

VAT id. Defaults to the site default VAT. Also sets the VAT grid of the product and is used to compute excl. VAT prices

integer
enum

Free shipping

Allowed:
integer
enum

Available in store

Allowed:
integer
enum

Back in stock alert enabled

Allowed:
integer
enum
Allowed:
integer

Number of pieces per parcel

parcel
array of objects
parcel
integer

Carrier id

eligible_carriers
array of objects
eligible_carriers
integer

Provider id

uri

Product PDF. Enables the PDF when set

label1
object

Round label

label2
object

Rectangular label

cms_page
array of objects

Replaces the CMS pages linked to the product

cms_page
gammes
array of objects
gammes
batch_contents
array of objects

Required when type is batch_similar or batch_distinct

batch_contents
association
array of objects

Replaces the associated products

association
string

Reference of the parent product (main site)

string

Can be used instead of site to target a sub-site by its URL

cross_sells
array of objects

All the cross-sells linked to the product

cross_sells
Responses

Updated 7 days 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 7 days ago

Did this page help you?