엔드포인트
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
HTTPS 요청
필드 | 비고 |
---|---|
HTTP 메서드 | POST |
엔드포인트 URL | https://api.iglobalstores.com/v1/updateMerchantOrderId |
프로토콜 | HTTPS |
메시지 형식 | JSON |
수락 HTTP 헤더 | Accept: application/json |
Content-Type HTTP 헤더 | Content-Type: application/json |
요청 본문의 JSON 키/값 쌍
예시
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"merchantOrderId": "12-34567"
}
요청 JSON 정의
필드 | 비고 |
---|---|
merchantOrderId 필수 | 이 매개변수는 귀하의 상점 내부 주문 ID를 Zonos 시스템의 주문에 전달하는 데 사용됩니다. 이는 더 나은 조정, 커뮤니케이션 및 감사에 권장됩니다.string |
orderId 필수 | Zonos 주문 ID - 귀하의 상점 ID와 하이픈 없이 전달할 수 있습니다 (예: 123-45678 또는 45678). 주의: 주문 완료 및 결제 후, 고객은 귀하의 도메인에 호스팅된 주문 완료 / 감사 페이지로 리디렉션됩니다. URL에는 이 값을 포함하는 쿼리 문자열 매개변수 “orderId”가 포함됩니다.integer / string |
secret 필수 | Zonos에서 제공하는 API 비밀 GUID.string |
store 필수 | Zonos에서 제공하는 상점 IDinteger |
HTTPS 응답
예시 성공 응답
1
2
3
{
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
}
예제 오류 응답
1
2
3
{
"error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}
HTTP 오류 응답
오류 코드 | 정의 |
---|---|
406 - 허용되지 않음 | HTML 엔티티. HTTP “Accept” 헤더가 유효하지 않습니다. |
415 - 지원되지 않는 미디어 유형 | HTML 엔티티. HTTP “Content-Type” 헤더가 유효하지 않습니다. |
200 | “error”:”입력을 파싱할 수 없습니다” |
200 | “error”:”Parameter orderId는 processUpdateMerchantOrderId를 처리하는 데 필요합니다” |
200 | “error”:”Parameter merchantOrderId는 updateMerchantOrderId를 업데이트하는 데 필요합니다.” |
200 | “error”:”orderId: 999-99999는 유효한 orderId가 아닙니다” |
200 | “error”:”orderId: 999-99999에 대한 updateMerchantOrderId를 업데이트할 수 없습니다” |
200 | “error”:”상인 주문 ID를 업데이트할 수 없습니다.” |
200 | “error”:”유효하지 않은 보안 자격 증명” |
응답 JSON 정의
메시지 | 정의 |
---|---|
error | 이 매개변수는 오류가 발생했을 때만 응답에 포함되며, 원인에 대한 설명을 포함합니다.string |
success | 이 매개변수는 업데이트 요약을 포함합니다.string |
주문 번호 업데이트
주문 번호를 업데이트하는 엔드포인트가 어떻게 작동하는지 알아보세요.
updateMerchantOrderId
엔드포인트는 더 나은 조정, 커뮤니케이션 및 감사 작업을 위해 귀하의 상점 주문 ID로 Zonos 시스템에서 주문을 업데이트하는 데 사용됩니다.