Skip to main content
POST
/
products
{
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "handle": "<string>",
  "description": "<string>",
  "taxCode": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Headers

​
x-environment
string<uuid>
required

Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.

Body

application/json
​
name
string | null
required

The product's name, meant to be displayable to the customer.

​
handle
string | null

The product's handle or SKU.

​
description
string | null

The product's description.

​
taxCode
string | null

Optional. Value of "standard", "reduced", "exempt" or specific code "ptc_xx". Defaults to standard.

Response

OK

​
name
string | null
required

The product's name.

​
id
string<uuid>

Unique id for the product.

​
handle
string | null

The product's handle or SKU.

​
description
string | null

A description of the product. This may be used internal or external.

​
taxCode
string | null

An optional taxCode for this product.

​
createdAt
string<date-time>

Date and time when the product was created.

​
updatedAt
string<date-time> | null

/// Date and time when the product was last updated.