Create a new product

post

https://api.ecommerceapi.uk/v1/products

Creates a new product.

Body Params

title

string

required

The title/name of the product.

description

string

The main description for the product.

description2

string

The 2nd description for the product.

description3

string

The 3rd description for the product.

description4

string

The 4th description for the product.

description5

string

The 5th description for the product.

active

boolean

Whether the product is active.

deliveryPrice

float

Delivery price for the product.

singleDeliveryPrice

boolean

Charge the delivery price only once if multiple units are ordered.

weight

float

Weight of the product.

metaTitle

string

Meta title for the product page.

metaDescription

string

Meta description for the product page.

metaKeywords

string

Meta keywords for the product page.

videoCode

string

Video embed code for the product.

sku

string

SKU code for the product.

stock

integer

Stock quantity (used if SKU is provided).

comparePrice

float

Compare price (RRP) for the product.

gtin

string

GTIN/UPC/EAN for the product.

mpn

string

MPN (Manufacturer Part Number) for the product.

new

boolean

Displays 'new' indicator on the product if true.

twoForOne

boolean

Indicates if product has a two-for-one offer.

threeForTwo

boolean

Indicates if product has a three-for-two offer.

vatExclusive

boolean

Set to false if VAT is charged on the product.

vatRelief

boolean

Enable VAT relief if set to true.

warehouseNotes

string

Internal warehouse notes for the product.

price

float

Regular selling price for the product.

salePrice

float

Sale price overriding the regular price if set.

excludedFromTradeDiscounts

boolean

If true, the product is excluded from trade discounts.

searchKeywords

string

Custom search keywords for the product.

brand

integer

ID of the brand for the product.

googleCategory

integer

Google category ID (leaf) for the product.

googleCondition

string

enum

Condition of the item for Google feed.

Allowed:

googleIsBundle

boolean

Mark as true if the product is a bundle for Google feed.

googleNoIdentifierExists

boolean

Set identifier_exists=false if true.

eBayCategory

integer

eBay category ID (leaf) for the product.

eBayBestOffer

boolean

False if not eligible for best offer on eBay.

eBayShippingRates

array of integers

IDs of eBay shipping rates.

eBayShippingRates

categories

array of integers

Category IDs the product belongs to.

categories

related

array of integers

IDs of related products.

related

extras

array of integers

Product extras.

extras

choices

array of integers

Choices assigned to the product.

choices

customizationFields

array of integers

Customisation fields for the product.

customizationFields

filters

object

Filters assigned to the product, keyed by filter group option.

fileUploadsAllowed

integer

Number of file uploads allowed.

rewardPoints

float

Points earned when the product is purchased.

additionalData

array of objects

An array of additional data fields (deprecated).

additionalData

outOfStockStatus

integer

The product'ss back order settings, 0 for global/account default, 1 for purchasable when out of stock, 2 for not purchasable when out of stock.

outOfStockQuantityLimit

integer

The product's back order quantity limit, 0 for no limit, positive integer = how far stock can go negative for out of stock purchases.

customFields

object

Custom fields assigned to the product (string, integer, or array).

hsCode

string

HS code for the product.

htsCode

string

US HTS code for the product.

options

array of integers

Product options.

options

digitalFiles

array of objects

IDs of digital files attached to the product.

digitalFiles

slug

string

Slug for the product.

Responses

400

Invalid request data.

401

Unauthorized. Invalid or missing API key.

500

Server error.

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json