DOCS

Pesquisar e filtrar pedidos

Pesquise e filtre pedidos

Recupere listas de pedidos com GraphQL.

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

1

Obtenha sua chave API

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

Acesse sua chave API aqui se você tiver uma conta Zonos. Isso permitirá que você se autentique com a API Zonos. Se você não possui uma conta, veja a nota acima.

Você pode consultar listas de pedidos com base em accountOrderIds semelhantes ou fornecendo um intervalo de datas entre os 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 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.

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

Todas as consultas que recuperam listas suportam paginação estilo Relay. A variável first permite especificar quantos objetos serão retornados.

1query orders($ordersFilter: OrdersFilter, $first: Int) {
2 orders(filter: $ordersFilter, first: $first) {
3 edges {
4 node {
5 id
6 }
7 }
8 pageInfo {
9 hasNextPage
10 endCursor
11 }
12 }
13}

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

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

1query orders($ordersFilter: OrdersFilter, $first: Int) {
2 orders(filter: $ordersFilter, first: $first) {
3 edges {
4 node {
5 id
6 items {
7 description
8 hsCode
9 quantity
10 }
11 }
12 }
13 }
14}
GraphQL API ReferenceTypes, inputs, and operations used in this guide

Esta página foi útil?