Create a product

Create a new product with variants, options, and other details. Requires full write access to products.

Request Body

application/jsonRequired

isBundleboolean

Whether this product is a bundle of other products

Default: false

nameRequiredstring

Name of the product

slugstring

URL-friendly version of the product name

descriptionstring

Detailed description of the product

optionsarray<object>

Product options (e.g., Size, Color)

brandstring

Brand name

vendorstring

Vendor/supplier name

manufacturerstring

Manufacturer name

eccnstring

Export Control Classification Number

imageUrlstring

URL of the product image

Format: "uri"

imageFilestring

Product image file to upload. When provided, this will be uploaded and the resulting URL will be stored in imageUrl.

Format: "binary"

variantsRequiredarray<object>

Product variants

curl -X POST "https://www.shipsidekick.com/api/v1/products" \
  -H "Content-Type: application/json" \
  -d '{
    "$ref": "#/components/examples/ProductExample/value"
  }'

Product created successfully

{
  "object": "product",
  "data": {
    "$ref": "#/components/examples/ProductCreationExample/value",
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "organizationId": "org-1234-5678-abcd-efgh",
    "createdAt": "2023-09-21T15:30:00Z",
    "updatedAt": "2023-09-21T15:30:00Z"
  }
}

Create a product

Request Body

Example of a newly created product

TypeScript