addresses

Crear (o reutilizar) un destinatario

Create-or-reuse bajo el remitente sender_id (debe ser visible para la llave; si no → 404 ciego). Mismo dedupe normalizado que el carril de envíos; en una reutilización, alias/referencia/delivery_instructions NO se aplican (no forman parte de la identidad — la fila existente se devuelve intacta). El postal_code debe tener 5 dígitos y EXISTIR en el catálogo postal (SEPOMEX); si city/state vienen, deben ser coherentes con el CP (un desajuste responde 422 nombrando el valor esperado) y si se omiten se AUTOCOMPLETAN del catálogo — la misma validación de exactitud que POST /contacts/import. Requiere scope addresses:write.

post/recipients

Request

  • Base URL: https://api.enviadores.com.mx/api/v1
  • URL: https://api.enviadores.com.mx/api/v1/recipients
  • Auth: HTTP bearer

Headers

X-PDV-IDstring

Solo llaves de cuentas admin: el punto de venta cuyo fondo se carga/consulta. Requiere que la llave tenga una allowlist de PDVs configurada por un administrador (pdv_allowlist); sin allowlist, todo PDV real es denegado por defecto. Validado además contra los PDV activos. Cualquier violación → 403 PDV_NOT_ALLOWED. El valor personal_account equivale a omitir el header.

Request body

sender_idstring required

Remitente dueño (visible para la llave; si no → 404 ciego).

aliasstring

Nombre descriptivo ("Casa", "Oficina").

namestring required
phonestring required
emailstring email
streetstring required
numberstring
coloniastring required
citystring

Opcional: si se omite se autocompleta del catálogo SEPOMEX según el CP; si viene, debe coincidir con el CP (si no → 422 nombrando la ciudad esperada).

statestring

Opcional: si se omite se autocompleta del catálogo SEPOMEX según el CP; si viene, debe coincidir con el CP (si no → 422 nombrando el estado esperado).

postal_codestring required

5 dígitos; debe EXISTIR en el catálogo postal (SEPOMEX).

country'MX'
referenciastring

Referencias del domicilio.

delivery_instructionsstring

Example request

{
  "sender_id": "C0012345",
  "alias": "Oficina",
  "name": "María López",
  "phone": "8187654321",
  "street": "Av. Constitución",
  "number": "400",
  "colonia": "Centro",
  "city": "Monterrey",
  "state": "Nuevo León",
  "postal_code": "64000",
  "referencia": "Edificio azul, junto a la farmacia",
  "delivery_instructions": "Entregar en recepción"
}

Response

Destinatario idéntico ya existente reutilizado (created: false).

successunknown required
requestIdstring required

Correlación de logs; también en el header X-Request-Id.

Changes

No recorded changes to this operation across all 1 revision of this API.