Skip to main content
PATCH
Update a product type

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Bearer token for admin authentication

Path Parameters

id
string
required

Product type ID

Body

application/json
name
string
Example:

"Hoodie"

delivery_profile_id
string | null

Delivery profile stamped onto products created with this type. Null leaves new products on the store default profile.

Example:

"fp_86Rf07xd4z"

option_type_ids
string[]

Option types seeded onto products that get this type. Use apply to products to backfill existing ones.

category_ids
string[]

Categories seeded onto products that get this type. Categories from other stores are ignored.

custom_field_definitions
object[]

The custom field definitions the product form shows. Definitions not listed are removed from the type.

Response

200 - application/json

product type updated

id
string
required
name
string
required
products_count
number
required
created_at
string
required
updated_at
string
required
delivery_profile_id
string | null
required
option_type_ids
string[]
required
category_ids
string[]
required
custom_field_definitions
object[]
required
translations
object