/
Product

Product

For handling a product the field UOM is always required in the JSON message. Ensure the UOM is imported in Cloudsuite before sending the product.
The other below mentioned prerequisites are not mandatory in the message. However they cannot be left empty. So these should be sent with a value or fully left out of the message.
If the PUT option is used together with a specific ID, the PUT option can be used to create a new object without checking the existence of the object.

 

UOM's

Categories

Brand

Attribute

Catalog

Tags

Product

If you want to access inactive products you must include the parameter: inactive=true to the URL. If this included you get ALL active and inactive product.
Suggestion: use this with all calls, then there is no need to differentiate between active and inactive flows.

URL

PUT /api/origin/{origin_code}/product/{key}/ PATCH /api/origin/{origin_code}/{product}/{key}

Fields

Fields

Mandatory for the API

Description

Remarks

 

Fields

Mandatory for the API

Description

Remarks

 

key

yes

must be unique

 

 

code

yes

 

only mandatory when using PUT. Not when using PATCH

 

name

yes

 

only mandatory when using PUT. Not when using PATCH

 

active

yes

true or false

only mandatory when using PUT. Not when using PATCH

 

uom

yes

Import key of the uom created via the uom api

only mandatory when using PUT. Not when using PATCH

 

type

no

goods or service

 

 

category

yes/no

 

should be filled when “taxes_category” is set at true

 

taxes_category

no

true or false

 

 

taxes

  • key

  • company

yes/no

 

When “taxes_category is set at false at least 1 tax should be added at the webshop

 

list_prices

  • company

  • value

no

 

At the webshop it is recommended to have a list price filled. This is the base price which is shown when no other price from the price lists is available

 

catalogs

no

array of strings with the import keys of the required catalogs

To be visible at the webshop a product must have at least 1 catalog

 

brand

no

Import key of the brand created via the brand api

A brand is mandatory to get the product visible at t he webshop

 

priority

no

 

 

 

trees

no

array of strings with the import key of the trees the product should be connected to

A tree is required to make the product visible at the plp of a tree. Always the lowest level of a tree should be connected to the product

 

description

no

 

 

 

description2

no

 

 

 

description3

no

 

 

 

salable

no

true or false

 

 

sale_uom

no

 

field can be left out when sale uom is the same as uom. Otherwise check this page

 

attributes

  • key

  • value

  • sequence

no

 

All attributes connected to this product should be mentioned in this call. When you would like to add a separate attribute to a product use the separate attributeproperty / product call as described at this page

 

min_stock

no

 

 

 

delivery_time

no

 

 

 

oem

no

 

 

 

ean

no

 

 

 

product_status

no

 

 

 

availability_schedule

no

 

 

 

order_max_quantity

no

 

 

 

order_max_quantity_warning

no

 

 

 

tags

no

 

 

 

keywords_for_search

no

 

 

 

skip_order_export

no

 

 

 

crosssell_products

no

 

 

 

upsell_products

no

 

 

 

alternative_products

no

 

 

 

cannot_be_added_to_basket

no

 

 

 

delivery_service

no

 

 

 

dimension

no

 

 

 

order_qty

no

 

 

 

order_minimum_qty

no

 

 

 

order_default_qty

no

 

 

 

consumer prices

  • company

  • value

no

 

 

 

meta_description

no

 

 

 

slug

no

 

 

 

custom_slug

no

 

 

 

title

no

 

 

 

url_primary_shop

no

 

 

 

url_feed

no

 

 

 

ec_delivery_days

no

 

 

 

min_stock_backorder

no

 

 

 

pack_qty

no

 

 

 

stock_indication

no

 

 

 

content_weight

no

 

 

 

content_volume

no

 

 

 

un_spsc

no

 

 

 

pim_type

no

 

 

 

endpoint

no

 

 

 

product_codes

  • code

  • type

no

 

 

 

texts

no

 

 

 

ordercost

no

 

 

 

external_configurator

no

 

 

 

nett_price

no

 

 

 

cost_prices

no

 

 

 

cost_price

no

 

 

 

Example

Documentation: https://test.cloudsuite.io/api/#operation/api_origin_product_update

Product translations

URL

POST /api/origin/{origin_code}/product/{key}/translations/

Example

Documentation: https://test.cloudsuite.io/api/#operation/api_origin_product_translations_create

Related content

© 2024 CloudSuite BV, All rights reserved