DOCS

Searching and filtering orders

/
Checkout•
InícioComércio eletrônico global Integração Integrar Checkout Pesquisar e filtrar pedidos

Pesquisa e filtragem de pedidos

Obtenha listas de pedidos com GraphQL.

Usando a consulta orders em GraphQL, você pode obter listas paginadas de pedidos com vários critérios. Isso é útil quando você precisa de uma lista de pedidos por país, entre datas específicas, para construir uma pesquisa, etc.

1

Obtenha sua chave de API

Obtenha uma conta do Zonos: Para usar a API do Zonos, você precisará de uma chave de API. Para obter sua chave, você precisará preencher nosso formulário de inscrição. O processo de integração começará assim que você tiver um acordo de conta em vigor. Durante a integração, um representante ajudará você a configurar sua conta corretamente para obter as respostas mais precisas da API.

Acesse sua chave de API aqui se você tiver uma conta do Zonos. Isso permitirá que você se autentique com a API do Zonos. Se você não tiver uma conta, consulte a observação acima.

2

Decida quais detalhes obter

Você pode consultar listas de pedidos com base em accountOrderIds semelhantes ou fornecendo um intervalo de datas entre as quais os pedidos foram publicados. Para obter uma lista completa dos campos disponíveis, consulte a referência da API GraphQL.

Em cada pedido individual que você consulta, todos os campos normais de Order estão disponíveis, por exemplo, o país, informações de envio, totais de landed cost, etc. Todos os campos possíveis estão listados na referência da API 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
      }
    }
  }
}

Variáveis

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

Enviar as páginas para buscar

Todas as consultas que recuperam listas suportam paginação no estilo Relay. A variável first permite que você especifique quantos objetos são retornados.

Consulta

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

Variáveis

1
2
3
{
  "first": 20
}
4

Envie sua solicitação

Agora que você construiu sua solicitação e a configurou, você pode enviar uma solicitação POST para a API da Zonos. Certifique-se de autenticar com sua chave de API e fornecer o cabeçalho de versão correto em sua solicitação.

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

Query

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
        }
      }
    }
  }
}

Variáveis

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

Resposta

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
          }
        ]
      }
    }
  ]
}

Esta página foi útil?

© 2024 Zonoszonos.com
Nesta página:
  • Pesquisa e filtragem de pedidos
  • Obtenha sua chave de API
  • Decida quais detalhes obter
  • Enviar as páginas para buscar
  • Envie sua solicitação