[안내] 주문관리시스템 오픈에 따른 Open API 변경 사전 안내 : 애드리빙 공지사항

알림

공지[안내] 주문관리시스템 오픈에 따른 Open API 변경 사전 안내

2024-04-29

안녕하세요, 애드리빙입니다.
아임웹 주문관리시스템 오픈에 따른 Open API 변경 안내드립니다.

변경 적용 일자 : 2024년 4월 24일 (수)
변경되는 API 목록
- 주문 조회, 주문 처리, 주문 운송장 입력, 주문 취소 처리, 주문 반품 처리, 주문 교환 처리 API
- 상점 정보 조회 API (추가)

아임웹의 신규 주문관리 시스템 (주문관리 v2)의 오픈 예정으로 인해

제공 중인 Open API에 변경이 있을 예정입니다.

✅ 기존 API 호출에는 문제가 없습니다.

단 귀사의 고객사가 아임웹 신규 주문관리 (주문관리 V2)를 사용할 경우, 기존의 Endpoit에 새로운 파라미터를 사용하실 수 있습니다.
신규 주문관리 V2를 사용하는 고객사를 보유하신 경우, 아래 파라미터를 가능한 빨리 대응해 주세요.
- 주문 조회 API order_version
- 그 외 API prod_order_no_list
변경사항 적용 일자는 2024년 4월 24일 입니다.

변경되는 API 목록

주문 조회 API
주문 처리 API
주문 운송장 입력 API
주문 취소 처리 API
주문 반품 처리 API
주문 교환 처리 API
상점 정보 조회 API (추가)

적용 일정 및 안내

✔️ 적용 일자

2024년 4월 24일 (예정)

✔️ 작업 영향도

본 변경사항 적용 작업은 기존 Open API 서비스에 영향을 주지 않습니다.
Endpoint는 변경이 없습니다.

1. 주문 조회 API

[GET] api.imweb.me/shop/orders

[GET] api.imweb.me/v2/shop/orders

API 스펙은 유지됩니다.
특정 주문관리 시스템의 주문 조회를 원할 시 아래 파라미터를 추가해 주세요.
입력하지 않는 경우 현재 사용 중인 주문관리 시스템의 주문이 조회됩니다.

order_version QUERY PARAMETERS 추가

예시
- api.imweb.me/shop/orders?order_version=v1
- api.imweb.me/shop/orders?order_version=v2
- api.imweb.me/v2/shop/orders?order_version=v1
- api.imweb.me/v2/shop/orders?order_version=v2

2. 주문 처리 API

[PATCH] api.imweb.me/shop/orders/{주문번호}/{상태}

[PATCH] api.imweb.me/v2/shop/orders/{주문번호}/{상태}

API 스펙은 유지됩니다.
새로운 주문관리 시스템의 주문 상태 변경 시 처리할 품목 주문 번호의 리스트를 입력해 주세요.
입력하지 않는 경우 모든 품목 주문이 처리됩니다.

prd_order_no_list REQUEST BODY 추가 (신규 주문관리 시스템 전용)

3. 운송장 입력 API

[PATCH] api.imweb.me/v2/shop/orders/{주문번호}/invoice

API 스펙은 유지됩니다.
새로운 주문관리 시스템의 주문 운송장 입력 시 처리할 품목 주문 번호의 리스트를 입력해 주세요.
입력하지 않는 경우 모든 품목 주문이 처리됩니다.

prd_order_no_list REQUEST BODY 추가 (신규 주문관리 시스템 전용)

4. 주문 취소/반품/교환 API

[PATCH] api.imweb.me/v2/shop/orders/{주문번호}/cancel/{상태}

[PATCH] api.imweb.me/v2/shop/orders/{주문번호}/return/{상태}

[PATCH] api.imweb.me/v2/shop/orders/{주문번호}/exchange/{상태}

API 스펙은 유지됩니다.
새로운 주문관리 시스템의 클레임 처리 시 처리할 품목 주문 번호의 리스트를 입력해 주세요.
입력하지 않는 경우 모든 품목 주문이 처리됩니다.

prd_order_no_list REQUEST BODY 추가 (신규 주문관리 시스템 전용)

5. 상점 정보 조회 API

[GET] api.imweb.me/shop/store

[GET] api.imweb.me/v2/shop/store

상점 정보 조회 API가 신규 추가되었습니다.
귀사의 고객사가 사용 중인 주문관리 시스템의 버전을 확인할 수 있습니다.

4월 업데이트 소식 [안내] 현금성 결제수단(무통장 결제수단) 변경 정책 사전 안내