Custom fields
Get Product Custom Fields
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/custom-fieldsRequest
Returns a list of product Custom Fields. You can pass in optional parameters.
Note: The default rate limit for this endpoint is 40 concurrent requests.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Gets array of Custom fields.
Body
dataarray[object]
example
Create a Product Custom Field
POST https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/custom-fieldsRequest
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.
Note: The default rate limit for this endpoint is 40 concurrent requests.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
Payload for POST request to create custom fields associated with a product.
namestring
required>= 1 characters<= 250 charactersThe name of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests.
Example: ISBNvaluestring
required>= 1 characters<= 250 charactersThe value of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests.
Example: 1234567890123
example
Response
Gets Custom field.
Body
dataobject
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.
example
Get a Product Custom Field
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/custom-fields/{custom_field_id}Request
Returns a Custom Field.
Note: The default rate limit for this endpoint is 40 concurrent requests.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Gets Custom field.
Body
dataobject
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.
example
Update a Product Custom Field
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/custom-fields/{custom_field_id}Request
Updates a Custom Field.
Required Fields
- none
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.
- 40 concurrent requests default rate limit.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
Payload for PUT request to update custom fields associated with a product.
namestring
>= 1 characters<= 250 charactersThe value of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests.
Example: ISBNvaluestring
>= 1 characters<= 250 charactersThe value of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests.
Example: 1234567890123
example
Response
Gets Custom field.
Body
dataobject
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.
example
Delete a Product Custom Field
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/custom-fields/{custom_field_id}Request
Deletes a product Custom Field.
Note: The default rate limit for this endpoint is 40 concurrent requests.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
204 No Content