Products

Retrieve a product given an ID

get
Autorizações
AuthorizationstringObrigatório
Bearer authentication header of the form Bearer <token>.
Parâmetros de rota
idstringObrigatório
Parâmetros de consulta
summarybooleanOpcionalDefault: false
Respostas
chevron-right
200

OK

application/json
idstringOpcional
activebooleanOpcional
namestringOpcional
skustringOpcional
short_descriptionstringOpcional
long_descriptionstringOpcional
ean_gtinstringOpcional
brand_idstringOpcional
brand_namestringOpcional
video_urlstringOpcional
pricenumberOpcional
stocknumberOpcional
warehouse_defaultstringOpcional
warehouse_default_namestringOpcional
maximum_discountnumberOpcional
minimum_stocknumberOpcional
minimum_for_salenumberOpcional
multiple_for_salenumberOpcional
standard_unit_idstringOpcional
standard_unit_namestringOpcional
standard_unit_abbreviationstringOpcional
standard_unit_decimals_for_quantitynumberOpcional
category_idstringOpcional
category_namestringOpcional
product_weightnumberOpcional
product_widthnumberOpcional
product_heightnumberOpcional
product_depthnumberOpcional
packaging_weightnumberOpcional
packaging_widthnumberOpcional
packaging_heightnumberOpcional
packaging_depthnumberOpcional
highlightbooleanOpcional
seo_titlestringOpcional
seo_descriptionstringOpcional
seo_meta_keywordsstring[]Opcional
maximum_markupnumberOpcional
tagsstring[]Opcional
get
/products/{id}

Update a existing product

put
Autorizações
AuthorizationstringObrigatório
Bearer authentication header of the form Bearer <token>.
Parâmetros de rota
idstringObrigatório
Corpo
activebooleanObrigatório
namestringObrigatório
skustringObrigatório
short_descriptionstringObrigatório
long_descriptionstringObrigatório
ean_gtinstringObrigatório
brand_idstringObrigatório
video_urlstringObrigatório
pricenumberObrigatório
stocknumberObrigatório
warehouse_defaultstringOpcional
maximum_discountnumberOpcional
minimum_stocknumberObrigatório
minimum_for_salenumberObrigatório
multiple_for_salenumberObrigatório
standard_unit_idstringOpcional
category_idstringObrigatório
product_weightnumberObrigatório
product_widthnumberObrigatório
product_heightnumberObrigatório
product_depthnumberObrigatório
packaging_weightnumberObrigatório
packaging_widthnumberObrigatório
packaging_heightnumberObrigatório
packaging_depthnumberObrigatório
highlightbooleanOpcional
seo_titlestringOpcional
seo_descriptionstringOpcional
seo_meta_keywordsstring[]Opcional
maximum_markupnumberOpcional
tagsstring[]Opcional
Respostas
chevron-right
200

Product updated successfully

application/json
idstringOpcional
activebooleanOpcional
namestringOpcional
skustringOpcional
short_descriptionstringOpcional
long_descriptionstringOpcional
ean_gtinstringOpcional
brand_idstringOpcional
brand_namestringOpcional
video_urlstringOpcional
pricenumberOpcional
stocknumberOpcional
warehouse_defaultstringOpcional
warehouse_default_namestringOpcional
maximum_discountnumberOpcional
minimum_stocknumberOpcional
minimum_for_salenumberOpcional
multiple_for_salenumberOpcional
standard_unit_idstringOpcional
standard_unit_namestringOpcional
standard_unit_abbreviationstringOpcional
category_idstringOpcional
category_namestringOpcional
product_weightnumberOpcional
product_widthnumberOpcional
product_heightnumberOpcional
product_depthnumberOpcional
packaging_weightnumberOpcional
packaging_widthnumberOpcional
packaging_heightnumberOpcional
packaging_depthnumberOpcional
highlightbooleanOpcional
seo_titlestringOpcional
seo_descriptionstringOpcional
seo_meta_keywordsstring[]Opcional
maximum_markupnumberOpcional
tagsstring[]Opcional
put
/products/{id}

Remove an existing product

delete
Autorizações
AuthorizationstringObrigatório
Bearer authentication header of the form Bearer <token>.
Parâmetros de rota
idstringObrigatório
Respostas
delete
/products/{id}

List all products

get
Autorizações
AuthorizationstringObrigatório
Bearer authentication header of the form Bearer <token>.
Parâmetros de consulta
searchstringOpcionalDefault: ""
pageinteger · int32OpcionalDefault: 0
perPageinteger · int32OpcionalDefault: 25
sortstringOpcionalDefault: ""
dirstringOpcionalDefault: asc
only_activebooleanOpcional
category_idstringOpcional
criteriastring[]Opcional
argumentsstringOpcional
product_idsstring[]Opcional
summarybooleanOpcionalDefault: false
Respostas
chevron-right
200

OK

application/json
currentPageinteger · int32Opcional
perPageinteger · int32Opcional
totalinteger · int64Opcional
get
/products

Create a new product

post
Autorizações
AuthorizationstringObrigatório
Bearer authentication header of the form Bearer <token>.
Corpo
idstringOpcional
activebooleanObrigatório
namestringObrigatório
skustringObrigatório
short_descriptionstringObrigatório
long_descriptionstringObrigatório
ean_gtinstringObrigatório
brand_idstringObrigatório
video_urlstringObrigatório
pricenumberObrigatório
stocknumberObrigatório
warehouse_defaultstringOpcional
maximum_discountnumberObrigatório
minimum_stocknumberObrigatório
minimum_for_salenumberObrigatório
multiple_for_salenumberObrigatório
standard_unit_idstringOpcional
category_idstringObrigatório
product_weightnumberObrigatório
product_widthnumberObrigatório
product_heightnumberObrigatório
product_depthnumberObrigatório
packaging_weightnumberObrigatório
packaging_widthnumberObrigatório
packaging_heightnumberObrigatório
packaging_depthnumberObrigatório
highlightbooleanOpcional
seo_titlestringOpcional
seo_descriptionstringOpcional
seo_meta_keywordsstring[]Opcional
maximum_markupnumberOpcional
tagsstring[]Opcional
Respostas
chevron-right
200

Product created successfully

application/json
idstringOpcional
activebooleanOpcional
namestringOpcional
skustringOpcional
short_descriptionstringOpcional
long_descriptionstringOpcional
ean_gtinstringOpcional
brand_idstringOpcional
brand_namestringOpcional
video_urlstringOpcional
pricenumberOpcional
stocknumberOpcional
warehouse_defaultstringOpcional
warehouse_default_namestringOpcional
maximum_discountnumberOpcional
minimum_stocknumberOpcional
minimum_for_salenumberOpcional
multiple_for_salenumberOpcional
standard_unit_idstringOpcional
standard_unit_namestringOpcional
standard_unit_abbreviationstringOpcional
category_idstringOpcional
category_namestringOpcional
product_weightnumberOpcional
product_widthnumberOpcional
product_heightnumberOpcional
product_depthnumberOpcional
packaging_weightnumberOpcional
packaging_widthnumberOpcional
packaging_heightnumberOpcional
packaging_depthnumberOpcional
highlightbooleanOpcional
seo_titlestringOpcional
seo_descriptionstringOpcional
seo_meta_keywordsstring[]Opcional
maximum_markupnumberOpcional
tagsstring[]Opcional
post
/products