Skip to main content
POST
/
v1
/
partner
/
products
Submit a new product
curl --request POST \
  --url http://localhost:3000/v1/partner/products \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "retail_price": 1,
  "brand": "<string>",
  "description": "<string>",
  "barcode": "<string>",
  "size": "<string>",
  "size_value": 123,
  "size_uom": "<string>",
  "temperature_zone": "ambient",
  "image_url": "<string>",
  "image_urls": [
    "<string>"
  ],
  "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subcategory_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_for_human_consumption": true,
  "nutrition_info": {
    "servings_per_container": 123,
    "serving_size_quantity": 123,
    "serving_size_unit": "<string>",
    "serving_size_weight": 123,
    "serving_size_weight_unit": "<string>",
    "calories": 123,
    "total_fat": 123,
    "saturated_fat": 123,
    "trans_fat": 123,
    "polyunsaturated_fat": 123,
    "monounsaturated_fat": 123,
    "cholesterol": 123,
    "sodium": 123,
    "total_carbohydrates": 123,
    "dietary_fiber": 123,
    "total_sugars": 123,
    "added_sugars": 123,
    "sugar_alcohol": 123,
    "protein": 123,
    "vitamins": [
      {
        "name": "<string>",
        "value": 123,
        "unit": "<string>"
      }
    ]
  },
  "weight_pounds": 1,
  "height_inches": 1,
  "length_inches": 1,
  "width_inches": 1,
  "is_vegan": true,
  "is_organic": true,
  "is_gluten_free": true
}
'
{
  "scraped_product": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "brand": "<string>",
    "barcode": "<string>"
  },
  "sellable_product": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "taxonomy_id": "<string>",
    "selling_price": 123,
    "is_active": true
  }
}

Body

application/json
name
string
required
Minimum string length: 1
retail_price
number
required
Required range: x > 0
brand
string
description
string
barcode
string
size
string
size_value
number
size_uom
string
temperature_zone
enum<string>
default:ambient
Available options:
ambient,
refrigerated,
frozen
image_url
string<uri>
image_urls
string<uri>[]
Maximum array length: 7
category_id
string<uuid>
subcategory_id
string<uuid>
is_for_human_consumption
boolean
default:true
nutrition_info
object
weight_pounds
number
Required range: x > 0
height_inches
number
Required range: x > 0
length_inches
number
Required range: x > 0
width_inches
number
Required range: x > 0
is_vegan
boolean
is_organic
boolean
is_gluten_free
boolean

Response

Product submitted

scraped_product
object
required
sellable_product
object
required