POST /catalog/products/{product_id}/custom-fields
Creates a Custom Field.
Required Fields:
- name
- value
Name-Value Pair Uniqueness
- Every name-value pair must be unique inside a product.
Read-Only:
- id
Limits
- 200 custom fields per product limit.
- 250 characters per custom field limit.
Servers
- https://api.bigcommerce.com/stores/{store_hash}/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
product_id |
Integer | Yes |
The ID of the |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
The name of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests. |
value |
String | Yes |
The value of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.