API Reference

Update a product

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

Updates an existing product by ID.

Path Params
integer
required

ID of the product to update.

Body Params
string

Updated title/name of the product.

string

Updated main description for the product.

string

Updated 2nd description for the product.

string

Updated 3rd description for the product.

string

Updated 4th description for the product.

string

Updated 5th description for the product.

boolean

Whether the product is active.

float

Updated specific delivery price.

boolean

Charge the delivery price only once for multiple orders.

float

Updated weight of the product.

string

The updated meta title for the product page.

string

The updated meta description for the product page.

string

The updated meta keywords for the product page.

string

Updated video embed code.

string

Updated SKU code.

integer

Updated stock quantity.

float

Updated compare price (RRP).

string

Updated GTIN/UPC/EAN.

string

Updated Manufacturer Part Number.

boolean

Whether the product is now marked as new.

boolean

Whether the product is part of a two for one offer.

boolean

Whether the product is part of a three for two offer.

boolean

Set to false if VAT is charged on the product.

boolean

Set to true if VAT relief is enabled on the product.

string

Internal warehouse notes for this product.

float

Updated regular selling price of the product.

float

Updated sale price of the product.

boolean

Whether the product is excluded from trade discounts.

string

Updated custom search keywords.

integer

Updated brand ID for the product.

integer

Updated Google category ID (leaf).

string
enum

Updated condition of the product for Google feed.

Allowed:
boolean

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

boolean

Set identifier_exists=false if true.

integer

Updated eBay category ID (leaf).

boolean

False if not eligible for best offer on eBay.

eBayShippingRates
array of integers

Updated list of eBay shipping rate IDs.

eBayShippingRates
categories
array of integers

Updated category IDs for the product.

categories
related
array of integers

Updated IDs of related products.

related
extras
array of integers

Updated product extras.

extras
choices
array of integers

Updated choices assigned to the product.

choices
customizationFields
array of integers

Updated customisation fields for the product.

customizationFields
filters
object

Updated filters assigned to the product, keyed by filter group option.

integer

Updated number of file uploads allowed.

float

Updated number of reward points for purchasing this product.

additionalData
array of objects

An array of additional data fields (deprecated).

additionalData
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.

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

Updated custom fields for the product (string, integer, or array).

string

Updated HS code for the product.

string

US HTS code for the product.

options
array of integers

Updated product options list.

options
digitalFiles
array of objects

Updated array of digital files.

digitalFiles
string

Updated slug for the product.

Responses

400

Invalid request data.

401

Unauthorized. Invalid or missing API key.

404

Product not found.

500

Server error.

Updated over 1 year ago

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

Updated over 1 year ago

Did this page help you?