Listar orden por ID

Cuando el rendimiento es una prioridad, puedes devolver una lista ligera que contenga únicamente los identificadores de las órdenes y sus marcas de tiempo last_updated. Esto permite que Talk2sync identifique eficientemente qué órdenes requieren sincronización antes de solicitar su información completa.

Devolver una lista ligera de órdenes

En lugar de devolver los objetos completos de cada orden, responde a la misma URL de consulta con una lista que contenga los identificadores de las órdenes y sus marcas de tiempo de última actualización.

Paginación basada en offset

Si tu endpoint admite paginación mediante un offset numérico, utiliza el parámetro offset:

GET https://www.example.com/your/endpoint/url?offset=0&sortorder=desc&jobid=123
T2SKey: {{API KEY}}

La respuesta debe seguir una estructura similar a:

{
  "paging": {
    "pageSize": 20,
    "itemsTotal": 2,
    "offset": 0
  },
  "orders": [
    {
      "_id": "75554554546",
      "orderid": "75554554546",
      "last_updated": 1517360038797
    },
    {
      "_id": "75554554546",
      "orderid": "75554554546",
      "last_updated": 1517360038797
    }
  ]
}

La respuesta ligera debe proporcionar, como mínimo:

  • _id: Identificador de la orden.
  • orderid: ID de la orden utilizado por el sistema de origen.
  • last_updated: Marca de tiempo que indica cuándo se actualizó la orden por última vez.
  • paging: Información de paginación necesaria para procesar la lista devuelta.

Paginación basada en cursor

Si los offsets numéricos no están disponibles para tu estrategia de paginación, utiliza un cursor mediante el parámetro next:

GET https://www.example.com/your/endpoint/url?next=YXNkaWhhc3BvZGhpYXM&sortorder=desc&jobid=123
T2SKey: {{API KEY}}

El valor del cursor representa la posición desde la cual debe recuperarse la siguiente página.

Obtener la orden completa

Una vez que Talk2sync determina que una orden necesita ser procesada, tu endpoint debe proporcionar una forma de recuperar la información completa utilizando su ID.

Utiliza el ID de la orden junto con el jobid:

GET https://www.example.com/your/endpoint/url?id=75554554546&jobid=123
T2SKey: {{API KEY}}

La respuesta completa puede contener el estado de la orden, fechas, totales, artículos, información del comprador, envíos, calificaciones, comentarios y mensajes.

Respuesta completa de la orden

{
  "_id": "75554554546",
  "orderid": "75554554546",
  "last_updated": 1517360038797,
  "status": "paid",
  "dateCreated": "",
  "dateClosed": "",
  "total": {
    "amount": 350,
    "currency": "USD"
  },
  "orderItems": [
    {
      "id": "7778545",
      "variation_id": "0",
      "quantity": 1,
      "unitPrice": 350,
      "currencyId": "USD"
    }
  ],
  "buyer": {
    "id": "4578889",
    "email": "testbuyer@example.com",
    "phone": "88888888",
    "firstName": "John",
    "lastName": "Doe",
    "billingaddress": {
      "addressline": "",
      "zipcode": "",
      "city": "",
      "state": "",
      "country": ""
    },
    "shipmentaddress": {
      "addressline": "",
      "zipcode": "",
      "city": "",
      "state": "",
      "country": ""
    }
  },
  "shipments": [
    {
      "id": "123",
      "shiptracknum": "TRK-1203912",
      "shipitems": ["4578889"],
      "shiptype": "Fedex",
      "shipstatus": "shipping"
    }
  ],
  "rating": 2.5,
  "feedback": "",
  "messages": [
    {
      "message_id": "",
      "date_created": 0,
      "from": "",
      "message": ""
    }
  ]
}

Flujo recomendado

La integración puede utilizar el siguiente flujo de dos etapas:

  1. Listar órdenes: Devuelve únicamente los IDs de las órdenes y sus valores last_updated.
  2. Identificar cambios: Talk2sync utiliza esta información para determinar qué órdenes requieren sincronización.
  3. Obtener los detalles: Solicita la orden completa utilizando su ID.
  4. Procesar la orden: Utiliza la respuesta completa para sincronizar los datos de la orden.

Siguientes pasos

Actualizado el: