Docs
Catalog API
Brands
Metafields

Metafields

Get brand metafields

GET /catalog/brands/{brand_id}/metafields

Request

Returns a list of brand metafields. Optional filter parameters can be passed in.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • brand_id in path - integer
    required

    The ID of the brand to which the resource belongs.

  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • id in query - integer

    Filter items by ID.

  • id:in in query - array
    Type: array[integer]
  • id:not_in in query - array
    Type: array[integer]
  • id:min in query - array
    Type: array[integer]
  • id:max in query - array
    Type: array[integer]
  • id:greater in query - array
    Type: array[integer]
  • id:less in query - array
    Type: array[integer]
  • page in query - integer
    Specifies the page number in a limited (paginated) list of products.
  • limit in query - integer
    Controls the number of items per page in a limited (paginated) list of products.
  • key in query - string
    Filter based on a metafieldʼs key.
  • namespace in query - string
    Filter based on a metafieldʼs namespaces.
  • include_fields in query - array
    Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
    Type: array[string]
  • 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.
    Type: array[string]

example

Response

Body

object | application/json

  • data    array[object]

  • meta    object

    Data about the response, including pagination and collection totals.

example

Create a Brand Metafield

POST /catalog/brands/{brand_id}/metafields

Request

Creates a brand metafield.

Note: The maximum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see Platform Limits in the Help Center.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • brand_id in path - integer
    required

    The ID of the brand to which the resource belongs.

  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json
Metafield for products, categories, variants, and brands; the max number of metafields allowed on each is 50. For more information, see Platform Limits in the Help Center.

  • key    string
    required

    The name of the field, for example: location_id, color. Required for POST.

    >= 1 characters<= 64 characters
    Example: Location

  • value    string
    required

    The value of the field, for example: 1, blue. Required for POST.

    >= 1 characters<= 65535 characters
    Example: 4HG

  • namespace    string
    required

    Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST.

    >= 1 characters<= 64 characters
    Example: Warehouse Locations

  • permission_set    string
    required

    Determines the visibility and writeability of the field by other API consumers.

    ValueDescription
    app_onlyPrivate to the app that owns the field
    readVisible to other API consumers
    writeOpen for reading and writing by other API consumers
    read_and_sf_accessVisible to other API consumers, including on storefront
    write_and_sf_accessOpen for reading and writing by other API consumers, including on storefront

    Allowed: app_only | read | write | read_and_sf_access | write_and_sf_access

  • description    string

    Description for the metafields.

    >= 0 characters<= 255 characters
    Example: Location in the warehouse

example

Response

Body

object | application/json

  • data    object

    Metafield for products, categories, variants, and brands; the max number of metafields allowed on each is 50. For more information, see Platform Limits in the Help Center.

  • meta    object

    Empty meta object; may be used later.

example-1

example-2

example-3

Get a Brand Metafields

GET /catalog/brands/{brand_id}/metafields/{metafield_id}

Request

Returns a brand metafield. Optional filter parameters can be passed in.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • brand_id in path - integer
    required

    The ID of the brand to which the resource belongs.

  • metafield_id in path - integer
    required

    The ID of the Metafield.

  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • include_fields in query - array
    Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
    Type: array[string]
  • 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.
    Type: array[string]

example

Response

Body

object | application/json

  • data    object

    Metafield for products, categories, variants, and brands; the max number of metafields allowed on each is 50. For more information, see Platform Limits in the Help Center.

  • meta    object

    Response metadata.

example

Update a Brand Metafield

PUT /catalog/brands/{brand_id}/metafields/{metafield_id}

Request

Updates a brand metafield.

Required Fields

  • none

Read-Only Fields

  • id
  • These fields can only be modified by the app (API credentials) that created the metafield:
    • namespace
    • key
    • permission_set

Usage Notes

  • Attempting to modify namespace, key, and permission_set fields using a client ID different from the one used to create those metafields will result in a 403 error message.
  • The maximum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see Platform Limits in the Help Center.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • brand_id in path - integer
    required

    The ID of the brand to which the resource belongs.

  • metafield_id in path - integer
    required

    The ID of the Metafield.

  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

Common Metafield properties.

  • permission_set    string

    Determines the visibility and writeability of the field by other API consumers. | Value | Description | | :--- | :--- | | app_only | Private to the app that owns the field. | | read | Visible to other API consumers. | | write | Open for reading and writing by other API consumers. | | read_and_sf_access | Visible to other API consumers, including on the storefront. | | write_and_sf_access | Open for reading and writing by other API consumers, including on the storefront. |

    Allowed: app_only | read | write | read_and_sf_access | write_and_sf_access

  • namespace    string

    Namespace for the metafield, for organizational purposes.

    >= 1 characters<= 64 characters
    Example: Sales Department

  • key    string

    The name of the field, for example: location_id, color.

    >= 1 characters<= 64 characters
    Example: Staff Name

  • value    string

    The value of the field, for example: 1, blue.

    >= 1 characters<= 65535 characters
    Example: Ronaldo

  • description    string

    Description for the metafields.

    >= 0 characters<= 255 characters
    Example: Name of Staff Member

example

Response

Body

object | application/json

  • data    object

    Metafield for products, categories, variants, and brands; the max number of metafields allowed on each is 50. For more information, see Platform Limits in the Help Center.

  • meta    object

    Response metadata.

example

Delete a Brand Metafield

DELETE /catalog/brands/{brand_id}/metafields/{metafield_id}

Request

Deletes a brand metafield.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • brand_id in path - integer
    required

    The ID of the brand to which the resource belongs.

  • metafield_id in path - integer
    required

    The ID of the Metafield.

  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.

example

Response

Did you find what you were looking for?
Delete a Brand ImageGet brand metafields