# Servicios de envío

Use los servicios de envío de la propia empresa de logística: listar servicios → cargar la configuración de un servicio → estimar → crear el pedido → pagar → volver a leerlo → seguir → cancelar un pedido de prueba.

Esta guía documenta únicamente las operaciones siguientes. Complételas en secuencia. La autenticación usa una cuenta de **cliente**.

Sustituya `YOUR_HOST` y `ACCESS_TOKEN` por los valores de su entorno.

## 1. Acceso (cliente)

```bash
curl -X POST https://YOUR_HOST/api/v1/user/customer/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"your_password"}'
```

Coloque el `access_token` devuelto en la cabecera de la petición:

```
Authorization: Bearer ACCESS_TOKEN
```

GraphQL usa la misma cabecera en `POST /api/graphql`.

**Verificación:** el login devuelve `access_token`. Una llamada posterior sin él devuelve `401`.

## 2. Listar servicios

**REST:** `GET /api/v1/customer/shipping-orders/services` — [Manual REST](/api/documentation#/paths/v1-customer-shipping-orders-services/get)

```bash
curl https://YOUR_HOST/api/v1/customer/shipping-orders/services \
  -H "Authorization: Bearer ACCESS_TOKEN"
```

**GraphQL:** `customerShippingOrderServices` ([Manual GraphQL](/api/graphql/documentation#/customer/customerShippingOrderServices))

Cada fila tiene `service_code`, `name`, `offer_pickup`, `allow_warehouse_delivery`. Una lista vacía significa que no hay ningún servicio asignado a este cliente.

**Verificación:** ha capturado un `service_code` (ejemplo abajo: `intl_express`).

## 3. Cargar la configuración de ese servicio

**REST:** `GET /api/v1/customer/shipping-orders/services/{serviceCode}/config` — [Manual REST](/api/documentation#/paths/v1-customer-shipping-orders-services-serviceCode--config/get)

```bash
curl https://YOUR_HOST/api/v1/customer/shipping-orders/services/intl_express/config \
  -H "Authorization: Bearer ACCESS_TOKEN"
```

**GraphQL:** `customerShippingOrderServiceConfig` ([Manual GraphQL](/api/graphql/documentation#/customer/customerShippingOrderServiceConfig))

**Verificación:** tiene al menos un `id` de almacén si este servicio permite la entrega en almacén. `403` significa que este cliente no tiene permitido ese servicio.

## 4. Estimar

**REST:** `POST /api/v1/customer/shipping-orders/services/{serviceCode}/estimate-price`

```bash
curl -X POST https://YOUR_HOST/api/v1/customer/shipping-orders/services/intl_express/estimate-price \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "origin_type": "warehouse",
    "warehouse_id": 7,
    "delivery_postcode": "M5V2H1",
    "delivery_country": "CA",
    "packages": [{
      "weight": 2,
      "length": 30,
      "width": 20,
      "height": 15,
      "weight_unit": 2,
      "dimension_unit": 2
    }]
  }'
```

`origin_type`: `warehouse` (entrega en un almacén) o `pickup` (la empresa recoge). Coincida con lo que el paso 3 indicó que el servicio permite.

**Verificación:** `result` es true y tiene un precio (o un indicador de «necesita cotización» para tarifa manual). Aún no cree si el destino o el paquete se rechazan.

## 5. Crear el pedido

**REST:** `POST /api/v1/customer/shipping-orders/services/{serviceCode}/orders`

Envíe `Idempotency-Key`.

```bash
curl -X POST https://YOUR_HOST/api/v1/customer/shipping-orders/services/intl_express/orders \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: dev-ship-001" \
  -d '{
    "origin_type": "warehouse",
    "warehouse_id": 7,
    "reference": "DEV-SHIP-001",
    "delivery_name": "Jane Recipient",
    "delivery_telephone": "5555555555",
    "delivery_email": "jane@example.com",
    "delivery_address_1": "123 King St W",
    "delivery_city": "Toronto",
    "delivery_province": "ON",
    "delivery_country": "CA",
    "delivery_postcode": "M5V2H1",
    "package": [{
      "weight": 2,
      "length": 30,
      "width": 20,
      "height": 15,
      "weight_unit": 2,
      "dimension_unit": 2,
      "quantity": 1
    }]
  }'
```

**Verificación:** la respuesta tiene un `id` de pedido. Guarde `id`, `tracking_number` / `reference_number` cuando estén presentes.

## 6. Pagar

**REST:** `POST /api/v1/customer/shipping-orders/{id}/pay`

```bash
curl -X POST https://YOUR_HOST/api/v1/customer/shipping-orders/9001/pay \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```

Opcional: primero `GET /api/v1/customer/shipping-orders/{id}/payment-info`. Un `402` significa que el saldo no cubre el importe — recargue y reintente.

**Verificación:** el pedido ya no es pagable, o `remaining_balance` es `0`.

## 7. Consultar el pedido y el seguimiento

**REST:** `GET /api/v1/customer/shipping-orders/{id}` — [Manual REST](/api/documentation#/paths/v1-customer-shipping-orders-id/get)

```bash
curl https://YOUR_HOST/api/v1/customer/shipping-orders/9001 \
  -H "Authorization: Bearer ACCESS_TOKEN"
```

**GraphQL:** `customerShippingOrderShow` ([Manual GraphQL](/api/graphql/documentation#/customer/customerShippingOrderShow))

Cuando el pedido tiene un `tracking_number`, seguimiento público (sin token):

```bash
curl https://YOUR_HOST/api/v1/tracking/SR123456789012
```

[Manual REST](/api/documentation#/operations/getPublicTracking) · [Manual GraphQL](/api/graphql/documentation#/tracking/trackingPublic)

**Verificación:** el detalle es el pedido de este cliente. El seguimiento público lo encuentra cuando existe un número.

## 8. Configurar notificaciones de eventos

| Ajuste | Evento | Cuándo |
|---|---|---|
| `order_create_webhook_url` | `order.created` | Persistir `id` y números de seguimiento |
| `tracking_event_webhook_url` | `tracking.event` | Línea de tiempo |
| `order_status_change_webhook_url` | `order.status_change` | Estado en su sistema |

**REST:** `PUT /api/v1/webhook-settings` — [Manual REST](/api/documentation#/paths/v1-webhook-settings/put)

**GraphQL:** `webhookSettingsUpdate` ([Manual GraphQL](/api/graphql/documentation#/webhooks/webhookSettingsUpdate)).

Verifique **v2** sobre el cuerpo crudo: `HMAC_SHA256(timestamp + "." + raw_body, secret)` contra `X-Webhook-Signature-V2`. Deduplique con `X-Webhook-Event-Id`. Responda **2xx en menos de 3 segundos**.

```php
$raw = file_get_contents('php://input');
$ts  = $_SERVER['HTTP_X_WEBHOOK_TIMESTAMP'] ?? '';
$sig = $_SERVER['HTTP_X_WEBHOOK_SIGNATURE_V2'] ?? '';
$expected = hash_hmac('sha256', $ts . '.' . $raw, $sharedSecret);
if (!hash_equals($expected, $sig)) {
    http_response_code(401);
    exit;
}
```

**Verificación:** una creación de prueba produce `order.created` con ese `id`.

## 9. Cancelar un pedido de prueba

**REST:** `POST /api/v1/customer/shipping-orders/{id}/cancel`

```bash
curl -X POST https://YOUR_HOST/api/v1/customer/shipping-orders/9001/cancel \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```

**Verificación:** una segunda cancelación es segura, o la API indica que el pedido ya está cancelado. `422` significa que este estado no se puede cancelar.

## Lista de pruebas

Use un `reference` de prueba como `DEV-SHIP-001`:

- [ ] La lista de servicios no está vacía; ha capturado un `service_code`.
- [ ] La configuración devuelve almacenes / embalaje para ese servicio.
- [ ] La estimación devuelve un precio (o un indicador claro de que necesita cotización).
- [ ] Crear devuelve un `id`; el mismo `Idempotency-Key` no crea un segundo pedido.
- [ ] Pagar se completa, **o** ha confirmado que hay que recargar el saldo (`402`).
- [ ] El detalle muestra el pedido de este cliente.
- [ ] El seguimiento público encuentra el envío cuando existe un número de seguimiento.
- [ ] Cancelar se completa, **o** ha confirmado que este estado no se puede cancelar.