Delete a custom field definition - Spree Commerce documentation

DELETE

api

admin

custom_field_definitions

{id}

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

await client.customFieldDefinitions.delete('cfd_UkLWZg9DAJ')

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

Path Parameters

string

required

Response

204

definition deleted

Show a custom field definition

Update a custom field definition

⌘I

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

await client.customFieldDefinitions.delete('cfd_UkLWZg9DAJ')