Obtenha sua chave de API
Crie uma conta no 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 que você receba as respostas de API mais precisas.
Acesse sua chave de API aqui se você tiver uma conta no Zonos. Isso permitirá que você se autentique com a API do Zonos. Se você não tiver uma conta, veja a nota acima.
Decida quais detalhes recuperar
Você pode consultar listas de pedidos com base em accountOrderId
s semelhantes ou fornecendo um intervalo de datas entre as quais os pedidos foram publicados. Para uma lista completa de campos disponíveis, consulte a referência da API GraphQL.
Em cada pedido individual que você consultar, 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
query orders($ordersFilter: OrdersFilter, $first: Int) {
orders(filter: $ordersFilter, first: $first) {
edges {
node {
id
# ... field names here
}
}
}
}
Variáveis
{
"ordersFilter": {
"between": {
"before": "2022-10-01",
"after": "2022-09-01"
}
}
}
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
query orders($filter: OrderFilter!, $first: Int) {
orders(orderFilter: $filter, first: $first) {
# ... field names here
}
}
Variáveis
{
"first": 20
}
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
query orders($ordersFilter: OrdersFilter, $first: Int) {
orders(filter: $ordersFilter, first: $first) {
edges {
node {
id
items {
description
hsCode
quantity
}
}
}
}
}
Variáveis
{
"ordersFilter": {
"between": {
"before": "2022-10-01",
"after": "2022-09-01"
}
},
"first": 20
}
Resposta
{
"data": [
{
"order": {
"id": "1000753",
"items": [
{
"description": "Blue Snorkle Set",
"hsCode": "9506290000",
"quantity": 2
}
]
}
}
]
}
Buscando e filtrando 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. Isso é útil quando você precisa de uma lista de pedidos por país, entre datas específicas, para construir uma busca, etc.