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 key/value
Message format: JSON
1{
2"store":"999",
3"secret":"f5bde245-f55e-414d-b722-80b25161c12c",
4"sinceOrderId":"999-99999"
5}
요청 JSON 정의
필드↕
참고↕
missingMerchantOrderId OPTIONAL, if passing another parameter option
지난 2주 이내 merchantOrderId가 누락된 주문 집합을 쿼리하는 데 사용됩니다. updateMerchantOrderID API 엔드포인트를 통해 merchantOrderId가 제출되면 해당 주문은 더 이상 이 쿼리에 표시되지 않습니다.boolean: true/false
secret REQUIRED
Zonos에서 제공한 API secret GUID. string
sinceDate OPTIONAL, if passing sinceOrderId parameter.
특정 날짜 이후의 주문 집합을 쿼리하는 데 사용됩니다. sinceDate와 sinceOrderId는 동시에 전송할 수 없습니다.string - date UTC/GMT; format: yyyymmdd
sinceOrderId OPTIONAL, if passing sinceDate / throughDate parameter
Zonos 주문 ID는 매장 ID와 하이픈을 포함하거나 제외하고 전달할 수 있습니다(예: 123-45678 또는 45678). 참고: 이 매개변수는 특정 Zonos 주문 이후의 주문 집합을 쿼리하는 데 사용됩니다. sinceDate와 sinceOrderId는 동시에 전송할 수 없습니다.integer / string
statuses OPTIONAL
응답에 현재 주문 상태와 merchantOrderId를 포함하는 데 사용됩니다. 요청에 포함되어 있으면 값과 관계없이 상태가 포함됩니다.boolean: true
store REQUIRED
Zonos에서 제공한 Store ID.integer
throughDate OPTIONAL
특정 날짜 범위의 주문 집합을 쿼리하는 데 사용됩니다. sinceDate 매개변수와 함께 전달해야 합니다.string - date UTC/GMT; format: yyyymmdd
HTTPS 응답
Message format: JSON
1{
2"totalCount":6,
3"orderCount":5,
4"testOrderCount":1,
5"orders":[
6{
7"testOrder":false,
8"id":"999-99991",
9"timestamp":"2015-01-01 00:33:14.0"
10},
11{
12"testOrder":true,
13"id":"999-99992",
14"timestamp":"2015-01-01 05:12:46.0"
15},
16{
17"testOrder":false,
18"id":"999-99993",
19"timestamp":"2015-01-01 14:50:54.0"
20},
21{
22"testOrder":false,
23"id":"999-99994",
24"timestamp":"2015-01-02 20:14:01.0"
25},
26{
27"testOrder":false,
28"id":"999-99995",
29"timestamp":"2015-01-02 20:57:47.0"
30},
31{
32"testOrder":false,
33"id":"999-99996",
34"timestamp":"2015-01-02 22:11:40.0"
35}
36]
37}
오류 HTTP 응답
오류↕
의미↕
406 - Not Acceptable
HTML Entity. HTTP "Accept" 헤더가 유효하지 않습니다.
415 - Unsupported media type
HTML Entity. HTTP "Content-Type" 헤더가 유효하지 않습니다.
200
"error":"could not parse input"
200
"error":"orderId: 999-99999 is not a valid orderId"
200
"error":"Parameter orderId or referenceId is required."
200
"error":"Cannot specify both Parameters orderId and referenceId."
200
"error":"Could not process order details."
200
"error":"Invalid security credentials"
응답 JSON 정의
필드↕
참고↕
error
오류가 발생한 경우에만 응답에 포함되며 원인에 대한 설명이 포함됩니다.string
orderCount
검색된 실제 주문의 총 개수입니다.integer
order.testOrderCount
검색된 테스트 주문의 총 개수입니다.integer
orders
주문 맵 목록입니다.string
orders[index].id
매장 ID와 대시를 포함한 전체 Zonos Order Id입니다.string
orders[index].merchantOrderId
updateMerchantOrderId API 서비스 엔드포인트를 통해 주문과 연결된 MerchantOrderId.string
orders[index].orderStatus
가능한 값에 대한 현재 주문 상태입니다.string
orders[index].orderStatusDate
상태가 마지막으로 업데이트된 시점을 나타내는 epoch입니다.integer
orders[index].orderStatusDateString
상태가 마지막으로 UTC/GMT에서 업데이트된 시점을 나타내는 타임스탬프입니다.timestamp
주문 번호
주문 번호
주문 번호 엔드포인트의 작동 방식을 알아보세요.orderNumbers엔드포인트는 Zonos Checkout을 통해 완료된 주문 번호 목록을 안전하게 검색하는 데 사용됩니다. 일반적으로 특정 날짜 또는 orderID 기준으로 모든 주문이 가져와졌는지, 또는 날짜 범위 내 주문이 가져와졌는지 확인하기 위한 주문 조정에 사용됩니다.엔드포인트
POST |
https://api.iglobalstores.com/v1/orderNumbersHTTPS 요청
https://api.iglobalstores.com/v1/orderNumbers요청 본문의 JSON key/value
Message format: JSON
{"store": "999","secret": "f5bde245-f55e-414d-b722-80b25161c12c","sinceOrderId": "999-99999"}요청 JSON 정의
missingMerchantOrderIdOPTIONAL, if passing another parameter optionmerchantOrderId가 누락된 주문 집합을 쿼리하는 데 사용됩니다.updateMerchantOrderIDAPI 엔드포인트를 통해merchantOrderId가 제출되면 해당 주문은 더 이상 이 쿼리에 표시되지 않습니다.boolean: true/falsesecretREQUIREDstringsinceDateOPTIONAL, if passingsinceOrderIdparameter.sinceDate와sinceOrderId는 동시에 전송할 수 없습니다.string- date UTC/GMT; format:yyyymmddsinceOrderIdOPTIONAL, if passingsinceDate/throughDateparametersinceDate와sinceOrderId는 동시에 전송할 수 없습니다.integer / stringstatusesOPTIONALmerchantOrderId를 포함하는 데 사용됩니다. 요청에 포함되어 있으면 값과 관계없이 상태가 포함됩니다.boolean: truestoreREQUIREDintegerthroughDateOPTIONALsinceDate매개변수와 함께 전달해야 합니다.string- date UTC/GMT; format:yyyymmddHTTPS 응답
Message format: JSON
{"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"}]}오류 HTTP 응답
응답 JSON 정의
errorstringorderCountintegerorder.testOrderCountintegerordersstringorders[index].idstringorders[index].merchantOrderIdupdateMerchantOrderIdAPI 서비스 엔드포인트를 통해 주문과 연결된MerchantOrderId.stringorders[index].orderStatusstringorders[index].orderStatusDateintegerorders[index].orderStatusDateStringtimestamporders[index].testOrderbooleanorders[index].timestamptimestamptotalCountinteger이 페이지가 도움이 되었나요?