GET /api/rest/order/{rayoOrderId}
Bearer auth

Retrieves a fulfillment order in the Rayo system by its Rayo order id. Requires a valid JWT Bearer token.

Path parameters

  • rayoOrderId string(uuid) Required

    Rayo Order ID

Responses

  • 200 application/json

    Order details retrieved successfully

    Hide response attribute Show response attribute object
    • orden object Required

      Additional properties are allowed.

      Hide orden attributes Show orden attributes object
      • id string(uuid) Required
      • almacen object

        Additional properties are allowed.

        Hide almacen attribute Show almacen attribute object
        • nombre_almacen string

      • fecha_programacion string(date-time) | null | string

        Scheduled date/time (if PROGRAMADA). Format can vary.

        One of:
        string-1 string(date-time) | null string-2 string | null
      • notificaciones boolean
      • tipo_servicio string

        Service type (no enum validation enforced by the API).

      • rastreo_pdf string | null

        URL to the tracking/label PDF if available.

      • rastreo_url string | null

        Carrier tracking URL.

      • rastreo_numero string | null

        Carrier tracking number.

      • rastreo_paqueteria string | null

        Carrier name.

      • estados_orden array[object]
        Hide estados_orden attributes Show estados_orden attributes object
        • timestamp string Required

          Timestamp in ISO-8601 format (as returned by API).

        • estado_orden string Required

          Order status (no enum validation enforced by the API).

      • consumidor object

        Additional properties are allowed.

        Hide consumidor attributes Show consumidor attributes object
        • nombre string
        • telefono string
        • email string | null
        • calle string
        • no_exterior string
        • no_interior string | null
        • colonia string
        • ciudad string
        • codigo_postal string
        • estado string
        • lat number | null
        • lng number | null
      • empaquetado object

        Additional properties are allowed.

        Hide empaquetado attribute Show empaquetado attribute object
        • titulo string
      • detalle_orden array[object]
        Hide detalle_orden attributes Show detalle_orden attributes object
        • cantidad integer Required

          Minimum value is 1.

        • producto object Required

          Additional properties are allowed.

          Hide producto attributes Show producto attributes object
          • nombre string
          • sku string
        • recogido boolean
      • tienda_orden_ref string | null

        Client order reference (if provided).

      • precio_um number | null

        Order price amount (unit/meaning defined by account setup).
  • default application/json

    Unexpected error

    Hide response attributes Show response attributes object
    • error string Required
    • code string Required
    • path string
GET /api/rest/order/{rayoOrderId} 
curl \
 --request GET 'https://cerebro.techrayo.com/api/rest/order/{rayoOrderId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "orden": {
    "id": "b334e977-fdbd-47c1-905f-aeb73802ac2f",
    "almacen": {
      "nombre_almacen": "Enviatodo.com"
    },
    "precio_um": 123,
    "consumidor": {
      "lat": 19.2906952,
      "lng": -103.7424127,
      "calle": "Av. de los reporteros",
      "email": null,
      "ciudad": "Villa de Alvarez",
      "estado": "Colima",
      "nombre": "Daniel",
      "colonia": "Lindavista",
      "telefono": "3122563881",
      "no_exterior": "411",
      "no_interior": "",
      "codigo_postal": "28979"
    },
    "empaquetado": {
      "titulo": "CAJA CHICA - EnviaTodo"
    },
    "rastreo_pdf": null,
    "rastreo_url": "https://www.estafeta.com/Herramientas/Rastreo/",
    "detalle_orden": [
      {
        "cantidad": 2,
        "producto": {
          "sku": "Balon",
          "nombre": "Balon de futbol"
        },
        "recogido": true
      }
    ],
    "estados_orden": [
      {
        "timestamp": "2022-04-29T16:41:53.419086+00:00",
        "estado_orden": "WAITING"
      },
      {
        "timestamp": "2022-04-29T16:47:53.650661+00:00",
        "estado_orden": "PICK"
      }
    ],
    "tipo_servicio": "NACIONAL",
    "notificaciones": true,
    "rastreo_numero": "1010000000130700890039",
    "tienda_orden_ref": null,
    "fecha_programacion": null,
    "rastreo_paqueteria": "ESTAFETA"
  }
}
Response examples (default) 
{
  "error": "internal error",
  "code": "unexpected",
  "path": "$"
}