AI as a Service API
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Version: 1.1
BasePath:
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
put /product/{product-id}/image/{image-id}
(addImage)
Upload image directly to catalog and trigger feature extraction
Path parameters
product-id (required)
Path Parameter — default: null
image-id (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
image-url (required)
Form Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"data" : {
"product-id" : "100258",
"site-id" : 25,
"url" : "http://mainUrl/image.jpg",
"image-id" : "1"
},
"message" : "success"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
AddImage_200_response
400
Could not save or publish the image
AddImage_400_response
401
Authentication Error
403
Authorization Error
404
Unable to find product to add this image to
AddImage_404_response
(createSearchSession)
Starts a reusable search session for a one image.
Consumes
This API call consumes the following media types via the request header:
Form parameters
image (required)
Form Parameter — default: null format: binary
Return type
Example data
Content-Type: application/json
{
"uploadHighResolutionImage" : {
"rel" : [ "form", "form" ],
"value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
},
"detectedObjects" : [ {
"links" : {
"key" : {
"method" : "POST",
"href" : "https://openapi-generator.tech"
}
},
"value" : {
"score" : 6,
"classId" : 0,
"rectangle" : {
"top" : 0.3641,
"left" : 0,
"width" : 0.94,
"height" : 0.54175
},
"class" : "class"
}
}, {
"links" : {
"key" : {
"method" : "POST",
"href" : "https://openapi-generator.tech"
}
},
"value" : {
"score" : 6,
"classId" : 0,
"rectangle" : {
"top" : 0.3641,
"left" : 0,
"width" : 0.94,
"height" : 0.54175
},
"class" : "class"
}
} ],
"links" : {
"self" : {
"method" : "POST",
"href" : "/search/session/62cd4392853023-58137863"
}
},
"searchArea" : {
"rel" : [ "query-form", "query-form" ],
"value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
},
"filters" : {
"type" : "object",
"value" : {
"categories" : [ {
"name" : "Kinder"
}, {
"name" : "Kinder"
} ]
}
},
"type" : "array",
"value" : [ {
"image" : {
"thumbnail" : "http://mainUrl/thumbnail-image.jpg",
"original" : "http://mainUrl/image.jpg"
},
"productId" : "55fc5f71d6362321cb93b82b387e2f32",
"price" : {
"actual" : 39.95,
"sale" : 24.95
},
"groupId" : "55fc5f71d6362321cb93b82b387e2f32",
"deeplink" : "http://mainUrl/site/5/product/55fc5f71d6362321cb93b82b387e2f32/details",
"title" : "Livingwalls Fototapete Walls by Patel iconic 3",
"brand" : "Fender",
"productType" : "guitar"
}, {
"image" : {
"thumbnail" : "http://mainUrl/thumbnail-image.jpg",
"original" : "http://mainUrl/image.jpg"
},
"productId" : "55fc5f71d6362321cb93b82b387e2f32",
"price" : {
"actual" : 39.95,
"sale" : 24.95
},
"groupId" : "55fc5f71d6362321cb93b82b387e2f32",
"deeplink" : "http://mainUrl/site/5/product/55fc5f71d6362321cb93b82b387e2f32/details",
"title" : "Livingwalls Fototapete Walls by Patel iconic 3",
"brand" : "Fender",
"productType" : "guitar"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
ion-visual-product-search
400
ProductSearch exception
401
Authentication Error
403
Authorization Error
Up
delete /product/{product-id}/full
(deleteFullProduct)
Deletes product and its images from a site on a given product id
Path parameters
product-id (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"data" : {
"image-ids" : [ "1", "2" ],
"product-id" : "100258",
"site-id" : 25
},
"message" : "success"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
DeleteFullProduct_200_response
400
Could not delete the image
DeleteImageById_400_response
401
Authentication Error
403
Authorization Error
404
Unable to find any image of the product
DeleteFullProduct_404_response
Up
delete /image/{image-id}
(deleteImageById)
Deletes all images from a site on a given image id
Path parameters
image-id (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"data" : {
"number-of-products" : 2,
"site-id" : 25,
"image-id" : "1"
},
"message" : "success"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
DeleteImageById_200_response
400
Could not delete the image
DeleteImageById_400_response
401
Authentication Error
403
Authorization Error
404
Unable to find any matching image
DeleteImageById_404_response
Up
delete /product/{product-id}/image/{image-id}
(deleteImageByImageIdAndProductId)
Deletes all images from a site on given product and image ids
Path parameters
product-id (required)
Path Parameter — default: null
image-id (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"data" : {
"product-id" : "100258",
"site-id" : 25,
"url" : "http://mainUrl/image.jpg",
"image-id" : "1"
},
"message" : "success"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
AddImage_200_response
400
Could not delete the image
DeleteImageByImageIdAndProductId_400_response
401
Authentication Error
403
Authorization Error
404
Unable to find image.
DeleteImageByImageIdAndProductId_404_response
Up
delete /product/{product-id}
(deleteImageByProductId)
Deletes all images from a site on a given product id
Path parameters
product-id (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"data" : {
"image-ids" : [ "1", "2" ],
"product-id" : "100258",
"site-id" : 25
},
"message" : "success"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
DeleteFullProduct_200_response
400
Could not delete the image
DeleteImageById_400_response
401
Authentication Error
403
Authorization Error
404
Unable to find any image of the product
DeleteFullProduct_404_response
Up
get /search/session/{search-id}/detect-objects
(detectObjectsOfImageInExistingSession)
Get detected objects of image in existing session.
Path parameters
search-id (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"value" : [ {
"links" : {
"key" : {
"method" : "POST",
"href" : "https://openapi-generator.tech"
}
},
"value" : {
"score" : 6,
"classId" : 0,
"rectangle" : {
"top" : 0.3641,
"left" : 0,
"width" : 0.94,
"height" : 0.54175
},
"class" : "class"
}
}, {
"links" : {
"key" : {
"method" : "POST",
"href" : "https://openapi-generator.tech"
}
},
"value" : {
"score" : 6,
"classId" : 0,
"rectangle" : {
"top" : 0.3641,
"left" : 0,
"width" : 0.94,
"height" : 0.54175
},
"class" : "class"
}
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
detected objects response
ion-detected-objects
400
ProductSearch exception
401
Authentication Error
403
Authorization Error
Up
get /product/{product-id}/cross-selling-products
(getCrossSellingProductsToInputImage)
Return cross selling products to input one
Path parameters
product-id (required)
Path Parameter — default: null
Query parameters
cross-selling-products-count (optional)
Query Parameter — default: 10
campaigns (optional)
Query Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"image" : {
"thumbnail" : "http://mainUrl/thumbnail-image.jpg",
"original" : "http://mainUrl/image.jpg"
},
"productId" : "55fc5f71d6362321cb93b82b387e2f32",
"price" : {
"actual" : 39.95,
"sale" : 24.95
},
"groupId" : "55fc5f71d6362321cb93b82b387e2f32",
"deeplink" : "http://mainUrl/site/5/product/55fc5f71d6362321cb93b82b387e2f32/details",
"title" : "Livingwalls Fototapete Walls by Patel iconic 3",
"brand" : "Fender",
"productType" : "guitar"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
400
An exception occurred on load similar products
401
Authentication Error
403
Authorization Error
504
Wait timeout exception occured on load similar products
Up
get /product/{product-id}/cross-selling-products/{category}
(getCrossSellingProductsToInputImageInSpecificCategory)
Return cross selling products to input one in specific category
Path parameters
product-id (required)
Path Parameter — default: null
category (required)
Path Parameter — default: null
Query parameters
cross-selling-products-count (required)
Query Parameter — default: 10
campaigns (optional)
Query Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"image" : {
"thumbnail" : "http://mainUrl/thumbnail-image.jpg",
"original" : "http://mainUrl/image.jpg"
},
"productId" : "55fc5f71d6362321cb93b82b387e2f32",
"price" : {
"actual" : 39.95,
"sale" : 24.95
},
"groupId" : "55fc5f71d6362321cb93b82b387e2f32",
"deeplink" : "http://mainUrl/site/5/product/55fc5f71d6362321cb93b82b387e2f32/details",
"title" : "Livingwalls Fototapete Walls by Patel iconic 3",
"brand" : "Fender",
"productType" : "guitar"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
400
An exception occurred on load similar products
401
Authentication Error
403
Authorization Error
504
Wait timeout exception occured on load similar products
(getProducts)
Returns all products which has at least one image
Return type
Example data
Content-Type: application/json
{
"productIds" : [ "05848170643ab0deb9914566391c0c63", "0f4f08358666c54b4fde3d83d2b7ef04" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
products
400
An exception occurred on products
401
Authentication Error
403
Authorization Error
Up
get /product/{product-id}/similar-products
(getSimilarProductsToInputImage)
Return most similar products to input one
Path parameters
product-id (required)
Path Parameter — default: null
Query parameters
similar-products-count (optional)
Query Parameter — default: 10
campaigns (optional)
Query Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"extended" : [ null, null ],
"bestFits" : [ "b56764137ca959da9541bb28c1987d6c", "b5685a5230f5050475f214b4bb0e239b", "b56c560872da93602ff88c7267eb4774", "d861ad687c60820255dbf8f88516f24d" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
visual-product-recommendations
400
An exception occurred on load similar products
401
Authentication Error
403
Authorization Error
504
Wait timeout exception occured on load similar products
Up
get /product/{product-id}/similar-products/{category}
(getSimilarProductsToInputImageInSpecificCategory)
Return most similar products to input one in specific category
Path parameters
product-id (required)
Path Parameter — default: null
category (required)
Path Parameter — default: null
Query parameters
similar-products-count (required)
Query Parameter — default: 10
campaigns (optional)
Query Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"extended" : [ null, null ],
"bestFits" : [ "b56764137ca959da9541bb28c1987d6c", "b5685a5230f5050475f214b4bb0e239b", "b56c560872da93602ff88c7267eb4774", "d861ad687c60820255dbf8f88516f24d" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
visual-product-recommendations
400
An exception occurred on load similar products
401
Authentication Error
403
Authorization Error
504
Wait timeout exception occured on load similar products
(saveCategoryTree)
Save or publish the categoryTree
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
400
Could not save or publish the category
401
Authentication Error
403
Authorization Error
422
Invalid structure passed to endpoint
Up
put /product/{product-id}/annotation
(saveProduct)
Save or publish the product
Path parameters
product-id (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"data" : {
"data" : {
"custom_label_4" : "summer",
"custom_label_3" : "summer",
"custom_label_2" : "summer",
"custom_label_1" : "summer",
"product_detail" : "General:Product Type:Digital player,General:Digital Player Type:Flash based,Display:Resolution:432 x 240,Display:Diagonal Size:\"2.5\"",
"expiration_date" : "2016-02-24",
"custom_label_0" : "summer",
"product_highlight" : "\"Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies\", \"1080p maximum display resolution\"",
"excluded_destination" : [ "Display_ads", "Free_local_listings" ],
"shipping" : "US:94002-95460:0 USD",
"price" : 18.5,
"unit_pricing_measure" : "750ml",
"min_energy_efficiency_class" : "C",
"google_product_category" : "Apparel & Accessories > Clothing > Dresses",
"brand" : "Google",
"min_handling_time" : "1",
"size_type" : "petite",
"mpn" : "GO12345OOGLE",
"tax" : "US:900*-901*:9.5",
"max_energy_efficiency_class" : "A++",
"shipping_height" : "10 in",
"subscription_cost" : "month:12:50 EUR",
"is_bundle" : false,
"shopping_ads_excluded_country" : "CH, AT",
"condition" : "new",
"sale_price_effective_date" : "2016-02-24T13:00-0800/2016-02-29T15:30-0800",
"loyalty_points" : "Program A:100:0.5",
"size" : "XL",
"installment" : "6:50 BRL",
"shipping_weight" : "3 kg",
"shipping_label" : "oversized",
"adult" : true,
"transit_time_label" : "Dog food",
"shipping_width" : "40 in",
"color" : "Orange Mango Explosion",
"gender" : "female",
"link" : "http://mainUrl/image.jpg",
"pattern" : "Striped",
"item_group_id" : "AB12345",
"description" : "product description",
"multipack" : 6,
"promotion_id" : "tbby123_us",
"availability" : "in_stock",
"title" : "product title",
"ads_redirect" : "https://tracking.example.com?product=ballpoint-pens",
"cost_of_goods_sold" : "290.00 USD",
"max_handling_time" : "3",
"shipping_length" : "20 in",
"categories" : [ "13adf13e21", "a32b1def85" ],
"gtin" : "3234567890126, 123456788787, 98746543218",
"energy_efficiency_class" : "A+",
"unit_pricing_base_measure" : "100oz",
"age_group" : "infant",
"included_destination" : [ "Display_ads", "Free_local_listings" ],
"identifier_exists" : false,
"tax_category" : "apparel",
"sale_price" : 25.5,
"product_type" : "Home > Women > Dresses > Maxi Dresses, Home > Women > Dresses > Party Dresses",
"material" : "Leather",
"availability_date" : "2016-12-25T13:00-0800",
"size_system" : "UK"
},
"product-id" : "100257",
"site-id" : 11
},
"message" : "success"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
400
Could not save or publish the product
401
Authentication Error
403
Authorization Error
Up
get /search/session/{search-id}
(searchInExistingSession)
Starts a search in existing session.
Path parameters
search-id (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"uploadHighResolutionImage" : {
"rel" : [ "form", "form" ],
"value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
},
"detectedObjects" : [ {
"links" : {
"key" : {
"method" : "POST",
"href" : "https://openapi-generator.tech"
}
},
"value" : {
"score" : 6,
"classId" : 0,
"rectangle" : {
"top" : 0.3641,
"left" : 0,
"width" : 0.94,
"height" : 0.54175
},
"class" : "class"
}
}, {
"links" : {
"key" : {
"method" : "POST",
"href" : "https://openapi-generator.tech"
}
},
"value" : {
"score" : 6,
"classId" : 0,
"rectangle" : {
"top" : 0.3641,
"left" : 0,
"width" : 0.94,
"height" : 0.54175
},
"class" : "class"
}
} ],
"links" : {
"self" : {
"method" : "POST",
"href" : "/search/session/62cd4392853023-58137863"
}
},
"searchArea" : {
"rel" : [ "query-form", "query-form" ],
"value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
},
"filters" : {
"type" : "object",
"value" : {
"categories" : [ {
"name" : "Kinder"
}, {
"name" : "Kinder"
} ]
}
},
"type" : "array",
"value" : [ {
"image" : {
"thumbnail" : "http://mainUrl/thumbnail-image.jpg",
"original" : "http://mainUrl/image.jpg"
},
"productId" : "55fc5f71d6362321cb93b82b387e2f32",
"price" : {
"actual" : 39.95,
"sale" : 24.95
},
"groupId" : "55fc5f71d6362321cb93b82b387e2f32",
"deeplink" : "http://mainUrl/site/5/product/55fc5f71d6362321cb93b82b387e2f32/details",
"title" : "Livingwalls Fototapete Walls by Patel iconic 3",
"brand" : "Fender",
"productType" : "guitar"
}, {
"image" : {
"thumbnail" : "http://mainUrl/thumbnail-image.jpg",
"original" : "http://mainUrl/image.jpg"
},
"productId" : "55fc5f71d6362321cb93b82b387e2f32",
"price" : {
"actual" : 39.95,
"sale" : 24.95
},
"groupId" : "55fc5f71d6362321cb93b82b387e2f32",
"deeplink" : "http://mainUrl/site/5/product/55fc5f71d6362321cb93b82b387e2f32/details",
"title" : "Livingwalls Fototapete Walls by Patel iconic 3",
"brand" : "Fender",
"productType" : "guitar"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
ion-visual-product-search
400
ProductSearch exception
401
Authentication Error
403
Authorization Error
Up
get /search/session/{search-id}/category/{category}
(searchInExistingSessionWithCategory)
Starts a search in existing session in specific category.
Path parameters
search-id (required)
Path Parameter — default: null
category (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"uploadHighResolutionImage" : {
"rel" : [ "form", "form" ],
"value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
},
"detectedObjects" : [ {
"links" : {
"key" : {
"method" : "POST",
"href" : "https://openapi-generator.tech"
}
},
"value" : {
"score" : 6,
"classId" : 0,
"rectangle" : {
"top" : 0.3641,
"left" : 0,
"width" : 0.94,
"height" : 0.54175
},
"class" : "class"
}
}, {
"links" : {
"key" : {
"method" : "POST",
"href" : "https://openapi-generator.tech"
}
},
"value" : {
"score" : 6,
"classId" : 0,
"rectangle" : {
"top" : 0.3641,
"left" : 0,
"width" : 0.94,
"height" : 0.54175
},
"class" : "class"
}
} ],
"links" : {
"self" : {
"method" : "POST",
"href" : "/search/session/62cd4392853023-58137863"
}
},
"searchArea" : {
"rel" : [ "query-form", "query-form" ],
"value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
},
"filters" : {
"type" : "object",
"value" : {
"categories" : [ {
"name" : "Kinder"
}, {
"name" : "Kinder"
} ]
}
},
"type" : "array",
"value" : [ {
"image" : {
"thumbnail" : "http://mainUrl/thumbnail-image.jpg",
"original" : "http://mainUrl/image.jpg"
},
"productId" : "55fc5f71d6362321cb93b82b387e2f32",
"price" : {
"actual" : 39.95,
"sale" : 24.95
},
"groupId" : "55fc5f71d6362321cb93b82b387e2f32",
"deeplink" : "http://mainUrl/site/5/product/55fc5f71d6362321cb93b82b387e2f32/details",
"title" : "Livingwalls Fototapete Walls by Patel iconic 3",
"brand" : "Fender",
"productType" : "guitar"
}, {
"image" : {
"thumbnail" : "http://mainUrl/thumbnail-image.jpg",
"original" : "http://mainUrl/image.jpg"
},
"productId" : "55fc5f71d6362321cb93b82b387e2f32",
"price" : {
"actual" : 39.95,
"sale" : 24.95
},
"groupId" : "55fc5f71d6362321cb93b82b387e2f32",
"deeplink" : "http://mainUrl/site/5/product/55fc5f71d6362321cb93b82b387e2f32/details",
"title" : "Livingwalls Fototapete Walls by Patel iconic 3",
"brand" : "Fender",
"productType" : "guitar"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
ion-visual-product-search
400
ProductSearch exception
401
Authentication Error
403
Authorization Error
Up
put /search/session/{search-id}/upload-image
(uploadHighResolutionImageToExistingSession)
Upload high resolution image to existing session.
Path parameters
search-id (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"message" : "success"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
success
UploadHighResolutionImageToExistingSession_200_response
400
ProductSearch exception
401
Authentication Error
403
Authorization Error
[ Jump to Methods ]
Table of Contents
AddImage_200_response - AddImage_400_response - AddImage_404_response - Category_tree - Category-treeDeleteFullProduct_200_response - DeleteFullProduct_404_response - DeleteImageById_200_response - DeleteImageById_400_response - DeleteImageById_404_response - DeleteImageByImageIdAndProductId_400_response - DeleteImageByImageIdAndProductId_404_response - Product_data_object - Product data objectProduct_data_object_1 - Product data objectSaveProduct_request - UploadHighResolutionImageToExistingSession_200_response - category-filter - delete-image-by-imageId - delete-image-by-productId-and-imageId-400-error - delete-image-by-productId-and-imageId-404-error - delete-image-error - delete-product-images-by-productId - image-by-productId-and-imageId - ion-detected-object - ion-detected-object-rectangle - ion-detected-object-value - ion-detected-objects - ion-link - ion-visual-product-search - ion_visual_product_search_filters - ion_visual_product_search_filters_value - name-value-item - product - product-annotation-images - Product images objectproduct-data - products - search-area - upload-high-resolution-image - visual-product-recommendations - visual-product-search-object - visual_product_search_object_image - visual_product_search_object_price -
message (optional)
data (optional)
message (optional)
data (optional)
debug (optional)
message (optional)
data (optional)
message (optional)
data (optional)
message (optional)
data (optional)
message (optional)
data (optional)
message (optional)
data (optional)
debug (optional)
message (optional)
data (optional)
message (optional)
data (optional)
debug (optional)
message (optional)
data (optional)
message
data
debug (optional)
data (optional)
images (optional)
siteMinusid (optional)
numberMinusofMinusproducts (optional)
imageMinusid (optional)
siteId (optional)
imageCode (optional)
productCode (optional)
siteMinusid (optional)
productMinusid (optional)
imageMinusid (optional)
siteMinusid (optional)
imageMinusid (optional)
siteMinusid (optional)
productMinusid (optional)
imageMinusids (optional)
siteMinusid (optional)
productMinusid (optional)
imageMinusid (optional)
url (optional)
value (optional)
links (optional)
left (optional)
top (optional)
width (optional)
height (optional)
classId (optional)
class (optional)
score (optional)
rectangle (optional)
value (optional)
type (optional)
searchArea (optional)
uploadHighResolutionImage (optional)
filters (optional)
links (optional)
detectedObjects (optional)
type (optional)
value (optional)
siteMinusid (optional)
productMinusid (optional)
data (optional)
title
description (optional)
link (optional)
availability (optional)
in_stock
out_of_stock
preorder
backorder
availability_date (optional)
String format: YYYY-MM-DDThh:mm:ssZ
cost_of_goods_sold (optional)
expiration_date (optional)
price (optional)
sale_price (optional)
sale_price_effective_date (optional)
String format: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
unit_pricing_measure (optional)
unit_pricing_base_measure (optional)
installment (optional)
subscription_cost (optional)
loyalty_points (optional)
google_product_category (optional)
product_type (optional)
brand (optional)
gtin (optional)
mpn (optional)
identifier_exists (optional)
condition (optional)
new
refurbished
used
adult (optional)
multipack (optional)
is_bundle (optional)
energy_efficiency_class (optional)
A+++
A++
A+
A
B
C
D
E
F
G
min_energy_efficiency_class (optional)
A+++
A++
A+
A
B
C
D
E
F
G
max_energy_efficiency_class (optional)
A+++
A++
A+
A
B
C
D
E
F
G
age_group (optional)
newborn
infant
toddler
kids
adult
color (optional)
gender (optional)
male
female
unisex
material (optional)
pattern (optional)
size (optional)
size_type (optional)
regular
petite
tall
plus
big
maternity
size_system (optional)
AU
BR
CN
DE
EU
FR
IT
JP
MEX
UK
US
item_group_id (optional)
ads_redirect (optional)
custom_label_0 (optional)
custom_label_1 (optional)
custom_label_2 (optional)
custom_label_3 (optional)
custom_label_4 (optional)
promotion_id (optional)
excluded_destination (optional)
Shopping_ads
Buy_on_Google_listings
Display_ads
Local_inventory_ads
Free_listings
Free_local_listings
included_destination (optional)
Shopping_ads
Buy_on_Google_listings
Display_ads
Local_inventory_ads
Free_listings
Free_local_listings
shipping (optional)
shipping_label (optional)
shipping_weight (optional)
shipping_length (optional)
shipping_width (optional)
shipping_height (optional)
transit_time_label (optional)
max_handling_time (optional)
min_handling_time (optional)
tax (optional)
tax_category (optional)
product_detail (optional)
shopping_ads_excluded_country (optional)
product_highlight (optional)
categories (optional)
bestFits (optional)
extended (optional)
groupId (optional)
productId (optional)
title (optional)
deeplink (optional)
String link to the product detail page
brand (optional)
productType (optional)
image (optional)
price (optional)
original (optional)
thumbnail (optional)
actual (optional)
sale (optional)