DOCS

Searching and filtering orders

/
Checkout•
InicioComercio electrónico global Integración Integra Checkout Búsqueda y filtrado de pedidos

Búsqueda y filtrado de pedidos

Recupera listas de pedidos con GraphQL.

Usando la consulta orders en GraphQL, puedes recuperar listas paginadas de pedidos con varios criterios. Esto es útil cuando necesitas una lista de pedidos por país, entre fechas específicas, para construir una búsqueda, etc.

1

Obtén tu clave API

Obtén una cuenta de Zonos: Para utilizar la API de Zonos necesitarás una clave API. Para obtener tu clave, deberás completar nuestro formulario de registro. La incorporación comenzará una vez que tengas un acuerdo de cuenta. Durante la incorporación, un representante te ayudará a configurar tu cuenta correctamente para que obtengas las respuestas API más precisas.

Accede a tu clave API aquí si tienes una cuenta de Zonos. Esto te permitirá autenticarte con la API de Zonos. Si no tienes una cuenta, consulta la nota anterior.

2

Decide qué detalles recuperar

Puedes consultar listas de pedidos basadas en accountOrderIds similares o proporcionando un rango de fechas entre las cuales se publicaron los pedidos. Para una lista completa de los campos disponibles, consulta la referencia de la API de GraphQL.

En cada pedido individual que consultes, todos los campos normales de Order están disponibles, por ejemplo, el país, la información de envío, los totales de landed cost, etc. Todos los campos posibles están listados en la referencia de la API de GraphQL.

Consulta

1
2
3
4
5
6
7
8
9
10
query orders($ordersFilter: OrdersFilter, $first: Int) {
  orders(filter: $ordersFilter, first: $first) {
    edges {
      node {
        id
        # ... field names here
      }
    }
  }
}

Variables

1
2
3
4
5
6
7
8
{
  "ordersFilter": {
    "between": {
      "before": "2022-10-01",
      "after": "2022-09-01"
    }
  }
}
3

Enviar las páginas para recuperar

Todas las consultas que recuperan listas admiten paginación al estilo de Relay. La variable first te permite especificar cuántos objetos se devuelven.

Consulta

1
2
3
4
5
query orders($filter: OrderFilter!, $first: Int) {
 orders(orderFilter: $filter, first: $first) {
  # ... field names here
 }
}

Variables

1
2
3
{
  "first": 20
}
4

Enviar tu solicitud

Ahora que has construido tu solicitud y la has configurado, puedes enviar una solicitud POST a la API de Zonos. Asegúrate de autenticarte con tu clave de API y proporcionar el encabezado de versión correcto en tu solicitud.

POST https://api.zonos.com/graphql/

Consulta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
query orders($ordersFilter: OrdersFilter, $first: Int) {
  orders(filter: $ordersFilter, first: $first) {
    edges {
      node {
        id
        items {
          description
          hsCode
          quantity
        }
      }
    }
  }
}

Variables

1
2
3
4
5
6
7
8
9
{
  "ordersFilter": {
    "between": {
      "before": "2022-10-01",
      "after": "2022-09-01"
    }
  },
  "first": 20
}

Respuesta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "data": [
    {
      "order": {
        "id": "1000753",
        "items": [
          {
            "description": "Blue Snorkle Set",
            "hsCode": "9506290000",
            "quantity": 2
          }
        ]
      }
    }
  ]
}

¿Fue útil esta página?

¿Preguntas?

Contáctenos.
© 2024 Zonoszonos.com
En esta página:
  • Búsqueda y filtrado de pedidos
  • Obtén tu clave API
  • Decide qué detalles recuperar
  • Enviar las páginas para recuperar
  • Enviar tu solicitud