상품 목록 조회 API

Description

상품 목록 조회 : [POST] https://sa2.esmplus.com/item/v1/goods/search

등록된 2.0 상품 리스트 조회하는 API 입니다. ESM+ 상품관리에서와 같이 조건별로 등록된 상품을 조회해서 확인하실 수 있습니다. 목록 조회시 분당 최대 30회 까지 호출 가능합니다.

Request Description

항목	항목명	필수여부	Type	Description
goodsNo	[] 마스터번호		int
siteGoodsNo	[] 사이트 상품번호		string
managedCode	[] 판매자 관리코드		string
sellStatus	[] 판매상태		string	11 : 판매 중 21 : 판매 중지 22 : 직권 중지 31 : SKU 품절
siteId	[] 사이트 구분		string	1 : 옥션 2 : 지마켓
siteSellerId	[] 판매자 ID		string
keyword	검색 키워드		string	- 상품명, 브랜드명, 제조사명, 관리코드 검색 가능 - 키워드는 1개씩만 입력 가능
category > site > siteId	사이트 ID		int	1 : 옥션 2 : 지마켓
category > site > siteCatCode	사이트 카테고리 코드		string	- 사이트 카테고리 코드 입력 - 최종 상품 등록e된 리프 카테고리로 입력 - 지마켓은 9자리 카테고리 코드 입력
category > esm	ESM 카테고리 코드		string
registrationDate > from	등록 시작일		string	YYYY-MM-DD 형태로 입력
registrationDate > to	등록 종료일		string	YYYY-MM-DD 형태로 입력
sellEndDate > from	판매종료 시작일		string	YYYY-MM-DD 형태로 입력
sellEndDate > to	판매종료 종료일		string	YYYY-MM-DD 형태로 입력
updatedDate > from	수정 시작일		string	YYYY-MM-DD 형태로 입력
updatedDate > to	수정 종료일		string	YYYY-MM-DD 형태로 입력
is3PL	스마일배송 여부		boolean
isStarDelivery	판매자 스타배송 여부		boolean	판매자 스타배송 상품만 조회 가능 (4월 중순 이후 조회 가능)
isGift	선물하기 여부		boolean	지마켓 경우만 조회 가능
useOrderOption	주문옵션 사용 여부		boolean
useDiscount	판매자할인 사용 여부		boolean
groupNo	[] 그룹번호		int
pageIndex	페이지 인덱스	Y	int
pageSize	페이지 사이즈	Y	int	최대 500 까지만 조회 가능
sortField	정렬 조건		int	0 : 등록일 (미입력시 default) 1 : 판매중지일 2 : 재고 3 : 가격 4 : 마스터번호 5 : 카테고리코드 7 : 그룹번호
sortOrder	정렬 순서		int	0 : 오름차순 (미입력시 default) 1 : 내림차순

JSON
{
    "query": {
      "goodsNo": [
        0
      ],
     "siteId": [
        0
      ],
      "siteGoodsNo": [
        "string"
      ],
      "managedCode": [
        "string"
      ],
      "keyword": "string",
      "sellStatus": [
        "string"
      ],
       "siteSellerId": [
        "string"
      ],
      "category": {
        "site": [
          {
            "siteId": 0,
            "siteCatCode": "string"
          }
        ],
        "esm": "string"
      },
      "registrationDate": {
        "from": "string",
        "to": "string"
      },
      "sellEndDate": {
        "from": "string",
        "to": "string"
      },
      "updatedDate": {
        "from": "string",
        "to": "string"
      },      
      "is3PL": true,
      "isGift": true,
      "useOrderOption": true,
      "useDiscount": true,
      "groupNo": [
         0
       ]
  	},
    "pageIndex": 0,
    "pageSize": 0,
    "sortField": 0,
    "sortOrder": 0
}

조회 샘플
1. 판매중 상품 조회시
{
    "query": {
      "sellStatus": [11]
    },
    "pageIndex": 1,
    "pageSize": 10
}

2. 마스터번호로 조회시
{
    "query": {
      "goodsNo": [2414582618, 2414582613, 2414584618]
    },
    "pageIndex": 1,
    "pageSize": 10
}

3. 전체 조회시
{
  "query": {
    },
  "pageIndex": 1,
  "pageSize": 10
}

4. 지마켓 판매자 ID 기준 조회시
{
    "query": {
     "siteId": [
        2
      ],
       "siteSellerId": [
        "test"
      ]
    },
    "pageIndex": 1,
    "pageSize": 10
}

5. 등록일 기준 조회시
{
    "query": {
     "registrationDate": {
        "from": "2023-07-01",
        "to": "2023-07-15"
       }
    },
    "pageIndex": 1,
    "pageSize": 10
}

 

Response Description

항목	항목명	Type	Description
totalItems	조회 조건 전체 상품수	number
pageIndex	페이지 인덱스	number
pageSize	페이지 사이즈	number
items > no	순번	number
items > goodsNo	마스터번호	string
items > siteGoodsNo > gmkt	지마켓 상품번호	string
items > siteGoodsNo > iac	옥션 상품번호	string
items > managedCode	판매자관리코드	string
items > imgUrl	이미지 url	string	ESM+ 상품관리 내 목록 보기시 나오는 이미지 Url
items > goodsName	상품명	string
items > prmtGoodsNameType	프로모션명 타입	int	0 : 공통, 1 : 사이트별
items > prmtGoodsName > gmkt	지마켓 프로모션명	string
items > prmtGoodsName > iac	옥션 프로모션명	string
items > siteSellerId > gmkt	지마켓 판매자ID	string
items > siteSellerId > iac	옥션 판매자ID	string
items > sellStatus > gmkt	지마켓 판매상태	string	01 : 등록 대기 11 : 판매 중 21 : 판매 중지 22 : 직권 중지 31 : SKU 품절
items > sellStatus > iac	옥션 판매상태	string	01 : 등록 대기 11 : 판매 중 21 : 판매 중지 22 : 직권 중지 31 : SKU 품절
items > price > gmkt	지마켓 판매가	number
items > price > iac	옥션 판매가	number
items > dispEndDate	판매 기간 종료일	string
items > groupNo > gmkt	지마켓 그룹번호	number
items > groupNo > iac	옥션 그룹번호	number
items > sellerDiscount > gmkt > type	지마켓 판매자할인 타입	number	1 : 정액 2 : 정률
items > sellerDiscount > gmkt > discountAmt	지마켓 판매자할인 금액(률)	number
items > sellerDiscount > iac > type	옥션 판매자할인 타입	number	1 : 정액 2 : 정률
items > sellerDiscount > iac > discountAmt	옥션 판매자할인 금액(률)	number
items > stock > gmkt	지마켓 재고수량	number
items > stock > iac	옥션 재고수량	number
items > category > site > gmkt > catCode	지마켓 카테고리코드	string
items > category > site > gmkt > catName	지마켓 카테고리명	string
items > category > site > iac > catCode	옥션 카테고리코드	string
items > category > site > iac > catName	옥션 카테고리명	string
items > category > esm > catCode	ESM 카테고리코드	string
items > category > esm > catName	ESM 카테고리명	string
items > useOption	옵션 사용 여부	boolean
items > useAddonService	추가구성 사용 여부	boolean
items > gift	사은품	string	사은품 텍스트 정보 확인 가능
items > plusOne	덤	string	덤 텍스트 정보 확인 가능
items > brand > id	브랜드 ID	number
items > brand > name	브랜드명	string
items > maker > id	제조사 ID	number
items > maker > name	제조사명	string
items > productBrand > id	상품 브랜드 ID	number
items > productBrand > name	상품 브랜드명	string
items > catalog > epinCode	상품식별코드	number
items > catalog > epinName	상품식별코드명	string
items > catalog > barCode	바코드	string	(조회 정보 없음)
items > isDisplayExclude	노출대기 여부	boolean
items > isGift	선물하기 여부	boolean
items > createdDate	상품 등록일	string
items > updatedDate	상품 수정일	string
items > sellStopDate > gmkt	지마켓 판매중지일	string
items > sellStopDate > iac	옥션 판매중지일	string
items > is3PL	스마일배송 여부	boolean
items > shipping > fee	배송비	number
items > shipping > placeNo	출하지정보	number
items > shipping > placeName	출하지명	string
items > shipping > dispatchPolicyNo	발송정책번호	number
items > shipping > dispatchPolicyName	발송정책명	string
items > shipping > bundleDeliveryTmplId	배송정책번호	number	0 인 경우 상품별 배송비
items > shipping > is3plDeliveryFeeFree	스마일배송 무료배송 여부	boolean
items > isStarDelivery	판매자 스타배송 여부	boolean	(4월 중순 이후 조회 가능)
isEventGoods > gmkt	지마켓 빅스마일데이 참여 여부	boolean
isEventGoods > iac	옥션 빅스마일데이 참여 여부	boolean
isLowestPrice > gmkt	지마켓 최저가 여부	boolean	(추후 제공 예정)
isLowestPrice > iac	옥션 최저가 여부	boolean	(추후 제공 예정)
lowestPrice > gmkt	지마켓 최저가	number	빅스마일데이 참여 기준가
lowestPrice > iac	옥션 최저가	number	빅스마일데이 참여 기준가

JSON_Success

{
    "totalItems": 0,
    "pageIndex": 0,
    "pageSize": 0,
    "items": [
        {
            "no": 0,
            "goodsNo": "string",
            "siteGoodsNo": {
                "gmkt": "string",
                "iac": "string"
            },
            "managedCode": "string",
            "imgUrl": "string",
            "goodsName": "string",
            "prmtGoodsNameType": int,
            "prmtGoodsName": {
                "gmkt": "string",
                "iac": "string"
            },
            "siteSellerId": {
                "gmkt": "string",
                "iac": "string"
            },
            "sellStatus": {
                "gmkt": "string",
                "iac": "string"
            },
            "price": {
                "gmkt": 0,
                "iac": 0
            },
            "dispEndDate": "YYYY-MM-DD hh:mm:ss",
            "groupNo": {
                "gmkt": 0,
                "iac": 0
            },
            "sellerDiscount": {
                "gmkt": {
                    "type": 0,
                    "discountAmt": 0.0
                },
                "iac": {
                    "type": 0,
                    "discountAmt": 0.0
                }
            },
            "stock": {
                "gmkt": 0,
                "iac": 0
            },
            "category": {
                "site": {
                    "gmkt": {
                        "catCode": "string",
                        "catName": "string"
                    },
                    "iac": {
                        "catCode": "string",
                        "catName": "string"
                    }
                },
                "esm": {
                    "catCode": "string",
                    "catName": "string"
                }
            },
            "useOption": boolean,
            "useAddonService": boolean,
            "gift": "",
            "plusOne": "",
            "brand": {
                "id": 0,
                "name": "string"
            },
            "maker": {
                "id": 0,
                "name": "string"
            },
            "productBrand": {
                "id": 0,
                "name": "string"
            },
            "catalog": {
                "epinCode": 0,
                "epinName": "string",
                "barCode": "string"
            },
            "isDisplayExclude": boolean,
            "isGift": boolean,
            "createdDate": "YYYY-MM-DD hh:mm:ss"
            "updatedDate": "YYYY-MM-DD hh:mm:ss"
            "sellStopDate": {
                "gmkt": "YYYY-MM-DD hh:mm:ss"
                "iac": "YYYY-MM-DD hh:mm:ss"
            },
            "is3PL": boolean,
            "shipping": {
                "fee": 0.0,
                "placeNo": 0,
                "placeName": "string",
                "dispatchPolicyNo": 0,
                "dispatchPolicyName": "string"
                "bundleDeliveryTmplId": "string",
                "is3plDeliveryFeeFree": boolean
            },
            "isEventGoods": {
                "gmkt": false,
                "iac": false
            },
            "isLowestPrice": {
                "gmkt": false,
                "iac": false
            },
            "lowestPrice": {
                "gmkt": 0.0,
                "iac": 0.0
            },
            "isStarDelivery": boolean
        }
    ]
}

JSON_Fail

{
    "resultCode": int,
    "message": "string"
}

Sample Code_Success

{
    "totalItems": 5,
    "pageIndex": 1,
    "pageSize": 10,
    "items": [
        {
            "no": 1,
            "goodsNo": "2035363538",
            "siteGoodsNo": {
                "gmkt": "2693155434",
                "iac": "C851960889"
            },
            "managedCode": "99025306",
            "imgUrl": "http://gdimg.gmarket.co.kr/goods_image2/middle_img2/269/315/2693155434.jpg?tcache=638241499115636709",
            "goodsName": "테스트 상품",
            "prmtGoodsNameType": 1,
            "prmtGoodsName": {
                "gmkt": "",
                "iac": ""
            },
            "siteSellerId": {
                "gmkt": "test",
                "iac": "test"
            },
            "sellStatus": {
                "gmkt": "11",
                "iac": "11"
            },
            "price": {
                "gmkt": 12000.0000,
                "iac": 12000.0000
            },
            "dispEndDate": "2023-11-30 23:59:59",
            "groupNo": {
                "gmkt": 0,
                "iac": 0
            },
            "sellerDiscount": {
                "gmkt": {
                    "type": 0,
                    "discountAmt": 0.0
                },
                "iac": {
                    "type": 0,
                    "discountAmt": 0.0
                }
            },
            "stock": {
                "gmkt": 12,
                "iac": 12
            },
            "category": {
                "site": {
                    "gmkt": {
                        "catCode": "100000028200001909300020610",
                        "catName": "도서음반/e교육 > 대학교재 > 사범대계열"
                    },
                    "iac": {
                        "catCode": "36232000",
                        "catName": "도서/교육/음반 > 대학교재 > 사범계열"
                    }
                },
                "esm": {
                    "catCode": "00170014000800000000",
                    "catName": "도서 > 만화 > SF/판타지/모험만화"
                }
            },
            "useOption": false,
            "useAddonService": false,
            "gift": "",
            "plusOne": "",
            "brand": {
                "id": 0,
                "name": "팩토리나인"
            },
            "maker": {
                "id": 0,
                "name": "팩토리나인"
            },
            "productBrand": {
                "id": 0,
                "name": null
            },
            "catalog": {
                "epinCode": 2722056,
                "epinName": null,
                "barCode": ""
            },
            "isDisplayExclude": false,
            "isGift": true,
            "createdDate": "2022-12-06 13:38:40",
            "updatedDate": "2023-06-29 14:31:39",
            "sellStopDate": {
                "gmkt": "2023-06-02 12:49:11",
                "iac": "2023-06-02 12:49:11"
            },
            "is3PL": false,
            "shipping": {
                "fee": 0.0000,
                "placeNo": 1462434,
                "placeName": "테스트",
                "dispatchPolicyNo": 189375,
                "dispatchPolicyName": "발송일미정",
                "bundleDeliveryTmplId": "11746389",
                "is3plDeliveryFeeFree": false
            },
            "isEventGoods": {
                "gmkt": false,
                "iac": false
            },
            "isLowestPrice": {
                "gmkt": false,
                "iac": false
            },
            "lowestPrice": {
                "gmkt": 0.0,
                "iac": 0.0
            },
            "isStarDelivery" : false
        }
    ]
}

Sample Code_Fail

{
    "resultCode": 1000,
    "message": "[InvalidApiRequestEx][\"한번에 조회 가능한 상품 수는 1~500 사이로 입력해야 합니다.\"]"
}