> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lapyme.com.ar/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar definiciones de campos personalizados de variantes

> Devuelve las definiciones no sistémicas de variantes. Cada variante guarda su propio valor: enviá key y value en variants[].metafields de Guardar las variantes de un producto. Una clave es de productos o de variantes, nunca de ambos. Las definiciones select incluyen todos los valores configurados u observados, deduplicados y con su cantidad de variantes. Los valores de texto libre no se enumeran. La disponibilidad depende de que los campos personalizados estén habilitados para la organización.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/products/variant-metafield-definitions
openapi: 3.1.0
info:
  title: La Pyme API
  description: >-
    Resources and workflows for purchases, sales, inventory, contacts, products,
    reports, and settings.
  version: 1.0.0
  contact:
    name: La Pyme Support
    email: hola@lapyme.com.ar
  license:
    name: Proprietary
    url: https://lapyme.com.ar/terminos
servers:
  - url: https://api.lapyme.com.ar
    description: Servidor de producción
security:
  - bearerAuth: []
tags:
  - name: API
    description: Public API operations for La Pyme integrations.
paths:
  /api/v1/products/variant-metafield-definitions:
    get:
      tags:
        - API
      summary: Listar definiciones de campos personalizados de variantes
      description: >-
        Devuelve las definiciones no sistémicas de variantes. Cada variante
        guarda su propio valor: enviá key y value en variants[].metafields de
        Guardar las variantes de un producto. Una clave es de productos o de
        variantes, nunca de ambos. Las definiciones select incluyen todos los
        valores configurados u observados, deduplicados y con su cantidad de
        variantes. Los valores de texto libre no se enumeran. La disponibilidad
        depende de que los campos personalizados estén habilitados para la
        organización.
      operationId: listApiProductVariantMetafieldDefinitions
      responses:
        '200':
          description: Definiciones obtenidas exitosamente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiProductMetafieldDefinitionsResponse'
        '401':
          description: API key faltante o inválida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
              examples:
                default:
                  summary: AUTHENTICATION_REQUIRED
                  value:
                    request_id: req_variant_metafields_1
                    error:
                      code: AUTHENTICATION_REQUIRED
                      message: Authentication required
                      retryable: false
                      type: invalid_request_error
                      details: []
        '403':
          description: Scope insuficiente o funcionalidad no habilitada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
              examples:
                default:
                  summary: FORBIDDEN
                  value:
                    request_id: req_variant_metafields_1
                    error:
                      code: FORBIDDEN
                      message: >-
                        Los campos personalizados no están incluidos en tu
                        contrato actual
                      retryable: false
                      type: invalid_request_error
                      details: []
        '429':
          description: Límite de solicitudes excedido para la organización
          headers:
            Retry-After:
              description: Segundos a esperar antes de volver a intentar la solicitud.
              schema:
                type: string
                example: '30'
            X-RateLimit-Limit:
              description: Límite de la ventana activa.
              schema:
                type: string
                example: '5000'
            X-RateLimit-Remaining:
              description: Solicitudes restantes en la ventana activa.
              schema:
                type: string
                example: '0'
            X-RateLimit-Reset:
              description: Segundos restantes hasta el reset de la ventana activa.
              schema:
                type: string
                example: '30'
            RateLimit-Limit:
              description: Límite de la ventana activa en formato estándar.
              schema:
                type: string
                example: '5000'
            RateLimit-Remaining:
              description: Solicitudes restantes en la ventana activa en formato estándar.
              schema:
                type: string
                example: '0'
            RateLimit-Reset:
              description: >-
                Segundos hasta el reset de la ventana activa en formato
                estándar.
              schema:
                type: string
                example: '30'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
              examples:
                default:
                  summary: RATE_LIMITED
                  value:
                    request_id: req_rate_limit_1
                    error:
                      type: rate_limit_error
                      code: RATE_LIMITED
                      message: >-
                        The organization request limit was reached. Try again
                        later.
                      retryable: true
                      details: []
        '500':
          description: Error interno
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
              examples:
                default:
                  summary: INTERNAL_ERROR
                  value:
                    request_id: req_variant_metafields_1
                    error:
                      code: INTERNAL_ERROR
                      message: Could not list product variant metafield definitions
                      retryable: false
                      type: invalid_request_error
                      details: []
components:
  schemas:
    ApiProductMetafieldDefinitionsResponse:
      type: object
      properties:
        request_id:
          type: string
        data:
          type: object
          properties:
            definitions:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  object:
                    type: string
                    const: metafield_definition
                  key:
                    type: string
                  name:
                    type: string
                  description:
                    type:
                      - string
                      - 'null'
                  field_type:
                    $ref: '#/components/schemas/ApiSharedEnumf7fe6bfeb0'
                  validations:
                    $ref: '#/components/schemas/ApiSharedObjecta855803bd5'
                  values:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        configured:
                          type: boolean
                        observed:
                          type: boolean
                        product_count:
                          type: integer
                          minimum: 0
                      required:
                        - value
                        - configured
                        - observed
                        - product_count
                      additionalProperties: false
                required:
                  - id
                  - object
                  - key
                  - name
                  - description
                  - field_type
                  - validations
                additionalProperties: false
          required:
            - definitions
          additionalProperties: false
        warnings:
          type: array
          items: {}
      required:
        - request_id
        - data
        - warnings
      additionalProperties: false
    ApiErrorEnvelope:
      type: object
      properties:
        request_id:
          type: string
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - api_error
                - authentication_error
                - authorization_error
                - business_error
                - external_dependency_error
                - idempotency_error
                - invalid_request_error
                - rate_limit_error
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            details:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                  metadata:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties:
                      type:
                        - string
                        - number
                        - boolean
                        - 'null'
                required:
                  - code
                  - message
                additionalProperties: false
          required:
            - type
            - code
            - message
            - retryable
            - details
          additionalProperties: false
      required:
        - request_id
        - error
      additionalProperties: false
    ApiSharedEnumf7fe6bfeb0:
      type: string
      enum:
        - boolean
        - text
        - number
        - date
        - select
    ApiSharedObjecta855803bd5:
      type: object
      properties:
        required:
          type: boolean
        min_length:
          type: integer
          minimum: 0
        max_length:
          type: integer
          minimum: 1
        min:
          type: number
        max:
          type: number
        options:
          type: array
          items:
            type: string
      required:
        - required
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: Incluí tu API key en el header Authorization con el prefijo Bearer.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.