Custom Field Defs List
tiendanube_custom_field_defs_listLists custom field definitions for categories, customers, orders, products, or product variants, helping you inspect available fields before reading or writing custom field values.
Instructions
List custom field definitions (unstable API). HTTP: GET /{entity}/custom-fields Required scope: read_products/write_products API version: unstable Returns {count, page, per_page, total?, has_more, next_page?, items[]}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (default 1). Orders: page * per_page must be <= 10000 | |
| entity | Yes | Entity type owning the definitions (categories | customers | orders | products | products/variants) | |
| fields | No | Comma-separated list of fields to return, to reduce payload size (e.g. 'id,name,variants') | |
| per_page | No | Items per page (default 30, max 200; max 50 for external invoices) | |
| response_format | No | Output format: 'json' (default, full data) or 'markdown' (human-readable) | json |