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. L'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 afin que vous obteniez 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.
Décidez des détails à récupérer
Vous pouvez interroger des listes de commandes en fonction de accountOrderIds similaires ou en fournissant une plage de dates pendant laquelle les commandes ont été publiées. Pour une liste complète des champs disponibles, consultez la référence API GraphQL.
Pour chaque commande individuelle que vous interrogez, tous les champs Order normaux sont disponibles, par exemple, le pays, les informations d'expédition, les totaux de landed cost, etc. Tous les champs possibles sont listés dans la référence API GraphQL.
Requête
query orders($ordersFilter: OrdersFilter, $first: Int) {
orders(filter: $ordersFilter, first: $first) {
edges {
node {
id
# ... field names here
}
}
}
}
Variables
{
"ordersFilter": {
"between": {
"before": "2022-10-01",
"after": "2022-09-01"
}
}
}
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
query orders($filter: OrderFilter!, $first: Int) {
orders(orderFilter: $filter, first: $first) {
# ... field names here
}
}
Variables
{
"first": 20
}
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
query orders($ordersFilter: OrdersFilter, $first: Int) {
orders(filter: $ordersFilter, first: $first) {
edges {
node {
id
items {
description
hsCode
quantity
}
}
}
}
}
Variables
{
"ordersFilter": {
"between": {
"before": "2022-10-01",
"after": "2022-09-01"
}
},
"first": 20
}
Réponse
{
"data": [
{
"order": {
"id": "1000753",
"items": [
{
"description": "Blue Snorkle Set",
"hsCode": "9506290000",
"quantity": 2
}
]
}
}
]
}
Recherche et filtrage des commandes
Récupérez des listes de commandes avec GraphQL.En utilisant la requête
ordersdans GraphQL, vous pouvez récupérer des listes paginées de commandes avec 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.