DOCS

Searching and filtering orders

/

Поиск и фильтрация заказов

Получайте списки заказов с помощью GraphQL.

Используя запрос orders в GraphQL, вы можете получать пагинированные списки заказов с различными критериями. Это полезно, когда вам нужен список заказов по странам, в определенные даты, для создания поиска и т.д.

1

Получите свой API-ключ

Получите аккаунт Zonos: Для использования API Zonos вам потребуется API-ключ. Чтобы получить свой ключ, вам нужно заполнить нашу форму регистрации. Процесс внедрения начнется, как только у вас будет соглашение об аккаунте. Во время внедрения представитель поможет вам правильно настроить ваш аккаунт, чтобы вы получали наиболее точные ответы API.

Получите свой API-ключ здесь, если у вас есть аккаунт Zonos. Это позволит вам аутентифицироваться с API Zonos. Если у вас нет аккаунта, смотрите примечание выше.

2

Решите, какие детали получить

Вы можете запрашивать списки заказов на основе похожих accountOrderId или предоставив диапазон дат, в течение которого были опубликованы заказы. Для полного списка доступных полей обратитесь к справочнику API GraphQL.

На каждом отдельном заказе, который вы запрашиваете, доступны все обычные поля Order, например, страна, информация о доставке, итоги landed cost и т.д. Все возможные поля перечислены в справочнике API GraphQL.

Запрос

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

Переменные

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

Отправьте страницы для получения

Все запросы, которые извлекают списки, поддерживают пагинацию в стиле Relay. Переменная first позволяет вам указать, сколько объектов будет возвращено.

Запрос

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

Переменные

1
2
3
{
  "first": 20
}
4

Отправьте ваш запрос

Теперь, когда вы составили ваш запрос и настроили его, вы можете отправить POST запрос к API Zonos. Убедитесь, что вы аутентифицировались с помощью вашего API ключа и предоставили правильный заголовок версии в вашем запросе.

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

Запрос

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

Переменные

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

Ответ

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

Была ли эта страница полезной?


На этой странице: