GET /catalog/brands/{brand_id}/metafields
Returns a list of brand metafields. Optional filter parameters can be passed in.
Servers
- https://api.bigcommerce.com/stores/{store_hash}/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
brand_id |
Integer | Yes |
The ID of the brand to which the resource belongs. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | Yes |
The MIME type of the response body. Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
exclude_fields[] |
Array | No |
Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. |
id:min[] |
Array | No | |
include_fields[] |
Array | No |
Fields to include, in a comma-separated list. The ID and the specified fields will be returned. |
before |
String | No |
A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter. |
id:in[] |
Array | No | |
id |
Integer | No |
Filter items by ID. |
id:max[] |
Array | No | |
page |
Integer | No |
Specifies the page number in a limited (paginated) list of products. |
id:not_in[] |
Array | No | |
limit |
Integer | No |
Controls the number of items per page in a limited (paginated) list of products. |
namespace |
String | No |
Filter based on a metafieldʼs namespaces. |
key |
String | No |
Filter based on a metafieldʼs key. |
id:greater[] |
Array | No | |
after |
String | No |
A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter. |
id:less[] |
Array | No |
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.