Create a Product

post

https://api.prtmb.com/api/v2/accounts/{account_id}/products

Create a new Product resource.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

required

This parameter indicates which Account owns the collections and resources reference by the request.

As a convenience, the slug me may be used in place of the account_id in any URL where it is
required. When me is used it will be replaced with the account_id of the current User.

Body Params

Success

Create a Product.

body_html

string | null

A HTML description of the product (suitable for the web)

body_text

string

required

A text description of the product (suitable for SMS).

handle

string

A unique (per account) human-readable, URL safe string to identify this product. If not provided the handle will be automatically generated from the title.

option_00_key

string

Defaults to Style

The key for a custom property name used by product_variant resources (e.g. Style).

option_01_key

string | null

The key for a custom property name used by product_variant resources (e.g. Size).

option_02_key

string | null

The key for a custom property name used by product_variant resources (e.g. Color).

published_at

string | null

An ISO 8601 format date indicating when this resource was published.

status

string

enum

A string indicating the current status of this product (active/archived/draft).

Allowed:

store_id

uuid

required

A unique identifier for the referenced store resource.

200Success