Description

Products come in two flavors, base product (Product hereafter) and product variant (Variant hereafter).

Variants are always linked to a single Product (parent product) and represents some minor modification on the Product.

This resource is only concerned with Products and will contain the list of associated Variants. To create/update Variants, please refer to the Products/Variant resource.

Products can also have multiple files attached and those files will be made available for viewing within the Project line using this Product.

Params format (creation/update)

For this resource, all the params can be included in a key product.

For instance, creating a Product in XML (POST /api/v1/products):

<product>
  <name>TestCreationProduit</name>
  <reference>TestProduit-001</reference>
  <color>Blanc</color>
</product>

In JSON, the root key is not necessary and the following body would be accepted:

{
  "name": "TestCreationProduit",
  "reference": "TestProduit-001",
  "color": "Blanc"
}

Product base fields

Name	Type
id	Integer (unique)
name	String (2..100 chars)
source_id	String (max 255 chars)
reference	String (unique, max 255 chars)
material	String (max 255 chars)
brand	String (max 255 chars)
color	String (max 255 chars)
size	String (max 255 chars)
washcare	String (max 255 chars)
description	String (max 255 chars)
dimensions	String (max 255 chars)
theme	String (max 255 chars)
collection	String (max 255 chars)
formula	String (max 255 chars)
target_store_date	Date
px40	String
px75	String
px150	String
px500	String
archived	Boolean
showcased	Boolean
status	String (max 255 chars)
created_at	Datetime
updated_at	Datetime

Product associated resources

When receiving a Product from Winddle, the following data may also be available.

To retrieve all of it for a given product, please use the GET /:id service.

The associated resources marked with a (LIST) are also available when listing Products with the GET / service.

Sizesets (LIST)

The sizesets assigned to a product are sent in the key sizesets.

This list of sizesets will contain all the sizesets that could apply to this Product, as defined in the Company settings.

Category (LIST)

A product can be assigned to one (and only one) Product Category.

There are 2 keys related to Product Category in the Product resource response:

• category : it contains the category assigned to the Product, not present when none has been set. The fields available for the category are at least id, source_id and label.

• categories: it’s an array containing the category assigned to the product as well as all its ancestor up to the root node of the product categories hierarchies. This field allows to conveniently rebuild the full-subtree of the used category for a given product.

Variants (LIST)

The variants are sent with the key variants as an array of Variants.

Each Variant has roughly the same fields as a Product (the Product base fields).

For more details, you may refer to the Variants service.

Custom values (LIST)

This array, sent in the key customs contains an entry for each Custom Fields created in the Product’s company that is attached to a Product.

For each of those custom fields, the following keys are provided:

• id : id of the Custom Field
• name: name of the Custom FIeld
• value: value for this Product, if any
• updated_at: Datetime of the update for the value, if any

Projects (LIST)

This array, sent in the key projects will contain the last 3 projects which contain at least one project line the token owner can access and which is using this product.

For each of those projects, the name and the id will be provided.

Attachments

The files attached to a product are sent with the key attachments.

For more details, you may refer to the Attachments service.

Roles

There are 2 roles sent with each Product:

• can_delete: can the Token owner delete this product? (it will be set to False if the product is still in use, regardless of who the owner is)

• can_manage: can the Token owner edit fields, manage variants or archive this product?

Supported Formats

JSON XML