eComm Products
Native Store Only
Product Object
Get products page. Default page response size is 50, max requested page size is 100.
{
"description": "The most amazing t shirt ever sold",
"external_id": "KTP9XGbSg2",
"id": "IakdKbiUiK",
"images": [
{
"alt": "Image of fancy shirt",
"url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
}
],
"name": "Amazing T-shirt",
"options": [
{
"choices": [
{
"id": "db3je27rg7",
"value": "45"
}
],
"id": "WMd1xylGrp",
"name": "Shirt size"
}
],
"prices": [
{
"compare_at_price": "19.99",
"currency": "USD",
"price": "12.34"
}
],
"seo": {
"description": "Amazing T-shirt made with 100% biologic cotton",
"product_url": "amazing-t-shirt",
"title": "Amazing T-shirt"
},
"sku": "UGG-BB-PUR-06",
"status": "ACTIVE",
"variations": [
{
"external_id": "KTP9XGbSg2",
"id": "KTP9XGbSg2",
"images": [
{
"alt": "Image of fancy shirt",
"url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
}
],
"options": [
{
"choice_id": "db3je27rg7",
"choice_value": "45",
"option_id": "WMd1xylGrp",
"option_name": "Shirt size"
}
],
"price_difference": "string",
"quantity": 25,
"sku": "UGG-BB-PUR-06",
"status": "ACTIVE",
"stock_status": "IN_STOCK, OUT_OF_STOCK"
}
]
}product_details
description
string
A description of the product.
Yes
external_id
string
External product identifier for reference
No
id
string
A unique identifier for the product.
No
images
object[]
Contains images and image details for the product. Must pass all data when making any changes to this property. See the section below for details.
Yes
name
string
The name of the product.
Yes
options
string
Options for the product. Will be used to generate product variations. See the section below for details
Yes
prices
object[]
Contains the pricing details of the product. Must pass all data when making any changes to this property. See the section below for details.
Yes
sku
string
The stock keeping unit of the product.
Yes
status
string
The status of the product. Can be either ACTIVE or INACTIVE.
Yes
images
alt
string
Description of the image.
Yes
url
string
The url of the image.
Yes
prices
compare_at
string
The comparative price of the product. The difference between the product's discounted price and original price.
Yes
currency
string
Specified currency of the product.
Yes
price
string
Actual price of the product.
Yes
seo
description
string
The meta description of the product. Should be around 155 characters in length.
Yes
product_url
string
The path / URL to a product in the store.
Yes
title
string
Set the for this product. Should be less than 60 characters in length.
Yes
options
id
string
A unique identifier for the option.
Yes
name
string
The name of the option.
Yes
choices
id
string
A unique identifier for the choice.
No
value
string
The value of the choice.
Yes
List Products
List Products
GET https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/products
Get products page. Default page response size is 50, max requested page size is 100.
Path Parameters
site_name*
string
The unique identifier of the target site.
Query Parameters
offset
int32
Zero-based offset for elements (0..N)
limit
int32
The size of the page to be returned
sort
array of string
Property on which to sort results
direction
string
[asc,desc] Order direction for the property specified in sort.
curl --request GET \
--url 'https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/products?offset=0&direction=asc' \
--header 'accept: application/json'Get Product
Get Product
GET https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/products/{product_id}
Get catalog product by id
Path Parameters
site_name*
string
The unique identifier for the target site
product_id*
string
The unique identifier for the target Product.
curl --request GET \
--url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/products/product_id \
--header 'accept: application/json'Create Product
Create Product
POST https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/products
Path Parameters
site_name*
string
The unique identifier for the target site
Request Body
name*
string
Product name
description
string
Product description
sku
string
Stock keeping unit of given product
status
string
[ACTIVE, HIDDEN] Only entities in published state will be available to store front
images
array of objects
image list fro given product
price
array of objects
Price for given product in different currencies
seo
object
description, product_ur, and title of product
options
array of objects
List of options and values to chose from, will be used to create the product variations
{
"description": "The most amazing t shirt ever sold",
"external_id": "KTP9XGbSg2",
"id": "IakdKbiUiK",
"images": [
{
"alt": "Image of fancy shirt",
"url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
}
],
"name": "Amazing T-shirt",
"options": [
{
"choices": [
{
"id": "db3je27rg7",
"value": "45"
}
],
"id": "WMd1xylGrp",
"name": "Shirt size"
}
],
"prices": [
{
"compare_at_price": "19.99",
"currency": "USD",
"price": "12.34"
}
],
"seo": {
"description": "Amazing T-shirt made with 100% biologic cotton",
"product_url": "amazing-t-shirt",
"title": "Amazing T-shirt"
},
"sku": "UGG-BB-PUR-06",
"status": "ACTIVE",
"variations": [
{
"external_id": "KTP9XGbSg2",
"id": "KTP9XGbSg2",
"images": [
{
"alt": "Image of fancy shirt",
"url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
}
],
"options": [
{
"choice_id": "db3je27rg7",
"choice_value": "45",
"option_id": "WMd1xylGrp",
"option_name": "Shirt size"
}
],
"price_difference": "string",
"quantity": 25,
"sku": "UGG-BB-PUR-06",
"status": "ACTIVE",
"stock_status": "IN_STOCK, OUT_OF_STOCK"
}
]
}curl --request POST \
--url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/products \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"name": "Amazing T-shirt"
}
'Update Product
Update Product
PATCH https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/products/{product_id}
Path Parameters
site_name*
string
The unique identifier for the target site
product_id*
string
The unique identifier for the target Product.
Request Body
name*
string
Product name
description
string
Product description
sku
string
Stock keeping unit of given product
status
string
[ACTIVE, HIDDEN] Only entities in published state will be available to store front
images
array of objects
image list fro given product
price
array of objects
Price for given product in different currencies
seo
object
description, product_ur, and title of product
options
array of objects
List of options and values to chose from, will be used to create the product variations
{
"description": "The most amazing t shirt ever sold",
"external_id": "KTP9XGbSg2",
"id": "IakdKbiUiK",
"images": [
{
"alt": "Image of fancy shirt",
"url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
}
],
"name": "Amazing T-shirt",
"options": [
{
"choices": [
{
"id": "db3je27rg7",
"value": "45"
}
],
"id": "WMd1xylGrp",
"name": "Shirt size"
}
],
"prices": [
{
"compare_at_price": "19.99",
"currency": "USD",
"price": "12.34"
}
],
"seo": {
"description": "Amazing T-shirt made with 100% biologic cotton",
"product_url": "amazing-t-shirt",
"title": "Amazing T-shirt"
},
"sku": "UGG-BB-PUR-06",
"status": "ACTIVE",
"variations": [
{
"external_id": "KTP9XGbSg2",
"id": "KTP9XGbSg2",
"images": [
{
"alt": "Image of fancy shirt",
"url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
}
],
"options": [
{
"choice_id": "db3je27rg7",
"choice_value": "45",
"option_id": "WMd1xylGrp",
"option_name": "Shirt size"
}
],
"price_difference": "string",
"quantity": 25,
"sku": "UGG-BB-PUR-06",
"status": "ACTIVE",
"stock_status": "IN_STOCK, OUT_OF_STOCK"
}
]
}curl --request POST \
--url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/products \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"name": "Amazing T-shirt"
}
'Delete Product
Delete Product
DELETE https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/products/{product_id}
Delete catalog product
Path Parameters
site_name*
string
The unique identifier for the target site
product_id*
string
The unique identifier of the target Product.
curl --request DELETE \
--url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/products/product_id \
--header 'accept: application/json'Last updated
Was this helpful?