API Product Integration

Authentication

We use the basic authentication standard, please contact us for your credentials at [e-mail]

Request endpoint

This endpoint create a new product in our database.

Create new product

POST https://api.sizebay.technology/v1/integrations/products

Headers

Name	Type	Description
user*	string	Your user
password*	string	Your password

Request Body

Name	Type	Description
name*	string	Name of the product
gender*	string	Product gender (see options below)
permalink*	string	Unique product link (url)
image*	string	Product image link (url)
feedProductId	string	Unique product ID
brandName*	string	Product brand
categoryName*	string	Product category
availableSizes*	array	Size of the clothing / shoe avaliables. Ex: ["P", "M", "G"]
ageGroup*	string	Product age group (see options below)
sizeType*	string	Product type (see options below)

200 Success

""

401 Permission denied

400: Bad Request An error occurred

{
    // The error response can vary, due the many fields on this req
}

Payload example

There's an important information regarding categoryName that must be acknowledged before attempting this integration. Please read the details by checking our docs at https://docs.sizebay.com/integration-products/categories-accepted-by-the-integration

{
  "name": "Shorts",
  "gender": "M",
  "permalink": "https://www.exemple.com/prod/3213",
  "image": "https://www.exemple.com/short-image.jpg",
  "feedProductId": "he3jga4j4b",
  "brandName": "Product Brand",
  "categoryName": "Shorts",
  "availableSizes": ["PP", "P", "M", "G", "GG"],
  "ageGroup": "adult",

  // Properties below are OPTIONAL
  "sizeType": "regular"
}

Field value limits

• availableSizes: 20 sizes in the array

• image: 255 as the maximum allowed url length

• name: 150 as the maximum allowed length

• categoryName: 150 as the maximum allowed length

• brandName: 100 as the maximum allowed length

• permalink: 250 as the maximum allowed href length

Fields Options

field	options	description
gender	M, F, U	M = male, F = female, U = unisex
ageGroup	adult, infant, kids, newborn, toddler
sizeType (optional)	regular, petite plus size, big and tall, maternity	They must be exactly the way they are described here. Do NOT send it as e.g "Regular". It's case sensitive.