DOCS

Order numbers

/
Checkout•
홈API 참조 Checkout REST API 주문 번호

주문 번호

주문 번호 엔드포인트가 작동하는 방식을 알아보세요.

orderNumbers 엔드포인트는 Zonos Checkout를 통해 완료된 주문 번호 목록을 안전하게 검색하는 데 사용됩니다. 일반적으로 모든 주문이 특정 날짜 또는 orderID로 가져왔는지 확인하고 날짜 범위 내의 주문을 확인하기 위해 주문 조정에 사용됩니다.

엔드포인트 

POST | https://api.iglobalstores.com/v1/orderNumbers

HTTPS 요청

필드비고
HTTP 메서드POST
엔드포인트https://api.iglobalstores.com/v1/orderNumbers
프로토콜HTTPS
메시지 형식JSON
Accept HTTP 헤더Accept: application/json
Content-Type HTTP 헤더Content-Type: application/json

요청 본문의 JSON 키/값

메시지 형식: JSON

예제 요청: sinceOrderId

1
2
3
4
5
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "sinceOrderId": "999-99999"
}

예시 요청: sinceDate

1
2
3
4
5
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "sinceDate": "20150101"
}

예시 요청: sinceDate, throughDate

1
2
3
4
5
6
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "sinceDate": "20150101",
  "throughDate": "20150601"
}

예시 요청: missingMerchantOrderId

1
2
3
4
5
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "missingMerchantOrderId": true
}

예제 요청: 상태

1
2
3
4
5
6
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "sinceDate": "20150101",
  "statuses": true
}

요청 JSON 정의

필드비고
missingMerchantOrderId 선택 사항, 다른 매개변수 옵션을 전달하는 경우이 매개변수는 지난 2주 이내에 merchantOrderId가 누락된 주문 집합을 쿼리하는 데 사용됩니다. merchantOrderId가 updateMerchantOrderID API 엔드포인트를 통해 제출되면, 주문은 더 이상 이 쿼리에 표시되지 않습니다.boolean: true/false
secret 필수Zonos에서 제공하는 API 비밀 GUID입니다. string
sinceDate 선택 사항, sinceOrderId 매개변수를 전달하는 경우이 매개변수는 특정 날짜 이후의 주문 집합을 쿼리하는 데 사용됩니다.sinceDate와 sinceOrderId는 동시에 전송될 수 없습니다.string - 날짜 UTC/GMT; 형식: yyyymmdd
sinceOrderId 선택 사항, sinceDate / throughDate 매개변수를 전달하는 경우Zonos 주문 ID로, 상점 ID와 하이픈 없이 또는 함께 전달할 수 있습니다(예: 123-45678 또는 45678). 참고: 이 매개변수는 특정 Zonos 주문 이후의 주문 집합을 쿼리하는 데 사용됩니다. sinceDate와 sinceOrderId는 동시에 전송될 수 없습니다.integer / string
statuses 선택 사항이 매개변수는 현재 주문 상태와 merchantOrderId를 응답에 포함하는 데 사용됩니다. 요청에 존재하는 경우, 값에 관계없이 상태를 포함합니다.boolean: true
store 필수Zonos에서 제공하는 상점 ID입니다.integer
throughDate 선택 사항이 매개변수는 특정 날짜 범위 사이의 주문 집합을 쿼리하는 데 사용됩니다. sinceDate 매개변수와 함께 전달해야 합니다.string - 날짜 UTC/GMT; 형식: yyyymmdd

HTTPS 응답

메시지 형식: JSON

예제 성공 응답

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
  "totalCount": 6,
  "orderCount": 5,
  "testOrderCount": 1,
  "orders": [
    {
      "testOrder": false,
      "id": "999-99991",
      "timestamp": "2015-01-01 00:33:14.0"
    },
    {
      "testOrder": true,
      "id": "999-99992",
      "timestamp": "2015-01-01 05:12:46.0"
    },
    {
      "testOrder": false,
      "id": "999-99993",
      "timestamp": "2015-01-01 14:50:54.0"
    },
    {
      "testOrder": false,
      "id": "999-99994",
      "timestamp": "2015-01-02 20:14:01.0"
    },
    {
      "testOrder": false,
      "id": "999-99995",
      "timestamp": "2015-01-02 20:57:47.0"
    },
    {
      "testOrder": false,
      "id": "999-99996",
      "timestamp": "2015-01-02 22:11:40.0"
    }
  ]
}

예제 성공 응답 '상태' 매개변수 포함

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
  "totalCount": 2,
  "orderCount": 1,
  "testOrderCount": 1,
  "orders": [
    {
      "testOrder": false,
      "id": "999-99991",
      "timestamp": "2015-01-01 00:33:14.0",
      "merchantOrderId": null,
      "orderStatus": "IGLOBAL_FRAUD_REVIEW",
      "orderStatusDate": 1420097594000,
      "orderStatusDateString": "2015-01-01 14:16:17.0"
    },
    {
      "testOrder": true,
      "id": "999-99992",
      "timestamp": "2015-01-01 05:12:46.0",
      "merchantOrderId": "abc123",
      "orderStatus": "IGLOBAL_ORDER_IN_PROCESS",
      "orderStatusDate": 1420097594000,
      "orderStatusDateString": "2015-01-01 14:16:17.0"
    }
  ]
}

예제 오류 응답

1
2
3
{
  "error": "Couldn't find order for sinceOrderId: 999999"
}

HTTP 오류 응답

오류의미
406 - 허용되지 않음HTML 엔티티. HTTP “Accept” 헤더가 유효하지 않습니다.
415 - 지원되지 않는 미디어 유형HTML 엔티티. HTTP “Content-Type” 헤더가 유효하지 않습니다.
200“error”:”입력을 구문 분석할 수 없습니다”
200“error”:”orderId: 999-99999는 유효한 orderId가 아닙니다”
200“error”:”매개변수 orderId 또는 referenceId가 필요합니다.”
200“error”:”매개변수 orderId와 referenceId를 모두 지정할 수 없습니다.”
200“error”:”주문 세부정보를 처리할 수 없습니다.”
200“error”:”유효하지 않은 보안 자격 증명”

응답 JSON 정의

필드비고
error이 매개변수는 오류가 발생했을 때만 응답에 포함되며 원인의 설명을 포함합니다.string
orderCount검색된 활성 주문의 총 수.integer
order.testOrderCount검색된 테스트 주문의 총 수.integer
orders주문 맵의 목록입니다.string
orders[index].id상점 ID와 대시를 포함한 전체 Zonos 주문 ID입니다.string
orders[index].merchantOrderIdupdateMerchantOrderId API 서비스 엔드포인트를 통해 주문과 연결된 MerchantOrderId입니다.string
orders[index].orderStatus가능한 값에 대한 현재 주문 상태입니다.string
orders[index].orderStatusDate상태가 마지막으로 업데이트된 시점을 나타내는 epoch입니다.integer
orders[index].orderStatusDateString상태가 마지막으로 업데이트된 시점을 UTC/GMT로 나타내는 타임스탬프입니다.timestamp
orders[index].testOrder주문이 “테스트 주문”인지 “실제 주문”인지를 나타냅니다.boolean
orders[index].timestamp주문이 UTC/GMT로 언제 발생했는지를 나타내는 타임스탬프입니다.timestamp
totalCount검색된 활성 및 테스트 주문의 총 수입니다.integer

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

질문 있으세요?

문의하세요.

Zonos을 보세요

정책 및 계약
© 2024 Zonoszonos.com
이 페이지에서: