Saltar al contenido principal

Crear ubicación del cliente

POSThttps://carchost.fieldcontrol.com.br/customers/{customerId}/locations

Crea una ubicación para el cliente.

Requiere los headers X-Api-Key, User-Agent y Content-Type: application/json. Límite: 1 solicitud por segundo (más información).

Solicitud​

Parámetros de ruta

customerIdstringobligatorio

Identificador del cliente.

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Cuerpo de la solicitud

JSON, enviado con el header Content-Type: application/json.

namestringobligatorio

Nombre de la ubicación.

notesstring

Observaciones de la ubicación.

Acepta: null.

archivedboolean

Archiva la ubicación. La ubicación principal no se puede archivar.

addressobjectobligatorio
Campos de address
postalCodestring

Código postal (CEP) de 8 dígitos, solo números.

Acepta: null.

streetstring

Acepta: null.

numberstring

Acepta: null.

neighborhoodstring

Acepta: null.

citystringobligatorio
statestringobligatorio
complementstring

Acepta: null.

coordsobjectobligatorio
Campos de coords
latitudenumberobligatorio

De -90 a 90.

longitudenumberobligatorio

De -180 a 180.

Respuestas

  • 201

    Ubicación creada.

  • 401

    Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

  • 403

    Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

  • 404

    Recurso no encontrado. El cuerpo de la respuesta está vacío.

  • 422

    Datos de la solicitud inválidos (resourceValidationErr).

  • 429

    Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

  • 500

    Error inesperado en el servidor.