object {
-
href
(string):
Description:
Link to self
Format:
Uri
Required:
True
-
id
(integer):
Description:
Unique id of the resource
Required:
True
Minimum:
1
-
is_active
(boolean):
Description:
Indicates if (true) this product is active or (false) inactive.
Required:
True
-
createdate
(string):
Description:
Create date of product in UTC
Format:
Date-time
Required:
True
-
modifydate
(string):
Description:
Last modify date of product in UTC
Format:
Date-time
Required:
True
-
productnumber
(string):
Description:
Product number
Maxlength:
50
Required:
True
-
eannumber
(string):
Description:
EAN (European Article Number)
Maxlength:
50
Required:
True
-
mpnnumber
(string):
Description:
Manufacturer Product Number
Maxlength:
50
Required:
True
-
is_multishop_product
(boolean):
Description:
Indicates if (true) this product is managed in a multishop or (false) is a single webshop product. Multishop products can't be fully editted.
Required:
True
-
multishop_product_id
(integer|null):
Description:
Unique id of the resource from multishop system. Returns null when
is_multishop_product = false
OR
(if applicable) requested webshop_id = multishop_system_id.
Required:
True
-
multishop_href
(string|null):
Description:
Href to this system's product. This is only available with the proper api credentials.
Required:
True
Format:
Uri
-
name
(string):
Description:
Product name
Maxlength:
200
Required:
True
-
shortdescription
(string):
Description:
Product short description
Maxlength:
255
Required:
True
-
description
(string):
Description:
Product description
Maxlength:
65536
-
vatrate
(number):
Description:
Deprecated. VAT rate of product in percentage.
Minimum:
0
Maximum:
100
Required:
True
-
taxtariff
(string):
Description:
The tax tariff of the product
Enum:
normal
low A
low B
extra low
zero
Required:
True
-
tradecodesystem
(object|null):
Description:
Describes the information of the tradecodesystem from this product.
Required:
False
Expandable:
False
AdditionalProperties:
False
{
-
id
(integer):
Description:
The tradecodesystem Id.
Required:
True
-
description
(string):
Description:
Description/classification of the tradecode.
Required:
False
-
codesystem
(string):
Description:
The code system used.
Enum:
HS_2022
HS_2007
HS_2002
HS_1996
HS_1992
SITC_4
SITC_3
SITC_2
SITC_1
BEC_4
ISIC_4
Required:
True
-
code
(string):
Description:
HS, SITC or BEC code.
Required:
True
-
coo
(string|null):
Description:
Country of origin Alpha-2 code. See ISO 3166-1
Maxlength:
2
}
-
price
(number):
Description:
Original price of the product, before discounts
Minimum:
0
Required:
True
-
discount
(number):
Description:
Discount on the product. Price - Discount = Sell price
Required:
True
-
purchaseprice
(number):
Description:
Purchase price ex. VAT off this product.
Minimum:
0
Required:
True
-
container_deposit_price
(number):
Description:
This price will be added to the total price as a container deposit (in Dutch: Statiegeld).
Required:
True
-
safety_deposit_price
(number):
Description:
This price will be added to the total price as a safety deposit (in Dutch: Borg).
Required:
True
-
productshippingcosts
(object):
Description:
Describes the bases shipping costs and a link to shipping costs per country.
Required:
True
Expandable:
True
AdditionalProperties:
False
{
-
costs
(number):
Description:
Indication of shipping costs if only one item would be baught and shipped to the default country.
Minimum:
0
Required:
True
-
default_country
(string|null):
Description:
This is the default country products are shipped to. Country Alpha-2 code. See ISO 3166-1 and ISO 3166-2.
MaxLength:
6
Required:
True
-
quantity
(number):
Description:
Quantity of items shipped. Default is 1. Can be changed with parameters.
Minimum:
1
Required:
True
-
href
(string):
Description:
Link to collection of product shipping costs.
Required:
True
Format:
Uri
-
collection
(array):
Description:
Array with collection items
Required:
True
AdditionalProperties:
True
[
-
-
costs
(number):
Description:
Indication of shipping costs if the quantity of items would be baught and shipped to this country.
Minimum:
0
Required:
True
-
quantity
(number):
Description:
Quantity of items shipped. Default is 1. Can be changed with parameters.
Minimum:
1
Required:
True
-
country
(string):
Description:
This is the country products are shipped to. Country Alpha-2 code. See ISO 3166-1 and ISO 3166-2.
MaxLength:
6
Required:
True
]
}
-
credit_points_custom
(integer|null):
Description:
Custom creditpoints for this product
Required:
False
-
credit_points_calculated
(integer):
Description:
Calculated creditpoints for this product
Required:
False
-
unit
(string):
Description:
The unit in which this product is sold (ie 'per piece')
-
stockenabled
(boolean):
Description:
This product has stock
-
stocktype
(string|null):
Description:
If the stock amount is linked to the product of the attribute combination
Enum:
Product
Attribute
Required:
True
-
stock
(number|null):
Description:
The quantity in stock for this product
Required:
True
-
stocklocation
(string):
Description:
The location of the product's stock
Maxlength:
255
Required:
True
-
ordering_without_stock
(string):
Description:
Allow or dissallow ordering of this product when there is no stock. The default option 'global_setting' means the global webshop setting 'Starting point > My web shop > Settings > Ordering process & stock > Stock Options Allow the sale of more products than in stock' will be used for this product.
Enum:
allow
disallow
global_setting
Required:
False
-
weight
(number):
Description:
Weight of the product in kilograms
Minimum:
0
Required:
True
-
maincategory
(string):
Description:
The main categorie of this product.
-
subcategory
(string):
Description:
The sub categorie of this product.
Required:
True
-
brand
(object):
Description:
Brand resource
{
-
href
(string):
Description:
Link to brand resource
Required:
False
Format:
Uri
-
id
(integer):
Description:
Brand Id
Required:
False
-
name
(string):
Description:
Brand name
Required:
False
}
-
condition
(object):
Description:
Condition resource
{
-
href
(string):
Description:
Link to condition resource
Required:
False
Format:
Uri
-
id
(integer):
Description:
Condition Id
Required:
False
-
name
(string):
Description:
Condition name
Required:
False
}
-
color
(object|null):
Description:
A color resource. It will be NULL if the product has not color. Product colors can be used to filter results.
Required:
True
{
-
href
(string):
Description:
Link to color resource
Required:
True
Format:
Uri
-
id
(integer):
Description:
Color Id
Required:
True
-
name
(string):
Description:
Color name
Required:
True
-
type
(string):
Description:
The type of color. A 'color' will have a hex color code. Exceptions are transparent and multicolor.
Enum:
color
multicolor
transparent
Required:
True
-
hex
(string|null):
Description:
Hex color code. Exceptions are transparent and multicolor. Then this is null.
MinLength:
7
MaxLength:
7
Required:
True
}
-
productmainphoto
(string|null):
Description:
Link to mainphoto
Format:
Uri
Required:
True
-
meta_description
(string):
Description:
Metatag Description
Required:
True
-
meta_keywords
(string):
Description:
Metatag Keywords
Required:
True
-
page_title
(string):
Description:
Page title
Required:
True
-
no_index
(boolean):
Description:
Metatag robots: No-Index
Required:
True
-
no_follow
(boolean):
Description:
Metatag robots: No-Follow
Required:
True
-
alias
(string):
Description:
SEO Alias of this resource
Required:
True
-
deeplink
(string):
Description:
Deeplink to this resource
Required:
True
-
specs
(string|null):
Description:
Specification link
Format:
Uri
Required:
True
-
decimal_amount
(integer):
Description:
Number of decimals that can be used in amounts
Min:
0
Required:
True
-
amount_sold
(number):
Description:
Number of items sold
Min:
0
Required:
False
-
minimal_order_amount
(number):
Description:
Minimal order amount
Min:
0.001
Required:
True
-
stock_delivery_number
(integer):
Description:
Expected delivery time, number of days, weeks, months, quarters, years
Min:
1
Max:
31
Required:
True
-
stock_delivery_type
(string):
Description:
Expected delivery type
Enum:
days
weeks
months
quarters
years
outofstock
temporarilysoldout
ordered
onrequest
unknown
Required:
True
-
stock_delivery_standard
(string):
Description:
This field will be showed as the standard delivery text
Required:
True
-
show_in_template
(boolean):
Description:
Show the product in the window offers
Required:
True
-
show_on_beginpage
(boolean):
Description:
Show the product as a offer at the beginpage or offer element
Required:
True
-
show_on_facebook
(boolean):
Description:
Show the product in the facebook shop when available
Required:
True
-
show_order_button
(string):
Description:
Show order/offer button.
Y=show
QUOTATION=offer button
N=No button
Enum:
Y
QUOTATION
N
Required:
True
-
product_layout
(integer):
Description:
Product Layout
1=Standard layout,
2=Quick order,
3=Split layout,
4=Tab Layout
Min:
1
Max:
4
Required:
True
-
photo_size
(string):
Description:
The photo description size
Enum:
NONE
SMALL
BIG
Required:
True
-
hide_without_category
(string):
Description:
Hide the products without categories.
YES=Hide,
NO_DIRECTLINK=No, the product can be found by direct url,
NO_SEARCHRESULTS=No, Product can be found in the searchresults
Enum:
YES
NO_DIRECTLINK
NO_SEARCHRESULTS
Required:
True
-
memo
(string):
Description:
Internal memo for internal purpose only
Required:
True
-
marktplaats_active
(boolean):
Description:
Enable / disable Marktplaats.
Required:
False
-
marktplaats_status
(string|null):
Description:
The status for this advertisement
Enum:
ACTIVE
PAUSED
DELETED
UNKNOWN
Required:
False
-
marktplaats_cpc
(number):
Description:
Cost per click in euro cents
Min:
1
Max:
250
Required:
False
-
marktplaats_daily_budget
(number):
Description:
Daily budget for this advertisement in euro cents
Min:
10
Required:
False
-
marktplaats_total_budget
(number):
Description:
Total budget for this advertisement in euro cents. You can use 0 euro cents for a infinite total budget or 5000 euro cents as minimum.
Required:
False
-
marktplaats_category_id
(integer):
Description:
The Marktplaats category Id
Min:
1
Required:
False
-
marktplaats_price_type
(string|null):
Description:
The price type
Enum:
FIXED_PRICE
NEGOTIABLE
ON_DEMAND
Required:
False
-
google_shopping_category
(string|null):
Description:
Google Shopping Category. Corresponds with the values given by Google. See: https://support.google.com/merchants/answer/160081#sel_csv
Maxlength:
200
Required:
False
-
package
(object):
Description:
Package of this product.
{
-
href
(string):
Description:
Link to package resource
Required:
True
Format:
Uri
-
id
(integer):
Description:
Package Id
Required:
True
}
-
supplier
(object):
Description:
Supplier resource
{
-
href
(string):
Description:
Link to supplier resource
Required:
False
Format:
Uri
-
id
(integer):
Description:
Supplier Id
Required:
False
-
name
(string):
Description:
Supplier name
Required:
False
}
-
is_included_for_export_feed
(boolean):
Description:
Is this product included in the export feed
-
fixed_staggered_prices
(boolean):
Description:
Fixed staggered prices enabled
Required:
True
-
is_visible
(boolean):
Description:
Is this product visible in the webshop
Required:
True
-
can_be_ordered
(boolean):
Description:
Can this product be ordered in the webshop
Required:
True
-
productlabels
(object):
Description:
Product labels
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of product labels
Required:
True
Format:
Uri
}
-
productphotos
(object):
Description:
Product photos
Expandable:
True
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of product photos
Required:
True
Format:
Uri
-
collection
(array):
Description:
Array with collection items
Required:
True
AdditionalProperties:
False
[
-
-
href
(string):
Description:
Link to self
Required:
True
Format:
Uri
-
id
(integer):
Description:
Product photo id
Required:
True
-
filename
(string):
Description:
Product photo filename
Required:
True
-
alttext
(string):
Description:
Product photo alttext
Required:
False
Maxlength:
255
-
is_mainphoto
(boolean):
Description:
Product photo marked as mainphoto
Required:
True
-
deeplink
(string):
Description:
Product photo deeplink
Format:
Uri
Required:
True
-
parent
(object):
Description:
Parent resource of this resource
AdditionalProperties:
False
{
-
href
(string):
Description:
Link to photo
Required:
True
Format:
Uri
}
]
}
-
productvariations
(object):
Description:
Product variations
Expandable:
True
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of product variations
Required:
True
Format:
Uri
-
collection
(array):
Description:
Array with collection items
Required:
True
AdditionalProperties:
False
[
-
-
href
(string):
Description:
Link to self
Required:
True
Format:
Uri
-
id
(integer):
Description:
Product variation id
Required:
True
-
product_variation_id
(integer):
Description:
Product Id that is linked as variation.
Required:
True
-
product_variation_href
(string):
Description:
Href to the product that is linked as variation.
Format:
Uri
Required:
True
-
auto_created
(boolean):
Description:
If variations are created on product number, then these are marked as 'auto_created'. These can't be deleted, only deactived.
Required:
True
-
active
(boolean):
Description:
Inactive variation are hidden in the webshop.
Required:
True
-
parent
(object):
Description:
Contains link to parent product
AdditionalProperties:
False
{
-
href
(string):
Description:
Link to product
Required:
True
Format:
Uri
}
]
}
-
productvideos
(object):
Description:
Product videos
Expandable:
True
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of product videos
Required:
True
Format:
Uri
-
collection
(array):
Description:
Array with collection items
Required:
True
AdditionalProperties:
False
[
-
-
href
(string):
Description:
Link to self
Required:
True
Format:
Uri
-
id
(integer):
Description:
Product video id
Required:
True
-
productid
(integer):
Description:
Product video productid
Required:
True
-
name
(string):
Description:
Product video name
Required:
False
Maxlength:
255
-
position
(integer):
Description:
Product video position
Required:
True
Minimum:
1
-
embedcode
(string):
Description:
Product video embed code
Required:
True
-
parent
(object):
Description:
Contains link to parent product
AdditionalProperties:
False
{
-
href
(string):
Description:
Link to product
Required:
True
Format:
Uri
}
]
}
-
producttaxtariffexceptions
(object):
Description:
Product tax tariff exceptions
Expandable:
True
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of product tax tariff exceptions
Required:
True
Format:
Uri
-
collection
(array):
Description:
Array with collection items
Required:
True
AdditionalProperties:
False
[
-
-
href
(string):
Description:
Link to self
Required:
True
Format:
Uri
-
id
(integer):
Description:
Unique id of the resource.
Minimum:
0
Required:
True
-
product_id
(integer):
Description:
Unique id of the product
Maxlength:
255
Required:
True
-
country
(string):
Description:
ISO 2Code for the country of the tax tariff exception.
Maxlength:
2
Required:
True
-
taxtariff
(string):
Description:
The tax tariff of the exception
Enum:
normal
low A
low B
extra low
zero
Required:
True
-
parent
(object):
Description:
Contains link to parent product
AdditionalProperties:
False
{
-
href
(string):
Description:
Link to product
Required:
True
Format:
Uri
}
]
}
-
productattachments
(object):
Description:
Product attachments
Expandable:
True
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of product attachments
Required:
True
Format:
Uri
-
collection
(array):
Description:
Array with collection items
Required:
True
AdditionalProperties:
False
[
-
-
href
(string):
Description:
Link to self
Required:
True
Format:
Uri
-
id
(integer):
Description:
Attachment id
Required:
True
Minimum:
1
-
filename
(string):
Description:
File name
Required:
True
Maxlength:
100
-
displayname
(string):
Description:
Display name of the file.
Required:
True
Maxlength:
45
-
position
(integer):
Description:
Position compared to other product attachments. Starting at 1.
Required:
True
Minimum:
1
-
deeplink
(string):
Description:
Deeplink to the file. This link will result in a file which can be downloaded.
Required:
True
Format:
Uri
-
parent
(object):
Description:
Contains link to parent resource.
AdditionalProperties:
False
{
-
href
(string):
Description:
Link to product attachment parent
Required:
True
Format:
Uri
}
]
}
-
productkeywords
(object):
Description:
These keyswords are used for the tagcloud and internal search engine on the webshop
Expandable:
True
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of product keywords
Required:
True
Format:
Uri
-
collection
(array):
Description:
Array with collection items
Required:
True
AdditionalProperties:
False
[
-
-
keyword
(string):
Description:
Product keyword
Required:
True
Maxlength:
255
-
parent
(object):
Description:
Contains link to parent product
AdditionalProperties:
False
{
-
href
(string):
Description:
Link to product
Required:
True
Format:
Uri
}
]
}
-
productrelevant
(object):
Description:
Relevant product
Expandable:
True
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of relevant products
Required:
True
Format:
Uri
-
collection
(array):
Description:
Array with collection items
Required:
True
AdditionalProperties:
False
[
-
-
href
(string):
Description:
Link to self
Format:
Uri
Required:
True
-
id
(integer):
Description:
Unique id of the resource
Required:
True
Minimum:
1
-
child_product_id
(integer):
Description:
Unique id of the child product. This is product will show on the parent product page as a relevant product.
Required:
True
Minimum:
1
-
parent_product_id
(integer):
Description:
Unique id of the parent product. This is product will show all the child product on the product page as relevant products.
Required:
True
Minimum:
1
-
child_product
(object):
Description:
The child product
Required:
False
{
-
href
(string):
Description:
Link to the child product
Required:
False
}
-
parent_product
(object):
Description:
The parent product
Required:
False
{
-
href
(string):
Description:
Link to the parent product
Required:
False
}
-
parent
(object):
Description:
Parent resource of this resource
Required:
False
{
-
href
(string):
Description:
Link to all relevant products of parent product.
Required:
False
}
]
}
-
productattributesets
(object):
Description:
Attribute sets
Expandable:
True
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of attribute sets
Required:
True
Format:
Uri
-
collection
(array):
Description:
Array with collection items
Required:
True
AdditionalProperties:
False
[
-
-
id
(integer):
Description:
Attributeset id
Required:
True
Min:
1
-
attributename
(string):
Description:
Attributeset name
Required:
True
-
attributeposition
(integer):
Description:
Attributeset position
Required:
True
Min:
1
-
type
(string):
Description:
Attributeset type
Enum:
1
2
3
4
5
6
Required:
True
-
items
(array):
Description:
Collection of attribute values
Required:
True
[
-
-
Array of object:
Description:
A product attributes items with options
{
-
href
(string):
Description:
Link to attribute values
Format:
Uri
Required:
False
-
id
(integer):
Description:
Product 2 attribute ID
Required:
True
Min:
1
-
optionsname
(string):
Description:
Option value name
Required:
True
Min:
1
-
price
(number):
Description:
Extra price of this attribute value
Required:
True
Min:
1
-
enable
(boolean):
Description:
Deprecated. Attribute option value enable. Value is always true.
Required:
True
-
position
(integer):
Description:
Position starting from 1
Required:
True
Min:
1
}
]
-
parent
(object):
Description:
Contains link to parent product
AdditionalProperties:
False
{
-
href
(string):
Description:
Link to product resource
Required:
True
Format:
Uri
}
]
}
-
productstaggeredprices
(object):
Description:
Product staggered prices
Expandable:
True
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of staggered prices
Required:
True
Format:
Uri
-
collection
(array):
Description:
Array with collection items
Required:
True
AdditionalProperties:
False
[
-
-
href
(string):
Description:
Link to self
Format:
Uri
Required:
False
-
id
(integer):
Description:
Staggered price id
Required:
False
-
quantity
(number):
Description:
Number of products
Required:
False
Minimum:
0.001
-
price
(number):
Description:
Price of products
Required:
False
Minimum:
0
-
discount
(number):
Description:
Discount of products
Required:
False
-
sellprice
(number):
Description:
Sellprice of products
Required:
False
-
parent
(object):
Description:
Contains link to parent product
AdditionalProperties:
False
{
-
href
(string):
Description:
Link to product
Required:
True
Format:
Uri
}
]
}
-
producttocategories
(object):
Description:
Product categories
Expandable:
True
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of product categories
Required:
False
Format:
Uri
-
collection
(array):
Description:
Array with collection items
Required:
True
AdditionalProperties:
False
[
-
-
href
(string):
Description:
Link to self
Format:
Uri
Required:
False
-
id
(integer):
Description:
Unique id of the resource
Required:
False
Minimum:
1
-
position
(integer):
Description:
Position of product in category
Required:
False
-
product_id
(integer):
Description:
Unique id of the product
Required:
False
Minimum:
1
-
category_id
(integer):
Description:
Unique id of the category
Required:
False
-
product_href
(string):
Description:
Link to product
Format:
Uri
Required:
False
-
category_href
(string):
Description:
Link to category
Format:
Uri
Required:
False
]
}
-
productreviews
(object):
Description:
Product reviews
Expandable:
True
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of reviews.
Required:
False
Format:
Uri
-
collection
(array):
Description:
Array with review items
Required:
False
AdditionalProperties:
True
[
-
-
href
(string):
Description:
Link to self.
Format:
Uri
Required:
True
-
id
(integer):
Description:
Unique id of the resource.
Minimum:
0
Required:
True
-
productid
(integer):
Description:
The ID of the product the review refers to.
Minimum:
0
Required:
True
-
createdate
(string|null):
Description:
Review createdate.
Format:
Date-time
Maxlength:
255
Required:
True
-
content
(string):
Description:
The contents of the review.
Required:
True
-
points
(integer):
Description:
Amount of points the reviewer has awarded.
Required:
True
-
name
(string):
Description:
The reviewer's name.
Required:
True
-
approved
(boolean):
Description:
Is the review approved for publishing.
Required:
True
]
}
-
webshops
(object):
Description:
Collection of webshops in which this product is connected. Empty if this is not a multishop product.
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of webshops.
Required:
False
Format:
Uri
}
-
attributecombinations
(object):
Description:
Attribute combination
Expandable:
True
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of attribute combination
Required:
True
Format:
Uri
-
collection
(array):
Description:
Array with collection items
Required:
True
AdditionalProperties:
False
[
-
-
href
(string):
Description:
Link to self
Format:
Uri
Required:
True
-
id
(integer):
Description:
Unique id of the resource
Minimum:
1
Required:
True
-
note
(string):
Description:
A description of the attribute combination
Required:
True
-
product_id
(integer):
Description:
Unique product id of the resource
Minimum:
1
Required:
True
-
stock
(number):
Description:
The stock of the attribute combination
Required:
True
-
netto_extra_price
(number):
Description:
The sum of all extra prices of the attribute values which build up this combination. This can also be a negative number.
Required:
True
-
ordering_without_stock
(string):
Description:
Allow or disallow ordering of this attribute combination when there is no stock. The default option 'global_setting' means the global webshop setting. See the resource 'settings', GET /:version/webshops/:id/settings
Enum:
allow
disallow
global_setting
Required:
True
-
product_number
(string):
Description:
The product number
MaxLength:
64
Required:
True
-
ean_number
(string):
Description:
The ean number
MaxLength:
50
Required:
True
-
sku_number
(string):
Description:
The sku number
MaxLength:
128
Required:
True
-
delivery_time
(integer):
Description:
Expected delivery time, number of days, weeks, months, quarters, years
Min:
1
Max:
31
Required:
True
-
delivery_time_type
(string):
Description:
Expected delivery type days, weeks, months, quarters, years, outofstock, temporarilysoldout, ordered, onrequest, unknown
Enum:
days
weeks
months
quarters
years
outofstock
temporarilysoldout
ordered
onrequest
unknown
Required:
True
-
delivery_default_text
(string):
Description:
The delivery time default in text
MaxLength:
1000
Required:
True
-
active
(boolean):
Description:
If this combination is active. Inactive combinations can not be selected by the customer.
Required:
True
-
combination
(array):
Description:
Collection of attribute values that combined create this attribute combination.
Required:
True
[
-
-
Array of object:
Description:
A single attribute values that combined with the other values in this array create the attribute combination.
AdditionalProperties:
False
Required:
True
{
-
attribute
(object):
Description:
Describes the attribute set.
Required:
True
AdditionalProperties:
False
{
-
id
(integer):
Description:
Id of the attribute set.
Required:
True
-
name
(string):
Description:
Name of the attribute set.
Required:
True
-
href
(string):
Description:
Link of the attribute set.
Format:
Uri
Required:
True
}
-
attribute_value
(object):
Description:
Describes the attribute value in the attribute set.
Required:
True
AdditionalProperties:
False
{
-
id
(integer):
Description:
Id of the attribute value.
Required:
True
-
name
(string):
Description:
Name of the attribute value.
Required:
True
-
href
(string):
Description:
Link of the attribute value.
Format:
Uri
Required:
True
}
-
extra_price
(number):
Description:
The extra price that is calculated when selecting this attribute value.
Required:
True
}
]
-
attributecombinationphotos
(object):
Description:
Attribute combination photos
Expandable:
True
AdditionalProperties:
False
Required:
True
{
-
href
(string):
Description:
Link to collection of attribute combination photo belonging to the combination
Required:
True
Format:
Uri
-
collection
(array):
Description:
Array with collection items
Required:
True
AdditionalProperties:
False
[
-
-
href
(string):
Description:
Link to self
Required:
True
Format:
Uri
-
id
(integer):
Description:
Combination photo id
Required:
True
-
alt
(string):
Description:
Product photo alttext
Required:
False
Maxlength:
128
-
is_mainphoto
(boolean):
Description:
Combination photo marked as mainphoto
Required:
True
-
deeplink
(string):
Description:
Combination photo deeplink
Format:
Uri
Required:
True
-
parent
(object):
Description:
Contains link to parent resource.
AdditionalProperties:
False
{
-
href
(string):
Description:
Link to attribute combination
Required:
True
Format:
Uri
}
]
}
-
attributes
(object):
Description:
Collection of attributes
AdditionalProperties:
False
Required:
True
{
-
href
(string):
Description:
Link to collection of attributes belonging to the combination
Required:
False
Format:
Uri
}
-
attributevalues
(object):
Description:
Collection of
attributevalues
AdditionalProperties:
False
Required:
True
{
-
href
(string):
Description:
Link to collection of attribute values belonging to the combination
Required:
False
Format:
Uri
}
-
parent
(object):
Description:
Contains link to parent resource.
AdditionalProperties:
False
Required:
True
{
-
href
(string):
Description:
Link to attributecombination collection
Required:
True
Format:
Uri
}
]
}
-
producttopropertygroups
(object):
Description:
Collection of product property groups.
Expandable:
True
AdditionalProperties:
True
Required:
False
{
-
href
(string):
Description:
Link to collection of product property groups.
Required:
False
Format:
Uri
}
}