Catalog - Products
Get Product Custom Fields
GET /stores/{store_hash}/v3/catalog/products/{product_id}/custom-fields
Request
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
- include_fields in query - array
Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
- exclude_fields in query - array
Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
- page in query - integer
Specifies the page number in a limited (paginated) list of products.
- limit in query with default of 50 - integer
Controls the number of items per page in a limited (paginated) list of products.
example
Response
Gets array of Custom fields.
Body
dataarray[object]
metaobject
Data about the response, including pagination and collection totals.
example
Create a Product Custom Field
POST /stores/{store_hash}/v3/catalog/products/{product_id}/custom-fields
Request
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
- product_id in path - integerrequired
The ID of the
Product
to which the resource belongs.
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: ISBN
valuestring
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.
metaobject
Response metadata.
example
Get a Product Custom Field
GET /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
- include_fields in query - array
Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
- exclude_fields in query - array
Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
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.
metaobject
Response metadata.
example
Update a Product Custom Field
PUT /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
- product_id in path - integerrequired
The ID of the
Product
to which the resource belongs. - custom_field_id in path - integerrequired
The ID of the
CustomField
.
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: ISBN
valuestring
>= 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.
metaobject
Response metadata.
example
Delete a Product Custom Field
DELETE /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
- product_id in path - integerrequired
The ID of the
Product
to which the resource belongs. - custom_field_id in path - integerrequired
The ID of the
CustomField
.
example
Response
204 No Content