Public
Documentation Settings
No Environment
Double Column
cURL - cURL
YesPlz API Product Tagging Reference
Introduction
Product & Tagging Management

YesPlz API Product Tagging Reference

Product tagging process automatically starts as soon as the products are registered through API endpoint or product feed.

Alternatively, uploading product feed(.csv or .json format) to specific S3/SFTP location can trigger tagging process. Please contact support@yesplz.ai for how to setup product tagging through product feed. Product feed can be either full producct feed or updated product feed only.

Contact Support:
Email: support@yesplz.ai

AUTHORIZATIONAPI Key
Key

Authorization

Value

Token 12345678abcdedf

Product & Tagging Management

AUTHORIZATIONAPI Key
This folder is using API Key from collectionYesPlz API Product Tagging Reference

POSTAdd/update product information

https://api.yesplz.ai/api/v1/retailer/example/products

Check example request for the necessary fields.

KeyDescription
product_idUnique Product ID
retailer_categoryArray of product category defined by retailer.
brand_name(Optional) Brand Name
product_nameProduct name/title
product_url(Optional) URL of Product Page
description(Optional) Description of product details. Can be HTML format.
features(Optional) Any extra information about product
materials(Optional) Material information in string format
release_date(Optional) Product release date in "yyyy-mm-dd" format.
product_status(Optional) Product release state. "AVAIL" if product is available, "DISCON" if product is out-of-stock or discontinued.
original_price(Optional) Original Product Price(MSRP)
sale_price(Optional) Reduced Sale Price
gender(Optional) "NA" for gender non-applicable product, "M" for male, "F" for female, "UNI" for unisex product
popularity(Optional) Popularity or recent sales number. Product recommendation will be done with high weight on this value if given.
variant_idID of variants(e.g. colors)
variant_name(Optional) Name of variants
variant_url(Optional) Variant specific product URL if exists.
is_default(Optional) true if this variant is default variant for this product
src_uriHTTP URL or any other information to locate product image file
AUTHORIZATIONAPI Key
This request is using API Key from collectionYesPlz API Product Tagging Reference
HEADERS
Content-Type

application/json

GETGet product information by product

https://api.yesplz.ai/api/v1/retailer/example/products/:productId
AUTHORIZATIONAPI Key
This request is using API Key from collectionYesPlz API Product Tagging Reference
PATH VARIABLES
productId

:product_id

(Required) Product ID to return

DELETERemove a product

https://api.yesplz.ai/api/v1/retailer/example/products/:productId
AUTHORIZATIONAPI Key
This request is using API Key from collectionYesPlz API Product Tagging Reference
PATH VARIABLES
productId

:productId

(Required) Product ID to delete

Loading