DOCS

Searching and filtering orders

/

주문 검색 및 필터링

GraphQL로 주문 목록을 검색하세요.

GraphQL의 orders 쿼리를 사용하면 다양한 기준으로 페이지가 나뉜 주문 목록을 검색할 수 있습니다. 이는 특정 국가별, 특정 날짜 사이의 주문 목록을 구축할 때 유용합니다.

1

API 키 받기

Zonos 계정 만들기: Zonos API를 사용하려면 API 키가 필요합니다. 키를 받으려면 가입 양식을 작성해야 합니다. 계정 계약이 체결되면 온보딩이 시작됩니다. 온보딩 동안 담당자가 귀하의 계정을 올바르게 설정하여 가장 정확한 API 응답을 받을 수 있도록 도와드립니다.

Zonos 계정이 있는 경우 API 키에 액세스하세요. 이를 통해 Zonos API에 인증할 수 있습니다. 계정이 없는 경우 위의 주석을 참조하세요.

2

검색할 세부정보 결정하기

유사한 accountOrderId를 기반으로 주문 목록을 쿼리하거나 주문이 게시된 날짜 범위를 제공하여 쿼리할 수 있습니다. 사용 가능한 필드의 전체 목록은 GraphQL API 참조를 참조하세요.

쿼리하는 각 개별 주문에 대해 모든 일반 Order 필드가 사용 가능하며, 예를 들어 국가, 배송 정보, landed cost 총액 등이 포함됩니다. 가능한 모든 필드는 GraphQL API 참조에 나열되어 있습니다.

쿼리

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

요청 보내기

이제 요청을 작성하고 구성했으므로, Zonos API에 POST 요청을 보낼 수 있습니다. 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
          }
        ]
      }
    }
  ]
}

이 페이지가 도움이 되었습니까?


질문 있으세요?

문의하세요.

Zonos을 보세요

정책 및 계약
이 페이지에서: