Create product

POST/api/products

Creates a new product in the current workspace.

Request Body

application/json

Request payload for Create product.

TypeScript Definitions

Use the request body type in TypeScript.

handle?|

Stable product handle used in URLs.

sku?|

Product SKU.

title?|

Product title shown to users.

description?||

Long-form product description.

vendor?|

Vendor or manufacturer name.

category?|

Category name to assign to the product.

categoryId?||

Category identifier to assign to the product.

categoryIds?array<string>|

Structured category identifiers to assign to the product.

primaryCategoryId?||

Primary category mirrored to legacy product fields.

images?array<string>|

Absolute image URLs to associate with the product.

baseUnit?|

base unit.

alternativeUnits?array<any>|

Alternative unit configurations to store on the product.

referenceUnits?array<any>|

Reference unit configurations to store on the product.

basePrice?||

Default base selling price to store on the product.

baseCost?||

Default base cost to store on the product.

customFields?|

Custom field values to store on the product.

Response Body

`application/json`

curl -X POST "https://example.com/api/products" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "prod_123",  "workspaceId": "ws_123",  "handle": "string",  "sku": "string",  "productGroup": "string",  "title": "string",  "description": "string",  "vendor": "string",  "category": "string",  "categoryId": "string",  "lifecycleStatus": "string",  "archivedAt": "string",  "deletedAt": "string",  "searchText": "string",  "basePrice": {    "amount": 0,    "currencyCode": "USD"  },  "baseCost": {    "amount": 0,    "currencyCode": "USD"  },  "data": {},  "customFields": {},  "createdAt": "string",  "updatedAt": "string",  "baseUnit": null,  "alternativeUnits": [],  "referenceUnits": [],  "defaultUnitCode": "string",  "price": {    "amount": 0,    "currencyCode": "USD"  },  "mainImageSrc": "string",  "priceSource": null,  "pricingMetadata": null,  "isFavorite": true,  "calculatedFields": null}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`