post

/catalog/products/{product_id}/custom-fields

Creates a Custom Field.

Required Fields:

  • name
  • value

Read-Only:

  • id

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

1 Path Parameter
2 Headers

Request Body

1 Example
Schema
object

Gets custom fields associated with a product. These allow you to specify additional information that will appear on the product’s page, such as a book’s ISBN or a DVD’s release date.

id
integer

The unique numeric ID of the custom field; increments sequentially. Read-Only

2 validations
name
string

The name of the field, shown on the storefront, orders, etc. Required for /POST

4 validations + required
value
string

The name of the field, shown on the storefront, orders, etc. Required for /POST

4 validations + required

Responses

1 Example
Schema
object
data
object

Gets custom fields associated with a product. These allow you to specify additional information that will appear on the product’s page, such as a book’s ISBN or a DVD’s release date.

meta
object

Empty meta object; may be used later.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
product_id
$$.env
2 variables not set
store_hash
X-Auth-Client
X-Auth-Token