Saltar al contenido principal

Crear un metafield de dirección

API operation: Abrir la operación en la Referencia de la API

Usa POST /users/{user_id}/addresses/{address_id}/metafields para crear un metafield en la dirección de un usuario. La operación pública actual es AddressMetafield.register.

El comportamiento descrito requiere autenticación. Un usuario que no sea administrador solo puede actuar cuando user_id identifica al usuario autenticado, y la operación verifica que address_id pertenezca a ese usuario. Las claves de los metafields se validan por dirección, y value_type acepta integer, decimal, boolean, text o json.

Las claves de los metafields se validan dinámicamente para cada dirección. Consulta Atributos adicionales (Metafields) para conocer los conceptos comunes de sus campos.

Referencia de OpenAPI​

Operación: POST /users/{user_id}/addresses/{address_id}/metafields

Parámetros de ruta

NombreTipoObligatorioDescripción
user_idintegerSí—
address_idintegerSí—

Campos del cuerpo de la solicitud

NombreTipoObligatorio
modelanySí
object_idintegerSí
valueanySí
value_typestringSí

Respuestas

CódigoDescripción
200Respuesta exitosa. El contenido de result varía según la operación y se devuelve como JSON.
400Respuesta de error (error=true). Los errores de validación y de negocio comparten este código.
401Respuesta de error: sesión ausente, inválida, o nivel de usuario fuera de los permitidos. Respuesta de error: el proyecto no existe o no tiene una suscripción activa.
404Respuesta vacía: la versión de API solicitada no está admitida.
429Envelope de error: se excedió un límite de consumo del proyecto (o el sujeto está baneado). Lleva Retry-After y X-RateLimit-Limit/Remaining/Reset/Scope/Key.
500Respuesta de error: falló la búsqueda o inicialización del proyecto.
503Envelope de error: la aplicación está temporalmente en mantenimiento. Envelope de error: el proyecto está temporalmente en mantenimiento, o los límites de consumo no se pudieron evaluar y el límite aplicable está configurado con on_error = closed (cabecera Retry-After: 1).
Abrir esta operación en la Referencia de la API