DOCS

Zoeken en filteren van bestellingen

Bestellingen zoeken en filteren

Haal lijsten van bestellingen op met GraphQL.

Met de orders query in GraphQL kun je gepagineerde lijsten van bestellingen ophalen op basis van verschillende criteria. Dit is nuttig wanneer je een lijst van bestellingen per land, tussen specifieke data, wilt opbouwen, enzovoort.

1

Verkrijg je API-sleutel

Krijg een Zonos account: Om de Zonos API te gebruiken, heb je een API-sleutel nodig. Om je sleutel te krijgen, moet je ons aanmeldformulier invullen. De onboarding begint zodra je een accountovereenkomst hebt. Tijdens de onboarding zal een vertegenwoordiger je helpen om je account correct in te stellen, zodat je de meest nauwkeurige API-responses ontvangt.

Toegang tot je API-sleutel hier als je een Zonos account hebt. Dit stelt je in staat om je te authentiseren met de Zonos API. Als je geen account hebt, zie dan de opmerking hierboven.

2

Beslis welke details je wilt ophalen

Je kunt lijsten van bestellingen opvragen op basis van vergelijkbare accountOrderIds of door een datumbereik op te geven waarbinnen bestellingen zijn gepubliceerd. Voor een complete lijst van beschikbare velden, raadpleeg de GraphQL API-referentie.

Bij elke individuele bestelling die je opvraagt, zijn alle normale Order velden beschikbaar, bijvoorbeeld het land, verzendinformatie, landed cost totalen, enzovoort. Alle mogelijke velden zijn vermeld in de GraphQL API-referentie.

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

Variabelen

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

Stuur de pagina's om op te halen

Alle queries die lijsten ophalen ondersteunen Relay-stijl paginering. De first variabele stelt je in staat om op te geven hoeveel objecten worden geretourneerd.

Query

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

Variabelen

1
2
3
{
  "first": 20
}
4

Verstuur je verzoek

Nu je je verzoek hebt opgebouwd en geconfigureerd, kun je een POST-verzoek sturen naar de Zonos API. Zorg ervoor dat je je API-sleutel gebruikt om te authenticeren en de juiste versie-header aan je verzoek toevoegt.

POST https://api.zonos.com/graphql

Vraag

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

Variabelen

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

Antwoord

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

Was deze pagina nuttig?