Saltar al contenido principal

Modelo de dirección de usuario

Una dirección de usuario almacena datos de ubicación de entrega o contacto para un usuario. Los campos de nombre y teléfono del destinatario pueden representar a otra persona para que un negocio o repartidor pueda contactar al destinatario previsto.

Operaciones principales​

AcciónMétodoRecurso
ListarGET/users/{user_id}/addresses
ConsultarGET/users/{user_id}/addresses/{address_id}
CrearPOST/users/{user_id}/addresses
ActualizarPUT/users/{user_id}/addresses/{address_id}
EliminarDELETE/users/{user_id}/addresses/{address_id}

Las cinco operaciones descritas requieren autenticación. Listar, consultar y crear limitan a los solicitantes ordinarios al usuario de la ruta; los administradores y agentes pueden actuar en nombre de otros usuarios. La actualización y la eliminación pueden aplicar comprobaciones menos restrictivas del recurso padre; consulta las guías de esas operaciones para conocer las condiciones.

Los campos representativos incluyen id, user_id, name, middle_name, lastname, second_lastname, phone, cellphone, address, address_notes, zipcode, location, default, internal_number, tag, map_data, external_id y campos estructurados de calle, ciudad, estado y país. Los requisitos de campo siguen siendo específicos de cada operación.

Las direcciones pueden incluir metafields mediante params. Consulta Obtener metafields de dirección y Atributos adicionales (Metafields). Consulta las guías enlazadas para ver los esquemas completos de solicitud y respuesta.