DOCS

Searching and filtering orders

/
Checkout•
AccueilCommerce électronique mondial Intégration Intégrer Checkout Rechercher et filtrer les commandes

Recherche et filtrage des commandes

Récupérez des listes de commandes avec GraphQL.

En utilisant la requête orders en GraphQL, vous pouvez récupérer des listes paginées de commandes selon divers critères. Cela est utile lorsque vous avez besoin d'une liste de commandes par pays, entre des dates spécifiques, pour construire une recherche, etc.

1

Obtenez votre clé API

Obtenez un compte Zonos : Pour utiliser l'API Zonos, vous aurez besoin d'une clé API. Pour obtenir votre clé, vous devrez remplir notre formulaire d'inscription. Le processus d'intégration commencera une fois que vous aurez un accord de compte en place. Pendant l'intégration, un représentant vous aidera à configurer correctement votre compte pour obtenir les réponses API les plus précises.

Accédez à votre clé API ici si vous avez un compte Zonos. Cela vous permettra de vous authentifier avec l'API Zonos. Si vous n'avez pas de compte, consultez la note ci-dessus.

2

Décidez des détails à récupérer

Vous pouvez interroger des listes de commandes basées sur des accountOrderIds similaires ou en fournissant une plage de dates entre lesquelles les commandes ont été publiées. Pour une liste complète des champs disponibles, consultez la référence de l'API GraphQL.

Sur chaque commande individuelle que vous interrogez, tous les champs normaux de Order sont disponibles, par exemple, le pays, les informations d'expédition, les totaux de landed cost, etc. Tous les champs possibles sont répertoriés dans la référence de l'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
      }
    }
  }
}

Variables

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

Envoyer les pages à récupérer

Toutes les requêtes qui récupèrent des listes prennent en charge la pagination de style Relay. La variable first vous permet de spécifier combien d'objets sont renvoyés.

Requête

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

Envoyer votre demande

Maintenant que vous avez construit votre demande et que vous l'avez configurée, vous pouvez envoyer une demande POST à l'API Zonos. Assurez-vous de vous authentifier avec votre clé API et de fournir l'en-tête de version correcte dans votre demande.

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

Variables

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

Réponse

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

Cette page était-elle utile?

Des questions ?

Contactez-nous.
© 2024 Zonoszonos.com
Sur cette page :
  • Recherche et filtrage des commandes
  • Obtenez votre clé API
  • Décidez des détails à récupérer
  • Envoyer les pages à récupérer
  • Envoyer votre demande