DOCS

Searching and filtering orders

/

Bestellungen suchen und filtern

Holen Sie Listen von Bestellungen mit GraphQL ab.

Mit der orders-Abfrage in GraphQL können Sie paginierte Listen von Bestellungen mit verschiedenen Kriterien abrufen. Dies ist nützlich, wenn Sie eine Liste von Bestellungen nach Land, zwischen bestimmten Daten, zum Erstellen einer Suche usw. benötigen.

1

Holen Sie sich Ihren API-Schlüssel

Erstellen Sie ein Zonos Konto: Um die Zonos API nutzen zu können, benötigen Sie einen API-Schlüssel. Um Ihren Schlüssel zu erhalten, müssen Sie unser Anmeldeformular ausfüllen. Die Onboarding-Phase beginnt, sobald Sie eine Kontovereinbarung abgeschlossen haben. Während des Onboardings wird Ihnen ein Vertreter helfen, Ihr Konto korrekt einzurichten, damit Sie die genauesten API-Antworten erhalten.

Greifen Sie hier auf Ihren API-Schlüssel zu, wenn Sie ein Zonos Konto haben. Dies ermöglicht Ihnen die Authentifizierung bei der Zonos API. Wenn Sie kein Konto haben, beachten Sie die obige Anmerkung.

2

Entscheiden Sie, welche Details abgerufen werden sollen

Sie können Listen von Bestellungen abfragen, basierend auf ähnlichen accountOrderIds oder indem Sie einen Datumsbereich angeben, in dem Bestellungen veröffentlicht wurden. Für eine vollständige Liste der verfügbaren Felder konsultieren Sie das GraphQL API-Referenz.

Bei jeder einzelnen abgefragten Bestellung stehen alle normalen Order-Felder zur Verfügung, z. B. das Land, Versandinformationen, landed cost-Gesamtbeträge usw. Alle möglichen Felder sind in der GraphQL API-Referenz aufgeführt.

Abfrage

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

Variablen

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

Senden Sie die Seiten zum Abrufen

Alle Abfragen, die Listen abrufen, unterstützen die Relay-Style-Paginierung. Die Variable first ermöglicht es Ihnen, anzugeben, wie viele Objekte zurückgegeben werden.

Abfrage

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

Variablen

1
2
3
{
  "first": 20
}
4

Senden Sie Ihre Anfrage

Nachdem Sie Ihre Anfrage erstellt und konfiguriert haben, können Sie eine POST-Anfrage an die Zonos API senden. Stellen Sie sicher, dass Sie sich mit Ihrem API-Schlüssel authentifizieren und den richtigen Versionsheader in Ihrer Anfrage angeben.

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

Abfrage

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

Variablen

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

Antwort

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

War diese Seite hilfreich?