Custom Fields

Gets custom fields associated with a product.

GET /stores/{store_hash}/v2/products/{product_id}/custom_fields

Filters

There are no filter parameters specific to custom_fields.

Pagination

Parameters can be added to the URL query string to paginate the collection. The maximum limit is 250. If a limit isn’t provided, up to 50 custom_fields are returned by default.

Response

Example JSON returned in the response:

[
  {
    "id": 1,
    "product_id": 30,
    "name": "Toy manufactured in",
    "text": "USA"
  },
  {
    "id": 2,
    "product_id": 45,
    "name": "Release Date",
    "text": "2013-12-25"
  }
]

Gets a custom field associated with a product.

GET /stores/{store_hash}/v2/products/{product_id}/custom_fields/{id}

Response

Example JSON returned in the response:

{
  "id": 2,
  "product_id": 30,
  "name": "Toy manufactured in",
  "text": "USA"
}

Gets a count of the number of custom fields in the store.

GET /stores/{store_hash}/v2/products/custom_fields/count

Response

Example JSON returned in the response:

{
  "count": 0
}

Creates a new custom field associated with a product

POST /stores/{store_hash}/v2/products/{product_id}/custom_fields

Read-only Properties

The following properties of the custom field are read-only. If one or more of these properties are included in the request, it will be rejected.

• product_id

Requirements

The following properties of the custom field are required. The request won’t be fulfilled unless these properties are valid.

• name
• text

Request

Example request object:

{
  "name": "Release Date",
  "text": "2013-12-25"
}

Response

Example JSON returned in the response:

{
  "id": 5,
  "product_id": 45,
  "name": "Release Date",
  "text": "2013-12-25"
}

Updates an existing custom field associated with a product.

PUT /stores/{store_hash}/v2/products/{product_id}/custom_fields/{id}

Read-only Properties

The following properties of the custom field are read-only. If one or more of these properties are included in the request, it will be rejected.

• product_id

Requirements

The following properties of the custom field are required. The request won’t be fulfilled unless these properties are valid.

• name
• text

Request

Example request object:

{
  "name": "Release Date",
  "text": "2013-12-31"
}

Response

Example JSON returned in the response:

{
  "id": 5,
  "product_id": 45,
  "name": "Release Date",
  "text": "2013-12-31"
}

Deletes a custom field associated with a product.

DELETE /stores/{store_hash}/v2/products/{product_id}/custom_fields/{id}

Deletes multiple custom fields associated with a product.

DELETE /stores/{store_hash}/v2/products/{product_id}/custom_fields

Pagination

Parameters can be added to the URL query string to paginate the collection. The maximum limit is 250. If a limit isn’t provided, up to 50 custom_fields are returned by default.