ProofOfDelivery

Prueba de entrega o de recogida de una Order (o de un ítem concreto, ordered_good_id). El repartidor la genera al entregar/recoger y el sistema la usa para confirmar el hito.

Tipo y contenido

type indica de qué tipo es la prueba y determina el contenido devuelto en data:

type data
code Código de confirmación de 4 dígitos (ProofOfDeliveryCode); el cliente lo dicta y el repartidor lo confirma.
signature Firma del receptor (ProofOfDeliverySignature).
picture Fotos de la entrega (ProofOfDeliveryPicture).
form Respuestas de un formulario de prueba de entrega (ProofOfDeliveryForm).

status es delivered (entrega al cliente) o collected (recogida en el comercio). El endpoint proof-of-deliveries/confirmation-code devuelve el código para validar la entrega.

Estructura de Datos

Atributo Tipo Descripción
id int
type string Tipo de prueba: code, signature, picture o form.
created_at datetime\|null Fecha de creación.
updated_at datetime\|null Fecha de última modificación.
order_id int Orden a la que pertenece la prueba.
ordered_good_id int\|null Ítem concreto de la orden, si la prueba es por ítem.
provider_id int\|null Repartidor que generó la prueba.
company_id int\|null Compañía de la orden (oculto en la respuesta).
status string Hito que prueba: delivered o collected.
comments string\|null Comentarios asociados a la prueba.
allLogs ApiLog> Registros de auditoría de la API, incluidos los internos.
code ProofOfDeliveryCode\|null Código de confirmación (si type = code); oculto, se expone vía data.
form ProofOfDeliveryForm> Respuestas del formulario (si type = form); oculto, se expone vía data.
data mixed Contenido de la prueba según su type.
data_old array Forma anterior de data (compatibilidad).
logs ApiLog> Registros de auditoría de la API visibles.
order Order Orden a la que pertenece la prueba.
picture ProofOfDeliveryPicture> Fotos de la entrega (si type = picture); oculto, se expone vía data.
signature ProofOfDeliverySignature\|null Firma del receptor (si type = signature); oculto, se expone vía data.

Ver Json

Endpoints

Insertar ProofOfDelivery

Insertar ProofOfDelivery de OrderProvider

Registrar una prueba de entrega

El repartidor sube la prueba (code, signature, picture o form) para el OrderProvider indicado y confirma la entrega o la recogida.

Método URI Cabeceras
POST /companies/{companyId}/order-providers/{orderProviderId}/proof-of-deliveries Authorization

Listar ProofOfDelivery

Listar ProofOfDelivery de Order

Listar las pruebas de entrega de una orden

Devuelve las ProofOfDelivery de la orden indicada.

Método URI Cabeceras
GET /companies/{companyId}/orders/{orderId}/proof-of-deliveries Authorization

Listar ProofOfDelivery de OrderProvider

Listar las pruebas de entrega de una asignación

Devuelve las ProofOfDelivery del OrderProvider indicado.

Método URI Cabeceras
GET /companies/{companyId}/order-providers/{orderProviderId}/proof-of-deliveries Authorization

Mostrar ProofOfDelivery

Ver una prueba de entrega

Devuelve la ProofOfDelivery indicada con su contenido (data).

Método URI Cabeceras
GET /companies/{companyId}/proof-of-deliveries/{proofOfDeliveryId} Authorization

Código de confirmación de una asignación

Devuelve el código de la prueba de entrega tipo code del OrderProvider indicado (para dictárselo al repartidor).

Método URI Cabeceras
GET /companies/{companyId}/order-providers/{orderProviderId}/proof-of-deliveries/confirmation-code Authorization

Código de confirmación de un ítem

Devuelve el código de la prueba de entrega (ProofOfDelivery tipo code) del ítem indicado.

Método URI Cabeceras
GET /companies/{companyId}/ordered-goods/{orderedGoodId}/proof-of-deliveries/confirmation-code Authorization

Acciones de ProofOfDelivery

Código de confirmación (variante por orden y repartidor)

Igual que el anterior pero identificando la asignación por orderId + providerId.

Método URI Cabeceras
GET /companies/{companyId}/orders/{orderId}/providers/{providerId}/proof-of-deliveries/confirmation-code Authorization

Relaciones