DOCS

Searching and filtering orders

/

Sökning och filtrering av beställningar

Hämta listor över beställningar med GraphQL.

Genom att använda orders-frågan i GraphQL kan du hämta paginerade listor över beställningar med olika kriterier. Detta är användbart när du behöver en lista över beställningar efter land, mellan specifika datum, för att bygga en sökning, etc.

1

Skaffa din API-nyckel

Skaffa ett Zonos-konto: För att använda Zonos API:t behöver du en API-nyckel. För att få din nyckel måste du fylla i vårt registreringsformulär. Onboarding kommer att börja när du har en kontovillkor på plats. Under onboarding kommer en representant att hjälpa dig att ställa in ditt konto korrekt så att du får de mest exakta API-svaren.

Åtkomst till din API-nyckel här om du har ett Zonos-konto. Detta kommer att tillåta dig att autentisera med Zonos API:t. Om du inte har ett konto, se notisen ovan.

2

Bestäm vilka detaljer som ska hämtas

Du kan fråga efter listor över beställningar baserat på liknande accountOrderIds eller genom att ange ett datumintervall inom vilket beställningar publicerades. För en komplett lista över tillgängliga fält, konsultera GraphQL API-referensen.

På varje individuell beställning du frågar, är alla normala Order-fält tillgängliga, t.ex. land, fraktinformation, landed cost-totalsummor, etc. Alla möjliga fält listas i GraphQL API-referensen.

Fråga

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

Skicka sidorna för att hämta

Alla frågor som hämtar listor stöder Relay-stil paginering. Variabeln first gör att du kan specificera hur många objekt som returneras.

Fråga

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

Skicka din begäran

Nu när du har byggt din begäran och konfigurerat den kan du skicka en POST begäran till Zonos API:et. Se till att autentisera med din API-nyckel och ange rätt versionshuvud i din begäran.

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

Fråga

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 den här sidan hjälpsam?