The Rest API supports the ability to manage your Product Feed data for Catalogs. The Rest API URI for Product Feed resource is in the format:
https://[siteurl]/rest/product
Commands
API Commands for Contact management include:
|
Name |
HTTP Method |
Endpoint |
Description |
| Add Product | POST | /rest/product | Add a new Product |
| Update Product | PUT |
/rest/product/[catalogId]/[productId] |
Update an existing Product by Catalog ID and Product ID |
| Activate Product | PATCH | /rest/product/[catalogId]/[productId]/1 | Activate an inactive Product by Catalog ID, Product ID and Active status of "1" |
| Deactivate Product | PATCH | /rest/product/[catalogId]/[productId]/0 | Deactivate an active Product by Catalog ID, Product ID and Active status of "0" |
Product Data Fields
The following data fields may be set and viewed.
|
Field Name |
Methods |
Description |
Type |
Example |
|
Product ID |
POST, PUT, PATCH |
Unique ID for the product item. |
String |
"productId": |
|
Catalog ID |
POST, PUT, PATCH |
Unique ID for the grouping of product items into a Catalog. |
Integer |
"catalogId": [catalogId] |
|
Status |
POST, PUT, PATCH |
Active or Inactive status of the product.
|
Boolean |
"active"=1 |
|
Availability |
POST, PUT |
Current availability status of the product. Supported values:
|
String |
"availability": "In stock" |
|
VSKU |
POST, PUT |
Variant Sku |
String |
"vsku":"[vsku]" |
|
PSKU |
POST, PUT |
Parent Sku |
String |
"psku": "[psku]" |
|
Product Type |
POST, PUT |
Product type, or category and sub-category, product is assigned to. Product Type is stored for the specific product only. To add Category for future browse recovery campaigns, use the FTP API Product Feed Import. |
String |
"productType": "Paper > Copy Paper" |
|
Title |
POST, PUT |
Product title at the parent SKU level |
String |
"title": "[Product title]" |
|
Variant Title |
POST, PUT |
Product title at the variant SKU level |
String |
"variantTitle": "[Variant title]" |
|
Link |
POST, PUT |
URL for the product at the parent SKU level including http:// or https:// prefix. |
String |
"link": "[link]" |
|
Image Link |
POST, PUT |
URL for the product image at the parent SKU level including http:// or https:// prefix. | String |
"imageLink": "[imagelink]" |
|
Price |
POST, PUT |
Price of product as a two decimal place value. |
Float | "price": 44.44 |
|
Currency |
POST, PUT |
Currency used in the price field. This must be a valid ISO 4217 alphabetic code. |
String | "currency": "USD" |
|
Brand |
POST, PUT |
Brand of the product. |
String | "brand":"[brand]" |
|
Manufacturer |
POST, PUT |
Manufacturer of the product. |
String | "manufacturer":"[manufacturer]" |
|
Quantity |
POST, PUT |
Current quantity in of product in inventory. |
Integer | "quantity":64 |
|
Color |
POST, PUT |
Product Color(s) | String | "color":"[color]" |
|
Size |
POST, PUT |
Product Size | String | "size":"[size]" |
|
Gender |
POST, PUT |
Gender for the product specified. This optional string is not limited to any specific wording. | String | "gender":"[gender]" |
*Feature added in v15.14.00 release.