Product feature V2

How to manage your products creation

Informations : These product features work for English, French and Spanish languages

API product Feature

This feature allows you to create your product sheet if it does not exist.
You will be able to :

  • Retrieve the categories and properties

  • Match the existing product

  • Submit new product sheet

  • Consult the report

Endpoint

What is a product ?

In order to understand what "product" means for Octopia you can read the help center documentation. You will find :

  1. What is a qualitative product sheet

  2. How to create standard / variant product

  3. What is a brand, a category and its properties

  4. Understand the error codes


Help center documentation

Some definition

Product : The creation of product sheet is necessary if not existing on our platform. The creation allows you to enrich the article sheet and to register your product in our databases.

Offer : Create an offer after the creation of the product sheet in order to insert it in your catalog.

How the products work

Check if the ean codes are existing, get the necessary information to create your product sheets.

Picture

Product Sheet

A product sheet is composed of recurring data (for all categories) and data linked to the category.

  • Recurring data : gtin, title, description, image, brand, category, language...

  • Data linked to the category : for a given category, several properties are attached to it. Example of property: size, color, made in France... 

Data and properties can be mandatory, recommended or optional. 

To be able to sell a product, all mandatory data must be correctly filled in.

Product information on a webpage are : Picture, Title, Description

Picture

Type of product 

A product sheet can be created individually, we speak of a simple product, or attached to other products, we speak of a variant product. Only certain categories accept varying products (like fashion, footwear).

  1. Simple product : product without gtinReference. It appears individually on the forehead as in the example shown above.

  2. Variant product : A variant product can vary on two axes currently, size and/or color. Its axes of variation are chosen by the managers of the Octopia product repository and imposed on the seller as mandatory properties. Products created as a variant have a gtinReference and a groupReference. They are part of a product family.

Picture

Management rules and verification of product data

EAN/GTIN 

  • Between 8 and 13 characters

  • Valid key 

  • That it doesn't start with 200

LANGUAGE

  • Format: Valid IETF BCP47 consisting of an ISO 639-1 country code, a hyphen and an ISO 3166-1 alpha-2 culture code. Example: fr-FR

  • Languages ​​accepted: fr-FR, en-US and es-ES

TITLE

  • Existing and smaller than 132 characters

DESCRIPTION

  • Existing and smaller than 420 characters

CATEGORY

  • 2, 4 or 6 characters 

IMAGE

  • At least 1 picture

  • HTTPS-url

  • Resolution between 500 x 500 pxs and 3000 x 3000 pxs

  • Accepted formats: jpg, jpeg, png, gif

  • Image smaller than 5MB

Endpoints

Get a list of categories
GET /categories

Response attributes (by default) : reference, status

Recommended call frequency : Occasionally

Count categories
Get /categories/count

Return the number of existing category

Recommended call frequency : Occasionally

Get properties of a category
GET/categories/{categoryReference}/properties

Response attributes (sample) : propertyReference, necessity, index, label...

Recommended call frequency : Occasionally

Get category details
POST/categories/{categoryReference}

Response attributes (sample) : reference, guid, label, level, language...

Recommended call frequency : Occasionally


Get product package logs
GET /products-integration-reports

Allows you to retrieve your product reports

Recommandations of call : Push the previously retrieved packageId

Submit a product package in JSON
POST /products-integration

Allows you to submit your product sheet

Recommandations of call : Only when you want create new products