DOCS

Searching and filtering orders

/

Cercare e filtrare ordini

Recupera elenchi di ordini con GraphQL.

Utilizzando la query orders in GraphQL, puoi recuperare elenchi paginati di ordini con vari criteri. Questo è utile quando hai bisogno di un elenco di ordini per paese, tra date specifiche, per costruire una ricerca, ecc.

1

Ottieni la tua chiave API

Ottieni un account Zonos: Per utilizzare l'API Zonos avrai bisogno di una chiave API. Per ottenere la tua chiave dovrai completare il nostro modulo di registrazione. L'onboarding inizierà una volta che avrai un accordo di account in atto. Durante l'onboarding, un rappresentante ti aiuterà a configurare correttamente il tuo account in modo da ricevere le risposte API più accurate.

Accedi alla tua chiave API qui se hai un account Zonos. Questo ti permetterà di autenticarti con l'API Zonos. Se non hai un account, consulta la nota sopra.

2

Decidi quali dettagli recuperare

Puoi interrogare elenchi di ordini basati su accountOrderIds simili o fornendo un intervallo di date entro il quale gli ordini sono stati pubblicati. Per un elenco completo dei campi disponibili, consulta il riferimento API GraphQL.

Su ogni singolo ordine che interroghi, sono disponibili tutti i normali campi Order, ad esempio, il paese, le informazioni di spedizione, i totali landed cost ecc. Tutti i campi possibili sono elencati nel riferimento API GraphQL.

Query

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

Variabili

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

Invia le pagine da recuperare

Tutte le query che recuperano elenchi supportano la paginazione in stile Relay. La variabile first consente di specificare quanti oggetti vengono restituiti.

Query

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

Variabili

1
2
3
{
  "first": 20
}
4

Invia la tua richiesta

Ora che hai costruito la tua richiesta e l'hai configurata, puoi inviare una POST richiesta all'API Zonos. Assicurati di autenticarti con la tua chiave API e di fornire l'intestazione di versione corretta nella tua richiesta.

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

Variabili

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

Risposta

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

Questa pagina è stata utile?