|
Description
|
| [POST] https://sa2.esmplus.com/efm/v1/api/service/GetOuterOrderList |
|
등록한 외부주문 정보를 조회합니다.
|
Request Description
| 항목 | 항목명 | 필수여부 | Type | Description |
| SiteId | 사이트코드 | Y | Int | 아래 url 내 사이트 코드 참조 https://etapi.gmarket.com/97 |
| SearchType | 외부주문검색조건 | Y | string | OUTER_CART_NO : 외부장바구니번호 OUTER_ORDER_NO : 외부주문번호 SMILE_ORDER_NO : 외부스마일주문번호 ORDER_DATE : 주문등록일날짜로조회 WAREHOUSE_REQ_DATE : 출고요청일날짜로조회 WAREHOUSE_OUT_DATE : 발송일날짜로조회 CANCEL_DATE : 취소요청날짜로조회 |
| SearchString | 주문상세검색 | string | 검색조건 > OUTER_CART_NO / OUTER_ORDER_NO / SMILE_ORDER_NO 선택 시 필수 이 때, 날짜검색조건 무시 |
|
| StartDate | 조회시작일자 | Date-Time | 검색조건 > ORDER_DATE / WAREHOUSE_REQ_DATE / WAREHOUSE_OUT_DATE 일 경우 필수 | |
| EndDate | 조회종료일자 | Date-Time | 검색조건 > ORDER_DATE / WAREHOUSE_REQ_DATE / WAREHOUSE_OUT_DATE 일 경우 필수 | |
| OrderStatus | 주문처리상태 | Y | Int | 0: 전체 1: 발송요청대기 2: 발송요청중 3. 발송요청완료 4: 발송요청실패 5: 판매자출고취소주문 |
| WarehouseStatusCode | 출고진행상태 | Y | string | ALL : 전체 OR : 출고요청 OA : 할당 OP : Picking OI : 검수 OS : 출고완료 OC : 취소 |
| pageIndex | 페이지번호 | Y | Int | 정수: Page 구분 |
| pageSize | 페이지사이즈 | Y | Int | 1페이지에 출력하려는 리스트 Max값 1000까지 지원 가능 |
JSON
{
"SiteId": 0,
"SearchType": "string",
"SearchString": "string",
"StartDate": "2020-01-17T06:45:41.420Z",
"EndDate": "2020-01-17T06:45:41.420Z",
"OrderStatus": 0,
"WarehouseStatusCode": "string",
"PageIndex": 0,
"PageSize": 0
}
Response Description
| 항목 | 항목명 | Type | Description |
| ResultCode | 결과코드 | int | 성공: 0 실패 :Error Massage 참고 |
| Message | 메시지 | string | |
| Data > TotalCount | 전체대상건수 | Int | 조회조건 범위 전체 건수 |
| Data > PageIndex | Response PageNo | Int | 조회시 입력한 PageNo |
| Data > PageSize | Response PageSize | Int | 조회시 입력한 PageSize |
| Data > Data > OrderDetail > SkuId | []Sku번호 | Int | 지마켓에서 채번한 SKU번호 내려감 |
| Data > Data > OrderDetail > OwQty | []SKU총출고수량 | Int | 판매자가 등록한 SKU총출고수량 |
| Data > Data > OrderDetail > BoxSize | []출고된 박스사이즈 | string | 출고된 박스사이즈 내려감 |
| Data > Data > OrderDetail > DeliveryCompCode | []택배사코드 | string | 택배사별 5자리 코드 아래 url 내 코드 참조 https://etapi.gmarket.com/142 |
| Data > Data > OrderDetail > InvoiceNo | []출고송장번호 | string | 해당 SKU 출고송장번호 내려감 |
| Data > Data > OrderDetail > InvoiceIssueDate | []출고송장발급일시 | Date-Time | 해당 SKU 출고송장번호 발급일시 내려감 |
| Data > Data > OrderDetail > SKUManageCode | []SKU관리코드 | string | 판매자가 입력한 SKU관리코드 내려감 |
| Data > Data > OrderDetail > StockNo | []제품StockNo | string | 판매자가 입력한 제품StockNo 내려감 |
| Data > SmileOrderNo | 스마일주문번호 | Int | 판매자가 출고요청한 스마일주문번호 내려감 |
| Data > OuterOrderNo | 외부주문번호 | string | 판매자가 출고요청한 스마일주문번호 내려감 |
| Data > OuterCartNo | 외부장바구니번호 | Int | 판매자가 출고요청한 스마일장바구니번호 내려감 |
| Data > SiteId | 사이트코드 | Int | 해당 스마일주문번호의 사이트코드 내려감 |
| Data > SiteUserInput | 사이트직접입력 | string | 판매자가 사이트직접입력한 텍스트 내려감 |
| Data > BundleType | 합포장여부 | string | 센터에서 검수한 해당 SKU 합포장 가능여부 내려감 B : 합포장가능 I : 합포장불가능 |
| Data > OuterGoodsNo | 외부상품번호 | string | 판매자가 입력한 외부상품번호 내려감 |
| Data > OrderQty | 외부주문수량 | Int | 판매자가 입력한 외부채널 주문수량 내려감 |
| Data > OnedayDeliveryYn | 당일출고여부 | string | 당일 출고되었는지여부 Y : 당일출고 N : 당일출고 아님 |
| Data > GoodsName | 상품명 | string | 판매자가 입력한 상품명 내려감 |
| Data > RcverInfoNa | 수령인명 | string | 판매자가 입력한 수령인명 내려감 |
| Data > RcverInfoCp | 수령인휴대폰번호 | string | 판매자가 입력한 수령인휴대폰번호 내려감 |
| Data > RcverInfoHt | 수령인일반전화번호 | string | 판매자가 입력한 수령인일반전화번호 내려감 |
| Data > ZipCode | 수령인우편번호 | string | 판매자가 입력한 수령인우편번호 내려감 |
| Data > RcverInfoAd1 | 수령인기본주소 | string | 판매자가 입력한 수령인기본주소 내려감 |
| Data > RcverInfoAd2 | 수령인상세주소 | string | 판매자가 입력한 수령인상세주소 내려감 |
| Data > Memo | 수령인배송메모 | string | 판매자가 입력한 수령인배송메모 내려감 |
| Data > OptValue | 옵션명 | string | 판매자가 입력한 옵션명 내려감 |
| Data > OrderStatus | 주문처리상태 | Int | 1 : 발송요청대기 2 : 발송요청중 3 : 발송요청완료 4 : 발송요청실패 5: 판매자출고취소주문 |
| Data > EfmSeqNo | 내부주문관리번호 | Int | 내부주문관리번호 내려감 |
| Data > EfmCartSeqNo | 내부장바구니관리번호 | Int | 내부장바구니관리번호 내려감 |
| Data > WarehouseStatusCode | 출고진행상태 | string | OR : 출고요청 OA : 할당 OP : Picking OI : 검수 OS : 출고완료 OC : 취소 |
| Data > FailCode | 출고실패코드 | string | 출고실패코드내려감 실패코드 발생된 주문을 재출고요청 하려면 주문 신규생성 후 출고처리 해야함 01 : 재고부족_SKU상태이상 02 : 재고부족_장바구니 03 : 멀티창고주문 04 : 시스템오류 05 : 기타 |
| Data > FailMessage | 출고실패사유 | string | 출고실패코드별 상세사유 내려감 01 : SKU 상태 및 재고 확인이 필요합니다 02 : 장바구니내 재고가 부족한 SKU가 존재합니다 03 : 창고구분 값이 다른 SKU가 존재합니다 04 : 연동 처리에 실패하였습니다 05 : 발송요청 처리를 실패하였습니다 |
| Data > DeliveryReqDate | 출고요청일시 | Date-Time | 판매자가 출고요청처리한 일시 내려감 |
| Data > BoxCnt | BOX수량/운송장수량 | Int | 합포일 경우 1로 Return 분리포일경우 분리포된 전체 운송장 수량 내려감 |
| Data > DividePackingYn | 출고분리포여부 | Int | Y : 분리포 N : 합포 |
| Data > OrderDate | 주문일시 | Date-Time | 판매자가 등록한 주문일시 내려감 |
| Data > WarehouseReqDate | 출고요청일시 | Date-Time | 출고요청일시 내려감 |
| Data > WarehouseOutDate | 출고일시 | Date-Time | 출고일시 내려감 |
| Data > OrderCancelDate | 주문취소일시 | Date-Time | 주문취소일시 내려감 |
| Data > DeliveryDueDate | 외부주문배송기한일자 | Date | 외부주문배송기한일자 내려감 YYYY-MM-DD형식 |
| Data > DeliveryDueTime | 외부주문배송기한시간 | TimeSpan | 외부주문배송기한시간 내려감 hh:mm:ss형식 |
| Data > AdultYn | 청소년구매불가 성인상품여부 | string | Y: 청소년구매불가성인상품 N: 성인상품 아님 |
| Data > InvoiceGoodsName | 송장출력용 상품명 | string | 판매자가 입력한 송장출력용 상품명 내려감 |
JSON_Success
{
"ResultCode": 0,
"Message": "string",
"Data": {
"TotalCount": 0,
"PageSize": 0,
"PageIndex": 0,
"Data": [
{
"OrderDetail": [
{
"SkuId": 0,
"OwQty": 0,
"BoxSize": "string",
"DeliveryCompCode": "string",
"InvoiceNo": "string",
"InvoiceIssueDate": "2020-02-03T06:58:22.529Z"
"ItemManageCode": "string",
"StockNo": "string"
}
],
"SmileOrderNo": 0,
"OuterOrderNo": "string",
"SiteId": 0,
"BundleType": "string",
"OuterCartNo": 0,
"OuterGoodsNo": "string",
"OrderQty": 0,
"OnedayDeliveryYn": "string",
"GoodsName": "string",
"OptValue": "string",
"RcverInfoNa": "string",
"RcverInfoCp": "string",
"RcverInfoHt": "string",
"RcverInfoAd1": "string",
"RcverInfoAd2": "string",
"ZipCode": "string",
"Memo": "string",
"OrderStatus": "string",
"EfmSeqNo": 0,
"EfmCartSeqNo": 0,
"WarehouseStatusCode": "string",
"FailMessage": "string",
"FailCode": "string",
"DeliveryReqDate": "2020-02-03T06:58:22.529Z",
"BoxCnt": 0,
"DividePackingYn": "string",
"OrderDate": "2020-02-03T06:58:22.529Z",
"WarehouseReqDate": "2020-02-03T06:58:22.529Z",
"WarehouseOutDate": "2020-02-03T06:58:22.529Z",
"OrderCancelDate": "2020-02-03T06:58:22.529Z",
"DeliveryDueDate": "2020-02-03T06:58:22.529Z",
"DeliveryDueTime": "string",
"SiteUserInput": "string",
"AdultYn": "string"
"InvoiceGoodsName": "string"
}
]
}
}Sample Code_Success
{
"ResultCode": 0,
"Message": "success",
"Data": {
"TotalCount": 2,
"PageSize": 100,
"PageIndex": 1,
"Data": [
{
"OrderDetail": [
{
"SkuId": 41935,
"OwQty": 3,
"BoxSize": null,
"DeliveryCompCode": null,
"InvoiceNo": null,
"InvoiceIssueDate": null
"ItemManageCode": null,
"StockNo": null
}
],
"SmileOrderNo": 408958,
"OuterOrderNo": "1821013015",
"SiteId": 2,
"BundleType": "B",
"OuterCartNo": 324130133,
"OuterGoodsNo": "14",
"OrderQty": 1,
"OnedayDeliveryYn": null,
"GoodsName": "상품명",
"OptValue": "1",
"RcverInfoNa": "고객명",
"RcverInfoCp": "010-2222-2226",
"RcverInfoHt": "",
"RcverInfoAd1": "서울특별시 강남구 테헤란로 152 강남파이낸스센터",
"RcverInfoAd2": "35층",
"ZipCode": "440-844",
"Memo": "",
"OrderStatus": "3",
"EfmSeqNo": 3266438,
"EfmCartSeqNo": 449918,
"WarehouseStatusCode": "OR",
"FailMessage": null,
"FailCode": null,
"DeliveryReqDate": "2020-01-30T09:57:00+09:00",
"BoxCnt": null,
"DividePackingYn": null,
"OrderDate": "2020-01-30T09:56:57.14+09:00",
"WarehouseReqDate": "2020-01-30T09:57:08.093+09:00",
"WarehouseOutDate": null,
"OrderCancelDate": null,
"DeliveryDueDate": null,
"DeliveryDueTime": null,
"SiteUserInput": null,
"AdultYn": null,
"InvoiceGoodsName": null
},
{
"OrderDetail": [
{
"SkuId": 41941,
"OwQty": 10001,
"WarehouseNo": 217406130,
"BoxSize": null,
"DeliveryCompCode": null,
"InvoiceNo": null,
"InvoiceIssueDate": null
"ItemManageCode": null,
"StockNo": null
},
{
"SkuId": 41935,
"OwQty": 10,
"WarehouseNo": 217406130,
"BoxSize": null,
"DeliveryCompCode": null,
"InvoiceNo": null,
"InvoiceIssueDate": null
"ItemManageCode": null,
"StockNo": null
}
],
"SmileOrderNo": 408957,
"OuterOrderNo": "1821013014",
"SiteId": 2,
"BundleType": "B",
"OuterCartNo": 324130132,
"OuterGoodsNo": "14",
"OrderQty": 1,
"OnedayDeliveryYn": null,
"GoodsName": "상품명",
"OptValue": "1",
"RcverInfoNa": "고객명",
"RcverInfoCp": "010-2222-2226",
"RcverInfoHt": "",
"RcverInfoAd1": "서울특별시 강남구 테헤란로 152 강남파이낸스센터",
"RcverInfoAd2": "35층",
"ZipCode": "440-844",
"Memo": "",
"OrderStatus": "3",
"EfmSeqNo": 3266437,
"EfmCartSeqNo": 449917,
"WarehouseStatusCode": "OR",
"FailMessage": null,
"FailCode": null,
"DeliveryReqDate": "2020-01-30T09:57:00+09:00",
"BoxCnt": null,
"DividePackingYn": null,
"OrderDate": "2020-01-30T09:56:57.123+09:00",
"WarehouseReqDate": "2020-01-30T09:57:07.873+09:00",
"WarehouseOutDate": null,
"OrderCancelDate": null,
"DeliveryDueDate": null,
"DeliveryDueTime": null,
"SiteUserInput": null,
"AdultYn": null,
"InvoiceGoodsName": null
}
]
}
}Error Code
| 결과코드 | 메시지 | 원인 |
| 1400 | 조회조건 입력 시 외부장바구니번호(OUTER_CART_NO), 외부주문번호(OUTER_ORDER_NO), 스마일주문번호(SMILE_ORDER_NO), 주문일자(ORDER_DATE), 출고요청일자(WAREHOUSE_REQ_DATE), 출고일자(WAREHOUSE_OUT_DATE), 출고취소일자(CANCEL_DATE)만 유효합니다. | SearchType > 유효하지 않은 값 입력 시 |
| 1400 | 조회일자를 확인해주세요. 시작일자가 유효하지 않습니다. | StartDate > SearchType이 일자(DATE)일 때 시작일자 미입력 시 |
| 1400 | 조회일자를 확인해주세요. 미래일자로 설정되어 있습니다. : {입력값} | StartDate > 미래일자 입력 시 |
| 1400 | 조회일자를 확인해주세요. 종료일자는 시작일자보다 과거일 수 없습니다. : {입력값} | StartDate > 시작일이 종료일보다 과거일 경우 |
| 1400 | 조회일자를 확인해주세요. 종료일자가 유효하지 않습니다. | EndDate > SearchType이 일자(DATE)일 때 종료일자 미입력 시 |
| 1400 | 검색어가 필수인 검색조건입니다. 검색어를 입력해주세요. | SearchType > 검색어가 필요한 검색조건(외부장바구니번호, 외부주문번호, 스마일주문번호 등)일 때 검색어 미입력 시 |
| 1400 | 숫자 검색어만 입력 가능한 검색조건입니다. : {입력값} | SearchString > SearchType이 스마일주문번호일 때 문자열 입력 시 |
| 1400 | 유효하지 않은 주문처리상태 입니다. | OrderStatus > 유효하지 않은 값 입력 시 |
| 1400 | PageIndex는 1 이상이어야 합니다. | PageIndex > 미입력 or 0 or 음수 입력할 경우 |
| 1400 | PageSize는 1 이상이어야 합니다. | PageSize > 미입력 or 0 or 음수 입력할 경우 |
| 1400 | PageSize는 최대 1000까지 입력할 수 있습니다. | PageSize > 제한값 초과하여 입력했을 경우 |
'스마일배송 API > 외부주문' 카테고리의 다른 글
| 외부주문 등록수정 API (0) | 2022.11.03 |
|---|---|
| 외부주문 출고요청 API (0) | 2022.11.03 |
| 외부주문 출고취소 API (0) | 2022.11.03 |
| 외부주문 삭제 API (0) | 2022.11.03 |
| 반품/교환입고 등록 API (0) | 2022.11.03 |