Guides
API Endpoints

Create Product

post
https://redbook.instaleap.io/product/products
Body Params
string
required

Name of the product

photosUrl
array of strings
required

Urls of the photos that will be see the user when see the product in the e-commerce

photosUrl*
string
required

Product unique idetifier

string
required

Unit of measure or packaging form of the product

number

Number of products to add to the shopping cart when a user clicks on add product

string

Subunit of measure or a single unit of the product

ean
array of strings

Type of barcode that encodes a product number

ean
integer

Using to organize the product order in the same category. Lower “boost”, better positioning

string

Description of the product

string

Brand of the product

string

searchable keywords for the product

number

how much of the subunit is contained in the unit

string

URL that contain a photo that is show at the end of all photos

pickingMultiplier
array of objects

Allows set different picking times for different products.

pickingMultiplier
relatedProducts
array of strings

List of skus that are related to the product and will be displayed in the PDP of the product in the "Selected for you" carousel.

relatedProducts
ingredients
array of strings

List of ingredients of the product

ingredients
specifications
array of objects
specifications
seals
array of objects

different references can be added to the products.

seals
nutritionalDetailsInformation
object

nutritional details information is new version to nutritional details that display a table in the ecommerce with the information configures

double
≥ 0

to tag products as BigItems from a number of units added to cart (useful for splitOrders)

suggestedReplacementClient
array of strings

list of skus that represent suggested replacements at the moment of the purchase if the product is low in stock and likely to be out of stock

suggestedReplacementClient
lots
object
dimensions
object
number

weight of the product

number

volume of the product

boolean

Defines if the product is restricted by age

string

Used to specify when was the product created in the client's system. This date can be used for sorting results on the ecommerce. Needs to use the pattern yyyy-MM-dd'T'HH:mm:ssZZ

string
enum

Defines the type of product and how will it be handled by the rest of the system. Should use one of the predefined values.

Allowed:
skusPackaging
array of strings

Receives a list of SKUs to be associated to this product as packaging/bags.

skusPackaging
double

This field defines the capacity of the products defined with productType "packaging" or "bag"

string

This fields receives a short description to be used in the meta-tags of the ecommerce for SEO and other purposes

string

This field receives a short title to be used in the meta-tags of the ecommerce for SEO and other purposes

string

represents the unit of volume of the product

string

represents the unit of weight of the product

boolean

Define if the product requires a medical prescription.

integer

Product expiration date

string

Specifies the storage conditions required for the product.

string

specifies the country of origin of the product.

descriptionTranslation
object

List of languages with their translations for the field description

nameTranslation
object

List of languages with their translations for the field name

nutritionalDetailsTranslation
object

List of languages with their translations for the field nutritionalDetails

searchKeywordsTranslation
object

List of languages with their translations for the field searchKeywords

boolean

Defines if a product can be substituted.

Headers
string
required

token provided by Instaleap to make API calls

Responses

401

Unauthorized

Updated 5 months ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago