Skip to main content

​
Overview

This endpoint can be used to create a product. Endpoint: /api/v1/products Method: POST

​
Request

​
sku
string
required
The unique SKU or internal reference code for the product. For example, “1356284”.Minimum character length: 2Maximum character length: 30
​
description
string
required
The description of the product e.g. “Red shirt”.Minimum character length: 2Maximum character length: 50
​
category
string
required
The category of the product e.g. “Clothing”.Minimum character length: 2Maximum character length: 30
​
price
decimal
required
The price of the product in your organization’s currency e.g 55.21.Minimum: 1.00Maximum: 999999999.99
​
length
integer
required
The length of the product (in inches, rounded up).Minimum: 4Maximum: 50
​
width
integer
required
The width of the product (in inches, rounded up).Minimum: 4Maximum: 50
​
height
integer
required
The height of the product (in inches, rounded up).Minimum: 1Maximum: 50
​
weight
integer
required
The weight of the product (in pounds, rounded up).Minimum: 1Maximum: 50
​
returnable
boolean
required
Status indicating whether the product may be returned.

​
Response

If the product is successfully created, the API will return a 201 Created status code. The response will contain the following content:
​
id
integer
required
The ID of the newly created product.
{
    "sku": "1356284",
    "description": "Red Shirt",
    "category": "Clothing",
    "price": 55.71,
    "length": 6,
    "width": 11,
    "height": 3,
    "weight": 2,
    "returnable": true
}

{
    "id": 10012
}