Obtenir votre clé API
Obtenir un compte Zonos : Pour utiliser l'API Zonos, vous aurez besoin d'une clé API. Pour l'obtenir, vous devrez remplir notre formulaire d'inscription. L'onboarding commencera une fois votre accord de compte en place. Pendant l'onboarding, un représentant vous aidera à configurer correctement votre compte afin d'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 auprès de l'API Zonos. Si vous n'avez pas de compte, consultez la note ci-dessus.
Choisir les détails à récupérer
Vous pouvez interroger des listes de commandes en fonction de accountOrderId 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.
Pour chaque commande individuelle que vous interrogez, tous les champs Order normaux sont disponibles, p. ex. 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 orders($ordersFilter: OrdersFilter, $first: Int) { orders(filter: $ordersFilter, first: $first) { edges { node { id # ... field names here } } }}Spécifier 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.
query orders($ordersFilter: OrdersFilter, $first: Int) { orders(filter: $ordersFilter, first: $first) { edges { node { id } } pageInfo { hasNextPage endCursor } }}Envoyer votre requête
Maintenant que vous avez construit votre requête et l'avez configurée, vous pouvez envoyer une requête POST à l'API Zonos. Assurez-vous de vous authentifier avec votre clé API et de fournir l'en-tête de version correct dans votre requête.
POST https://api.zonos.com/graphql
query orders($ordersFilter: OrdersFilter, $first: Int) { orders(filter: $ordersFilter, first: $first) { edges { node { id items { description hsCode quantity } } } }}
Rechercher et filtrer les commandes
Récupérez des listes de commandes avec GraphQL.À l'aide de la requête
ordersdans 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.