DOCS

Searching and filtering orders

/

Søgning og filtrering af ordrer

Hent lister over ordrer med GraphQL.

Ved at bruge orders forespørgslen i GraphQL kan du hente paginerede lister over ordrer med forskellige kriterier. Dette er nyttigt, når du har brug for en liste over ordrer efter land, mellem specifikke datoer, til at opbygge en søgning osv.

1

Få din API-nøgle

Få en Zonos konto: For at kunne bruge Zonos API'en skal du have en API-nøgle. For at få din nøgle skal du udfylde vores tilmeldingsformular. Onboarding vil begynde, når du har en kontoaftale på plads. Under onboarding vil en repræsentant hjælpe dig med at opsætte din konto korrekt, så du får de mest præcise API-svar.

Adgang til din API-nøgle her, hvis du har en Zonos konto. Dette vil give dig mulighed for at autentificere dig med Zonos API'en. Hvis du ikke har en konto, se noten ovenfor.

2

Beslut hvilke detaljer der skal hentes

Du kan forespørge lister over ordrer baseret på lignende accountOrderIds eller ved at angive et datointerval, inden for hvilket ordrer blev offentliggjort. For en komplet liste over tilgængelige felter, se GraphQL API reference.

På hver enkelt ordre, du forespørger, er alle normale Order felter tilgængelige, f.eks. landet, forsendelsesoplysninger, landed cost totaler osv. Alle mulige felter er listet i GraphQL API reference.

Forespørgsel

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

Variabler

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

Send siderne til at hente

Alle forespørgsler, der henter lister, understøtter Relay-stil paginering. Variablen first giver dig mulighed for at angive, hvor mange objekter der returneres.

Forespørgsel

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

Variabler

1
2
3
{
  "first": 20
}
4

Send din anmodning

Nu hvor du har opbygget din anmodning og konfigureret den, kan du sende en POST anmodning til Zonos API'en. Sørg for at autentificere med din API-nøgle og angive den korrekte versionsheader i din anmodning.

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

Forespørgsel

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

Variabler

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

Svar

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

Var denne side nyttig?