DOCS

Searching and filtering orders

/

Søking og filtrering av bestillinger

Hent lister over bestillinger med GraphQL.

Ved å bruke orders spørringen i GraphQL kan du hente paginerte lister over bestillinger med ulike kriterier. Dette er nyttig når du trenger en liste over bestillinger etter land, mellom spesifikke datoer, for å bygge et søk, osv.

1

Få din API-nøkkel

Få en Zonos konto: For å bruke Zonos API-en trenger du en API-nøkkel. For å få nøkkelen din må du fylle ut vårt registreringsskjema. Onboarding vil begynne når du har en kontoavtale på plass. Under onboarding vil en representant hjelpe deg med å sette opp kontoen din riktig slik at du får de mest nøyaktige API-svarene.

Få tilgang til din API-nøkkel her hvis du har en Zonos konto. Dette vil tillate deg å autentisere deg med Zonos API-en. Hvis du ikke har en konto, se notatet ovenfor.

2

Bestem hvilke detaljer som skal hentes

Du kan spørre om lister over bestillinger basert på lignende accountOrderIds eller ved å oppgi et datointervall mellom hvilke bestillinger ble publisert. For en komplett liste over tilgjengelige felt, se GraphQL API-referansen.

På hver enkelt bestilling du spør om, er alle normale Order felt tilgjengelige, f.eks. landet, fraktinformasjon, landed cost totaler, osv. Alle mulige felt er listet i GraphQL API-referansen.

Spørring

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 sidene for å hente

Alle forespørslene som henter lister støtter Relay-stil paginering. Variabelen first lar deg spesifisere hvor mange objekter som returneres.

Forespørsel

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 forespørsel

Nå som du har bygget forespørselen din og konfigurert den, kan du sende en POST forespørsel til Zonos API. Sørg for å autentisere med API-nøkkelen din og gi den riktige versjonshodet i forespørselen din.

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

Forespørsel

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 siden nyttig?