non-print

API Index

Introduction

Cafe24 API

카페24 쇼핑몰 API는 카페24 쇼핑몰에 연동하여 서비스를 제공하기 위한 앱스토어 입점 개발사, 서드파티 솔루션 제공자 등에 제공하는 API입니다.

카페24 API는 RESTful한 아키텍쳐로서 OAuth 2.0 기반의 인증 시스템과 표준 HTTP Request Method, 리소스를 예측할 수 있는 엔드포인트 URL, HTTP 코드 기반의 에러 메시지를 제공합니다.

Request/Response Format

API 요청과 응답은 JSON Format을 지원합니다.
개인정보 보호를 위하여 카페24 API는 HTTPS 프로토콜만 지원합니다.
Dates 속성은 ISO_8601 Format으로 제공합니다. : YYYY-MM-DDTHH:MM:SS+09:00

요청 예제 (조회)

요청 예제 (등록/수정)

정상 응답 예제

{
  "resource": {
      "key": "value",
      "key": "value"
   }
}

에러 응답 예제

{
  "error": {
      "code": "에러 코드",
      "message": "에러 메세지",
      "more_info": {
      }
  }
}

Method

각 리소스 별로 Create, Read, Update, Delete를 지원하며 표준 HTTP Method를 사용하여 API를 사용할 수 있습니다.

POST : 해당 리소스를 생성(Create)합니다.
GET : 해당 리소스의 정보를 조회(Read)합니다.
PUT : 해당 리소스를 수정(Update)합니다.
DELETE : 해당 리소스를 삭제(Delete)합니다.

Admin API Intro

Admin API

Admin API는 쇼핑몰 관리자가 쇼핑몰의 정보를 조회하거나 생성, 수정, 삭제하는데 적합합니다. Admin API는 해당 리소스의 정보를 대부분 조회할 수 있으며 OAuth 2.0 방식의 별도 인증을 통과한 경우에만 사용할 수 있습니다.

  사용 예시  
 https://{mallid}.cafe24api.com/api/v2/admin/sampleapi 

API Status Code

Code	발생하는 사례	오류 해결 방법
200	GET 성공, PUT 성공, DELETE 성공시
201	POST 성공시
207	다중 요청 등록시 상태가 객체별로 다른 경우	오류 상태를 객체별로 확인하여 해당 상태에 따라 대응합니다.
400	서버에서 요청을 이해할 수 없음 1) Content-Type이 잘못 지정되어있음 2) application/type이 json이 아님	요청시 "Content-Type"이 application/json으로 되어있는지 확인합니다.
400	요청 API URL에 한글 또는 특수문자를 인코딩하지 않고 그대로 사용한 경우	요청 API URL에 한글 또는 특수문자를 URL 인코딩하였는지 확인합니다.
401	1) Access Token 없이 호출한 경우 2) Access Token이 유효하지 않은 경우 3) Access Token이 만료된 경우 4) 알 수 없는 클라이언트일 경우	유효한 발급 절차에 따라 발급받은 Access Token을 사용하였는지 확인합니다.
401	Front API 사용시 client_id를 미입력한 경우	유효한 클라이언트 ID를 사용하였는지 확인합니다.
403	1) Access Token은 있으나 해당 Scope에 권한이 없음 2) Front API에서 볼 수 있는 권한이 없을 경우	API를 호출할 수 있는 권한이 있는지 API의 Scope 또는 쇼핑몰의 설정을 확인합니다.
403	https 프로토콜이 아닌 경우	API 요청시 https 로 요청하였는지 확인합니다.
403	뉴상품 쇼핑몰이 아닌 경우	쇼핑몰이 (뉴)상품관리로 업그레이드 되어야 사용 가능합니다.
403	(Admin API 호출시) 쇼핑몰에서 해당 앱이 삭제된 경우	쇼핑몰에 앱이 설치되었는지 확인 후 앱을 다시 설치합니다.
403	(Front API 호출시) 쇼핑몰에서 해당 앱이 삭제된 경우	쇼핑몰에 앱이 설치되었는지 확인 후 앱을 다시 설치합니다.
404	1) API URL을 잘못 호출한 경우 2) 리소스를 찾을 수 없을 경우 3) {#id}가 없는 경우	엔드포인트 URL의 오류가 있는지 API 문서를 참고하여 확인합니다.
422	조회/처리 요청시 값이 정해진 스펙과 다를 경우 1) 필수 파라메터 누락함 2) 정해진 스펙과 다를 경우	API 문서를 참고하여 필수 파라메터가 입력되지 않았거나 유효하지 않은 값을 입력하였는지 확인합니다.
429	클라이언트의 API 요청이 Bucket을 초과한 경우	API 최대 허용 요청 건수를 초과하지 않도록 잠시 후 다시 요청합니다.
500	내부 서버 에러, 알 수 없는 에러	일시적으로 에러가 발생하였습니다. 잠시 후에 다시 시도합니다.
503	현재 서버가 다운된 경우	개발자센터로 문의해주세요.
503	서버가 다운된 경우. API를 사용할 수 없음.	개발자센터로 문의해주세요.
504	요청 시간이 초과된 경우(Timeout)	일시적으로 에러가 발생하여 응답이 지연되고 있습니다. 잠시 후에 다시 시도해주세요.

How to use GET API

카페24 API는 데이터를 조회하는 여러가지 방법을 제공하고 있습니다.

다음은 API 조회시 여러가지 파라메터를 사용하여 다양하게 데이터를 호출할 수 있는 방법을 설명하고 있습니다.

1. 검색조건을 추가하기

API 조회시 검색조건은 엔드포인트에 파라메터를 추가하여 검색할 수 있습니다.

여러 조건을 같이 검색할 경우 "&" 구분자를 이용하여 검색 조건을 추가할 수 있습니다.

시작일, 종료일 등 범위를 검색할 경우에도 "&" 구분자를 사용하여 검색할 수 있습니다.

  검색조건을 추가하기  
 예) 특정 브랜드 내에서 가격이 1000원 이상인 상품을 검색하고 싶을 경우
GET https://{mallid}.cafe24api.com/api/v2/products?brand_code=B000000A&price_min=1000

예) 상품 등록일 검색
GET https://{mallid}.cafe24api.com/api/v2/products?created_start_date=2018-01-03&created_end_date=2018-02-03 

2. 파라메터에서 여러조건 검색하기

API에서 지원하는 경우, 콤마(,)를 사용하여 여러 값을 동시에 검색할 수 있습니다. (단, 100개 항목 이하로 입력 해주세요.)

콤마(,)로 추가한 검색 조건은 OR 조건으로, 해당 검색 조건에 해당되는 모든 값이 검색됩니다.

  파라메터에서 여러조건 검색하기  
 예) 11번, 12번, 13번 상품의 정보를 조회할 경우
GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13 

3. 멀티쇼핑몰 정보 조회

API 조회시 특정 shop_no를 명시하면 해당 멀티쇼핑몰의 정보를 조회할 수 있습니다.

특정 shop_no를 명시하지 않을 경우 1번 쇼핑몰(기본 쇼핑몰)의 정보를 조회합니다.

  멀티쇼핑몰 정보 조회  
 예) 2번 쇼핑몰의 상품 조회하기
GET https://{mallid}.cafe24api.com/api/v2/products?shop_no=2 

4. 상세 조회와 단건 조회

대부분의 리소스는 URL에 리소스의 ID를 명시하여 상세 조회할 수 있습니다.

상세조회는 리소스 하나만 조회할 수 있지만, 목록 조회할 경우보다 더 많은 항목이 반환됩니다.

  상세 조회와 단건 조회  
 예 ) 128번 상품을 상세 조회하는 방법
GET https://{mallid}.cafe24api.com/api/v2/admin/products/128


예) 128번 상품을 파라메터를 이용하여 단건 조회하는 경우
GET https://{mallid}.cafe24api.com/api/v2/admin/products?product_no=128 

5. Pagination

목록 조회시 조회하는 항목이 너무 많을 경우 모든 결과가 한번에 조회되지 않을 수 있습니다.

한번에 결과를 좀 더 많이 조회하고 싶을 경우 'limit' 파라메터를 사용하여 조회 건수를 확장할 수 있습니다.

'limit' 파라메터를 사용하지 않을 경우 'limit'의 기본값만큼만 조회됩니다.

'limit' 파라메터로 확장할 수 있는 조회건수는 각 API마다 정의된 '최대값'만큼만 확장할 수 있습니다.

만약 'limit 최대값'으로 모든 데이터를 조회할 수 없는 경우 'offset' 파라메터를 사용할 수 있습니다.

'offset' 파라메터는 몇번째 상품부터 조회를 시작할 것인지 정하여, 해당 상품부터 'limit' 갯수만큼의 상품을 다시 조회합니다.

  Pagination  
 예 ) 상품을 한번에 100개 조회하기
GET https://{mallid}.cafe24api.com/api/v2/admin/products?limit=100


예) 201번째 상품부터 300번째 상품까지 조회하기
GET https://{mallid}.cafe24api.com/api/v2/admin/products?limit=100&offset=200 

6. Field 파라메터

API의 조회값 중 특정한 값들만 조회하고 싶을 때는 field 파라메터를 사용하여 해당 값들을 조회할 수 있습니다.

  Field 파라메터  
 예 ) 상품 조회시 상품명과 상품 번호 파라메터만 조회하기
GET https://{mallid}.cafe24api.com/api/v2/admin/products?fields=product_name,product_no 

7. Embed 파라메터

상품 조회시 상품에 속한 하위 리소스(예. 품목, 재고)를 같이 조회해야할 경우 'embed' 파라메터를 사용하면 하위 리소스의 데이터를 같이 조회할 수 있습니다.

'embed' 파라메터는 지원하는 API에서만 사용이 가능합니다.

  Embed 파라메터  
 예) 상품 조회시 재고와 품목 데이터를 함께 조회하기
GET https://{mallid}.cafe24api.com/api/v2/admin/products/570?embed=variants,inventories 

API Limit

카페24 API는 "Leaky Bucket" 알고리즘으로 작동합니다. Leaky Bucket 알고리즘은 성능을 위해 비정상적으로 많은 API 요청만 제한되고 일상적인 API 요청은 별다른 제약 없이 사용할 수 있는 효과가 있습니다.

카페24 API는 API 요청을 Bucket에 쌓아둡니다. Bucket은 쇼핑몰 당 "호출건 수 제한"만큼 가득차면 API 호출이 제한됩니다. Bucket은 1초에 2회씩 감소하며, 감소한만큼 다시 API 호출을 할 수 있습니다.

만약 앱이 1초에 2회씩 API를 호출한다면 API 호출을 별다른 제약 없이 계속 사용할 수 있습니다.
순간적으로 1초 이내에 "호출건 수 제한" 이상의 콜이 발생한다면 429 에러(Too Many Request)를 반환합니다.
Bucket 이내의 호출이라도 해당 쇼핑몰에서 동일 IP로 초당 10회 이상의 호출이 발생할 경우 비정상적인 호출로 판단될 수 있습니다.

Header에 X-Api-Call-Limit을 확인하면 429 에러를 피할 수 있습니다. 해당 쇼핑몰에서 얼마나 API를 호출했는지, 그리고 Bucket 여유량은 얼마나 남았는지를 확인할 수 있습니다.

X-Api-Call-Limit : 1/40

Versioning

Version 2021-03-01 (latest)

이전 버전과 호환되지 않은 변경사항에 대해 날짜로 버전을 제공합니다.

custom headers "X-Cafe24-Api-Version"를 통해 원하시는 버전을 지정할 수 있으며 버전을 지정하지 않을경우 최신버전으로 동작됩니다.

예시 코드 (요청)

Authentication

Get Authentication Code

토큰발급 요청시 사용된 code는 재사용할 수 없으며 코드 발급 후 1분이 경과하면 만료됩니다.

{mallid} : 해당 쇼핑몰ID를 입력합니다.
{client_id} : 개발자 센터에서 생성한 앱의 client_id를 입력합니다.
{state} : 위변조 방지를 위해 입력하는 값으로 코드 반환시 같은 값이 반환됩니다.
{redirect_uri} : 개발자 센터에서 생성한 앱의 Redirect URL을 입력합니다.
{scope} : 해당 접근 토큰으로 접근할 리소스 서버의 권한을 입력할 수 있습니다.

접근 토큰을 발급 받으려면 면저 접근 코드를 요청해야 합니다. 접근 코드는 클라이언트가 웹 애플리케이션 형태일 경우 이용됩니다. 코드 요청은 cURL이 아닌 웹브라우저에서 진행하셔야 합니다.

  예시 코드 (요청)  
 GET 'https://{mallid}.cafe24api.com/api/v2/oauth/authorize?response_type=code&client_id={client_id}&state={state}&redirect_uri={redirect_uri}&scope={scope}' 
  예시 코드 (응답)  
 HTTP/1.1 302 Found
Location: {redirect_uri}?code={authorize_code}&state={state} 

Get Access Token

발급 받은 인증 코드를 사용하여 실제로 API를 호출할 수 있는 사용자 토큰(Access Token, Refresh Token)을 받아 올 수 있습니다.

{mallid} : 해당 쇼핑몰ID를 입력합니다.
{client_id} : 개발자 센터에서 생성한 앱의 client_id를 입력합니다.
{client_secret} : 개발자 센터에서 생성한 앱의 client_secret을 입력합니다.
{code} : 발급받은 코드를 입력합니다.
{redirect_uri} : 개발자 센터에서 생성한 앱의 Redirect URL을 입력합니다.

access_token : 접근 토큰으로서 클라이언트가 리소스 서버에 접근시 사용됩니다.

refresh_token : 접근 토큰 만료 후 재발급을 위해 사용하는 토큰입니다.

예시 코드 (요청)

예시 코드 (응답)

HTTP/1.1 200 OK
{
    "access_token": "0iqR5nM5EJIq.......",
    "expires_at": "2017-10-19T19:17:57.902",
    "refresh_token": "Cuq6H1WLKBxqqf.......",
    "client_id": "BrIfqEKoP.......",
    "mall_id": "yourmall",
    "user_id": "test",
    "scopes": [
        "mall.read_order",
        "mall.read_product",
        "mall.read_store",
        "...etc...",
    ],
    "issued_at": "2017-10-19T17:17:57.911"
}

Get Access Token using refresh token

접근 토큰은 발급 받은 후 2시간이 지나면 사용할 수 없습니다. 접근 토큰이 만료된 후 다시 재발급을 받아야 리소스 서버에 접근할 수 있습니다. 이미 접근 토큰을 발급 받았다면 refresh_token를 사용하여 접근 토큰을 재발급 받을수 있습니다.

refresh token은 2주간 유효하며, refresh token 만료전에 요청을 하면 갱신된 access token과 갱신된 refresh token이 함께 반환됩니다. 기존 refresh token은 만료처리되어 사용할 수 없습니다.

발급 받은 인증 코드를 사용하여 실제로 API를 호출할 수 있는 사용자 토큰(Access Token, Refresh Token)을 받아 올 수 있습니다.

{mallid} : 해당 쇼핑몰ID를 입력합니다.
{domain} : 해당 쇼핑몰의 도메인을 입력합니다.
{client_id} : 개발자 센터에서 생성한 앱의 client_id를 입력합니다.
{client_secret} : 개발자 센터에서 생성한 앱의 client_secret을 입력합니다.
{refresh_token} : 토큰 발급시 받은 refresh_token을 입력합니다.

access_token : 접근 토큰으로서 클라이언트가 리소스 서버에 접근시 사용됩니다.

refresh_token : 접근 토큰 만료 후 재발급을 위해 사용하는 토큰입니다.

예시 코드 (요청)

예시 코드 (응답)

HTTP/1.1 200 OK
{
    "access_token": "0iqR5nM5EJIq.......",
    "expires_at": "2017-10-19T19:17:57.902",
    "refresh_token": "Cuq6H1WLKBxqqf.......",
    "client_id": "BrIfqEKoP.......",
    "mall_id": "yourmall",
    "user_id": "test",
    "scopes": [
        "mall.read_order",
        "mall.read_product",
        "mall.read_store",
        "...etc...",
    ],
    "issued_at": "2017-10-19T17:17:57.911"
}

Property	Description
SCOPE	상품분류 읽기권한 (mall.read_category)
호출건수 제한	40

Property	Description
SCOPE	상품분류 쓰기권한 (mall.write_category)
호출건수 제한	40
1회당 요청건수 제한	1

Property	Description
SCOPE	상품분류 쓰기권한 (mall.write_category)
호출건수 제한	40
1회당 요청건수 제한	1

Property	Description
SCOPE	상품분류 쓰기권한 (mall.write_category)
호출건수 제한	40

Property	Description
SCOPE	상품분류 읽기권한 (mall.read_category)
호출건수 제한	40

Property	Description
SCOPE	상품분류 읽기권한 (mall.read_category)
호출건수 제한	40

Property	Description
SCOPE	상품분류 읽기권한 (mall.read_category)
호출건수 제한	40

Property	Description
SCOPE	상품분류 쓰기권한 (mall.write_category)
호출건수 제한	40
1회당 요청건수 제한	1

Property	Description
SCOPE	상품분류 쓰기권한 (mall.write_category)
호출건수 제한	40
1회당 요청건수 제한	1

Property	Description
SCOPE	상품분류 쓰기권한 (mall.write_category)
호출건수 제한	40

Parameter	Description
category_no Required	분류 번호

Property	Description
SCOPE	상품분류 읽기권한 (mall.read_category)
호출건수 제한	40

Property	Description
SCOPE	상품분류 쓰기권한 (mall.write_category)
호출건수 제한	40
1회당 요청건수 제한	1

Property	Description
SCOPE	상품분류 읽기권한 (mall.read_category)
호출건수 제한	40

Property	Description
SCOPE	상품분류 쓰기권한 (mall.write_category)
호출건수 제한	40
1회당 요청건수 제한	1

Property	Description
SCOPE	상품분류 읽기권한 (mall.read_category)
호출건수 제한	40

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
category_no Required	분류 번호
display_group Required 최소: [1]~최대: [3]	상세 상품분류 1 : 일반상품 2 : 추천상품 3 : 신상품
limit 최소: [1]~최대: [50000]	조회결과 최대건수 DEFAULT 50000

Definition Copy

Request example: Copy

Response example:

Count all categories products

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

category_no
Required

분류 번호

display_group
Required

최소: [1]~최대: [3]

상세 상품분류

1 : 일반상품
2 : 추천상품
3 : 신상품

Definition Copy

Request example: Copy

Response example:

Create a categories product

POST

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

category_no
Required

분류 번호

display_group

최소: [1]~최대: [3]

상세 상품분류

1 : 일반상품
2 : 추천상품
3 : 신상품

DEFAULT 1

product_no
Required

상품번호

Definition Copy

Request example: Copy

Response example:

Update a categories product

PUT

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
category_no Required	분류 번호
display_group Required 최소: [1]~최대: [3]	상세 상품분류 1 : 일반상품 2 : 추천상품 3 : 신상품
product_no Required	상품번호
sequence 최소: [1]~최대: [999999]	진열 순서
auto_sort	자동 정렬 여부 T : 자동 정렬 사용함 F : 자동 정렬 사용안함
fixed_sort	고정 여부 T : 진열순위 고정 사용함 F : 진열순위 고정 사용안함

Definition Copy

Request example: Copy

Response example:

Delete a categories product

DELETE

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

category_no
Required

분류 번호

product_no
Required

상품번호

display_group

최소: [1]~최대: [3]

상세 상품분류

일반상품 영역에서 진열안함 처리 시, 추천상품/신상품 영역에서도 동시에 진열안함 처리된다.

1 : 일반상품
2 : 추천상품
3 : 신상품

DEFAULT 1

Definition Copy

Request example: Copy

Response example:

Mains products

메인분류 상품(Mains products)은 상품 메인진열의 순서에 관한 메인분류의 관계형 리소스입니다.

Endpoints

GET /api/v2/admin/mains/{display_group}/products
GET /api/v2/admin/mains/{display_group}/products/count
POST /api/v2/admin/mains/{display_group}/products
PUT /api/v2/admin/mains/{display_group}/products
DELETE /api/v2/admin/mains/{display_group}/products/{product_no}

Mains products properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
product_no	상품번호
product_name	상품명
fixed_sort	고정 여부

List all mains products

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

display_group
Required

메인분류 번호

Definition Copy

Request example: Copy

Response example:

Count all mains products

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

display_group
Required

메인분류 번호

Definition Copy

Request example: Copy

Response example:

Create a mains product

POST

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

display_group
Required

메인분류 번호

product_no
Required

상품번호

Definition Copy

Request example: Copy

Response example:

Update a mains product

PUT

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
display_group Required	메인분류 번호
product_no Required	상품번호 요청한 상품번호의 순서 대로 진열순위가 지정
fix_product_no	진열순위 고정 상품번호 진열순위를 고정하고자 하는 상품번호를 지정

Definition Copy

Request example: Copy

Response example:

Delete a mains product

DELETE

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

display_group
Required

메인분류 번호

product_no
Required

상품번호

Definition Copy

Request example: Copy

Response example:

Products

Products 리소스 관계도
상품(Products)은 쇼핑몰에서 판매되는 물건이나 서비스를 의미합니다. 상품은 다양한 색 또는 사이즈의 옵션을 통해 품목으로 쪼개질 수 있습니다.

상품은 다음과 같은 리소스를 하위 리소스로 갖고 있습니다.
● 품목(Variants)
● 상품 메모(Memos)
● SEO(SEO)
● 상품 조회 수(Hits)

Endpoints

GET /api/v2/admin/products
GET /api/v2/admin/products/count
GET /api/v2/admin/products/{product_no}
POST /api/v2/admin/products
PUT /api/v2/admin/products/{product_no}
DELETE /api/v2/admin/products/{product_no}

Products properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
product_no	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
product_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	상품코드 시스템이 상품에 부여한 코드. 해당 쇼핑몰 내에서 상품코드는 중복되지 않음.
custom_product_code 최대글자수 : [40자]	자체상품 코드 사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.
product_name 최대글자수 : [250자]	상품명 상품의 이름. 상품명은 상품을 구분하는 가장 기초적인 정보이며 검색 정보가 된다. HTML을 사용하여 입력이 가능하다.
eng_product_name 최대글자수 : [250자]	영문 상품명 상품의 영문 이름. 해외 배송 등에 사용 가능함.
supply_product_name 최대글자수 : [250자]	공급사 상품명 공급사에서 등록한 상품의 이름. 공급사에서 상품의 구분을 위해 임의로 입력할 수 있으며 상품명에는 영향을 미치지 않는다.
internal_product_name 최대글자수 : [50자]	상품명(관리용)
model_name 최대글자수 : [100자]	모델명 상품의 모델명.
price_excluding_tax	상품가(세금 제외)
price	상품 판매가 상품의 판매 가격. 쿠폰 및 혜택을 적용하기 전의 가격. 상품 등록시엔 모든 멀티 쇼핑몰에 동일한 가격으로 등록하며, 멀티쇼핑몰별로 다른 가격을 입력하고자 할 경우 상품 수정을 통해 가격을 다르게 입력할 수 있다. ※ 판매가 = [ 공급가 + (공급가 * 마진율) + 추가금액 ]
retail_price	상품 소비자가 시중에 판매되는 소비자 가격. 쇼핑몰의 가격을 강조하기 위한 비교 목적으로 사용함.
supply_price	상품 공급가 상품의 원가. 공급가에 마진율을 더하여 판매가를 계산할 수 있음. API에서는 공급가는 참조 목적으로만 사용한다.
display	진열상태 상품을 쇼핑몰에 진열할지 여부. 상품을 쇼핑몰에 진열할 경우 설정한 상품분류와 메인화면에 표시된다. 상품이 쇼핑몰에 진열되어 있지 않으면 쇼핑몰 화면에 표시되지 않아 접근할 수 없으며 상품을 구매할 수 없다. T : 진열함 F : 진열안함
selling	판매상태 상품을 쇼핑몰에 판매할지 여부. 상품을 진열한 상태로 판매를 중지할 경우 상품은 쇼핑몰에 표시되지만 "품절"로 표시되어 상품을 구매할 수 없다. 상품이 "진열안함"일 경우 "판매함" 상태여도 상품에 접근할 수 없기 때문에 구매할 수 없다. T : 판매함 F : 판매안함
product_condition	상품 상태 판매하는 상품의 상태 표시. N : 신상품 B : 반품상품 R : 재고상품 U : 중고상품 E : 전시상품 F : 리퍼상품 S : 스크래치 상품
product_used_month 최대값: [2147483647]	중고상품 사용 개월
summary_description 최대글자수 : [255자]	상품요약설명 상품에 대한 요약 정보. 상품 진열 화면에서 노출 가능한 설명. HTML을 사용하여 입력이 가능하다. 상품관리 > 상품표시관리 > 상품정보표시 설정에서 노출되도록 설정 가능하다.
product_tag 최대글자수 : [200자]	상품 검색어 검색 또는 분류를 위하여 상품에 입력하는 검색어 정보(해시태그)
margin_rate 최소: [-999.99]~최대: [999.99]	마진률 상품의 원가에 더하여 판매가 계산을 위한 마진율. Api에서는 해당 값은 참고용으로만 사용된다.
tax_type	과세 구분 해당 상품의 과세 정보. 해당 상품의 부가세 포함 유형. 과세상품 = 세금이 부과된 상품. 면세상품 = 세금이 면제되는 상품. 가공되지 않은 농/수/축산물, 연탄, 도서류, 보험, 여성용품 등의 상품이 이에 해당하며, 과세사업자로 등록해야 함 영세상품 = 부가세가 0%로 적용되는 수출용 외화 획득 상품 A : 과세상품 B : 면세 상품 C : 영세상품
tax_amount 최소: [0]~최대: [100]	과세율 과세상품인 경우, 해당 상품에 적용되는 부가세율을 명시함. 부가세는 국가 및 지역에 따라 상이할 수 있음.
price_content 최대글자수 : [20자]	판매가 대체문구 상품의 가격 대신 표시되는 문구. 품절이나 상품이 일시적으로 판매 불가할 때 사용.
buy_limit_by_product	구매제한 개별 설정여부 T : 사용함 F : 사용안함
buy_limit_type	구매제한 해당 상품을 구매할 수 있는 회원 정보 표시. N : 회원만 구매하며 구매버튼 감추기 M : 회원만 구매하며 구매버튼 보이기 F : 구매제한 안함
buy_group_list	구매가능 회원 등급
repurchase_restriction	재구매 제한 T : 재구매 불가 F : 제한안함
single_purchase_restriction	단독구매 제한 T : 단독구매 불가 F : 제한안함
buy_unit_type	구매단위 타입 해당 상품의 구매 단위를 1개 이상으로 설정한 경우 해당 구매 단위를 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 O : 품목 기준
buy_unit	구매단위 구매할 수 있는 최소한의 단위 표시. 예) 구매 주문단위가 세 개일 경우, 3개, 6개, 9개 단위로 구매 가능함.
order_quantity_limit_type	주문수량 제한 기준 해당 상품의 주문 수량 제한시 제한 기준을 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 O : 품목 기준
minimum_quantity 최대값: [2147483647]	최소 주문수량 주문 가능한 최소한의 주문 수량. 주문 수량 미만으로 구매 할 수 없음.
maximum_quantity 최대값: [2147483647]	최대 주문수량 주문 가능한 최대한의 주문 수량. 주문 수량을 초과하여 구매 할 수 없음. 최대 주문수량이 "제한없음"일 경우 "0"으로 표시된다.
points_by_product	적립금 개별설정 사용여부 F : 기본설정 사용 T : 개별설정
points_setting_by_payment	결제방식별 적립금 설정 여부 B : 기본 적립금설정 사용 C : 결제방식에 따른 적립
points_amount	적립금 설정 정보
except_member_points	회원등급 추가 적립 제외 T : 회원등급 추가 적립 제외 설정함 F : 회원등급 추가 적립 제외 설정안함
product_volume	상품 부피 정보
adult_certification	성인인증 성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함. T : 사용함 F : 사용안함
detail_image	상세이미지 상품 상세 화면에 표시되는 상품 이미지.
list_image	목록이미지 상품 분류 화면, 메인 화면, 상품 검색 화면에 표시되는 상품의 목록 이미지.
tiny_image	작은목록이미지 최근 본 상품 영역에 표시되는 상품의 목록 이미지.
small_image	축소이미지 상품 상세 화면 하단에 표시되는 상품 목록 이미지.
has_option	옵션 사용여부 해당 상품이 옵션을 갖고 있는지에 대한 여부. 옵션을 갖고 있는 상품은 사이즈나 색상과 같은 다양한 선택지를 제공한다. T : 옵션사용함 F : 옵션 사용안함
option_type	옵션 구성방식 옵션을 사용할 경우, 옵션의 유형 표시 ● 조합 일체선택형 : 하나의 셀렉스박스(버튼 이나 라디오버튼)에 모든 옵션이 조합되어 표시됨 ● 조합 분리선택형 : 옵션을 각각의 셀렉스박스(버튼 이나 라디오버튼)로 선택할 수 있으며 옵션명을 기준으로 옵션값을 조합할 수 있음 ● 상품 연동형 : 옵션표시방식은 조합형과 유사하지만 필수옵션과 선택옵션을 선택할 수 있음. 옵션의 조합을 제한 없이 생성할 수 있음. ● 독립 선택형 : 독립적인 조건 여러개를 각각 선택할 수 있는 옵션으로 옵션 값이 조합되지 않고 각각의 품목으로 생성됨. C : 조합 일체선택형 S : 조합 분리선택형 E : 상품 연동형 F : 독립 선택형
use_naverpay	네이버페이 사용여부 T : 사용함 F : 사용안함
naverpay_type	네이버페이 판매타입 C : 네이버페이 + 쇼핑몰 동시판매 상품 O : 네이버페이 전용상품
manufacturer_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	제조사 코드 제조사를 등록하면 자동으로 생성되는 코드로 상품에 특정 제조사를 지정할 때 사용. 미입력시 자체제작(M0000000) 사용
trend_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	트렌드 코드 트렌드를 등록하면 자동으로 생성되는 코드로 상품에 특정 트렌드를 지정할 때 사용. 미입력시 기본트렌드(T0000000) 사용
brand_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	브랜드 코드 브랜드를 등록하면 자동으로 생성되는 코드로 상품에 특정 브랜드를 지정할 때 사용. 미입력시 자체브랜드(B0000000) 사용
supplier_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	공급사 코드 공급사를 등록하면 자동으로 생성되는 코드로 상품에 특정 공급사를 지정할 때 사용.
made_date	제조일자 상품을 제조한 제조일자.
release_date	출시일자 상품이 시장에 출시된 일자.
expiration_date 배열 최대사이즈: [2]	유효기간 상품을 정상적으로 사용할 수 있는 기간. 상품권이나 티켓 같은 무형 상품, 식품이나 화장품 같은 유형 상품의 유효기간을 표시. 주로 상품권이나 티켓 같은 무형 상품에 사용되며, 해당 무형 상품의 유효기간을 표시.
origin_classification	원산지 국내/국외/기타 F : 국내 T : 국외 E : 기타
origin_place_no	원산지 번호 원산지 번호를 List all Origin API를 통해 원산지를 조회하여 입력 origin_classification이 F(국내)인 경우, 해외 여부(foreign)가 "F"인 원산지만 입력 가능함. origin_classification이 T(해외)인 경우, 해외 여부(foreign)가 "T"인 원산지만 입력 가능함.
origin_place_value 최대글자수 : [30자]	원산지기타정보 원산지가 "기타(1800)"일 경우 원산지로 입력 가능한 정보.
made_in_code	원산지 국가코드
icon_show_period	아이콘 노출 기간 상품에 설정한 아이콘이 노출되는 기간.
icon 배열 최대사이즈: [5]	아이콘 상품에 표시되는 아이콘. 상품 판매를 강조하기 위한 목적으로 사용이 가능함.
hscode	HS코드 해외 배송시 관세 부과를 위해 사용하는 HS코드. 국제 배송시 통관을 위해 반드시 정확한 번호를 입력해야 함. ※ HS코드 : 세계무역기구(WTO) 및 세계관세기구(WCO)가 무역통계 및 관세분류의 목적상 수출입 상품을 숫자 코드로 분류화 한 것으로, 수입 시 세금부과와 수출품의 통제 및 통계를 위한 분류법
product_weight	상품 중량 상품의 전체 중량(kg). 배송을 위해 상품 자체의 무게와 박스 무게, 포장무게를 모두 포함한 중량 기재가 필요하다.
product_material	상품소재 상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)
created_date timezone	생성일 상품이 생성된 일시.
updated_date timezone	수정일 상품이 수정된 일시.
english_product_material	영문 상품 소재 상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.
cloth_fabric	옷감 상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음. woven : 직물(woven) knit : 편물(knit)
list_icon	추천 / 품절 / 신상품 아이콘 노출 여부 추천, 품절, 신상품 아이콘을 목록에서 표시하는지 여부 ※ 품절 아이콘 ● 상품이 품절 상태임을 알려주는 아이콘 ● 재고관리 및 품절 기능을 사용하는 상품에 대해 재고가 없을 경우 표시 ※ 추천, 신상품 아이콘 ● 상품분류나 메인화면의 추천상품, 신상품 영역에 진열된 상품인 경우, 설정에 따라 해당 아이콘을 표시함 ※ 아이콘 노출 여부 설정위치 : [상점관리> 운영관리> 운영방식 설정> (탭)상품 관련 설정> 상품 아이콘 설정]
select_one_by_option	옵션별로 한 개씩 선택 (독립형 옵션) 독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함. T : 사용함 F : 사용안함
approve_status	승인요청 결과 N : 승인요청 (신규상품) E : 승인요청 (상품수정) C : 승인완료 R : 승인거절 I : 검수진행중 Empty Value : 요청된적 없음
classification_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	자체분류 코드 자체분류를 등록하면 자동으로 생성되는 코드로 상품에 특정 자체분류를 지정할 때 사용. 미입력시 기본자체분류(C000000A) 사용
sold_out	품절여부 T : 품절 F : 품절아님
additional_price	판매가 추가금액
discountprice	상품 할인판매가 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
decorationimages	꾸미기 이미지 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
benefits	혜택 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
options	상품 옵션 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
variants	품목 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
clearance_category_eng	해외통관용 상품구분 영문명 해외 통관시 통관용 상품 구분 정보로 사용하는 정보. 국문명 입력시 입력한 구분명이 자동으로 번역된 항목. 번역된 영문명이 해외송장 상품명에 포함되어 전송됨.
clearance_category_kor	해외통관용 상품구분 국문명 해외 통관시 통관용 상품 구분 정보로 사용하는 정보. 자동으로 영문으로 번역되어 해외송장 상품명 정보에 포함하여 전송.
clearance_category_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	해외통관코드 clearance_category_code
additionalimages	추가 이미지 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
exposure_limit_type	표시제한 범위 A : 모두에게 표시 M : 회원에게만 표시
exposure_group_list	표시대상 회원 등급
set_product_type	세트상품 타입 C : 일반세트 S : 분리세트
memos	메모 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
hits	상품 조회수 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
seo	상품 Seo 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
category	분류 번호 해당 상품이 진열되어있는 상품 분류.
project_no	기획전 번호
description	상품상세설명 상품에 보다 상세한 정보가 포함되어있는 설명. HTML을 사용하여 입력이 가능하다.
mobile_description	모바일 상품 상세설명 입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.
separated_mobile_description	모바일 별도 등록 T : 직접등록 F : 상품 상세설명 동일
additional_image 배열 최대사이즈: [20]	추가이미지 상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다. 특정 상품 상세 조회 API에서만 확인 가능하다.
payment_info	상품결제안내 상품의 결제 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.
shipping_info	상품배송안내 상품의 배송 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.
exchange_info	교환/반품안내 상품의 교환/반품 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.
service_info	서비스문의/안내 제품의 사후 고객 서비스 방법 대한 안내 문구. HTML을 사용하여 입력이 가능하다.
product_tax_type_text	부가세 표시 문구 상품관리 > 상품표시관리 > 상품정보표시 설정 > 판매가 부가세 표시 문구에서 설정한 문구 표시
country_hscode	국가별 HS 코드 해외 배송시 관세 부과를 위해 사용하는 HS코드. 국제 배송시 통관을 위해 반드시 정확한 번호를 입력해야 함. 국가별로 HS 코드의 표준이 다르기 때문에 해당 국가에 맞는 코드 입력이 필요함.
simple_description	상품 간략 설명 상품에 대한 간략한 정보. 상품 진열 화면에서 노출 가능한 설명. HTML을 사용하여 입력이 가능하다. 상품관리 > 상품표시관리 > 상품정보표시 설정에서 노출되도록 설정 가능하다.
tags	상품 태그 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
shipping_fee_by_product	개별배송여부 상품에 배송비를 개별적으로 부과할 것인지 공통 배송비를 부과할 것인지에 대한 설정. 개별 배송비를 사용하지 않을 경우 공통 배송비를 사용함. T : 사용함 F : 사용안함
shipping_method	배송방법 (개별배송비를 사용할 경우) 배송 수단 및 방법 01 : 택배 02 : 빠른등기 03 : 일반등기 04 : 직접배송 05 : 퀵배송 06 : 기타 07 : 화물배송 08 : 매장직접수령 09 : 배송필요 없음
prepaid_shipping_fee	배송비 선결제 설정 C : 착불 P : 선결제 B : 선결제/착불
shipping_period	배송기간 (개별배송비를 사용할 경우) 상품 배송시 평균적으로 소요되는 배송 기간.
shipping_scope	배송정보 국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. 상점관리 > 배송관리 > 배송/반품 설정에서 상품별 개별 배송료 설정이 사용안함인 경우 설정 불가. A : 국내배송 C : 해외배송 B : 국내/해외배송
shipping_area 최대글자수 : [255자]	배송지역 (개별배송비를 사용할 경우) 상품을 배송할 수 있는 지역.
shipping_fee_type	배송비 타입 (개별배송비를 사용할 경우) 상품의 배송비 타입. T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과
shipping_rates	구간별 배송비 개별배송비를 사용할 경우 상품의 개별 배송비. shipping_fee_type이 R, N일 경우 배열 안에 shipping_fee를 정의하여 배송비를 설정할 수 있다. shipping_fee_type이 M, D, W, C일 경우 배열 안에 다음과 같이 정의하여 배송비 구간을 설정할 수 있다. shipping_rates_min : 배송비 구간 시작 기준 shipping_rates_max : 배송비 구간 종료 기준 shipping_fee : 배송비
origin_place_code	원산지 코드 상품의 원산지 코드.
additional_information	추가항목 상품관리 > 상품표시관리 > 상품정보표시 설정에서 추가한 추가항목. 기본적인 상품 정보 외에 추가로 표시항 항목이 있을 때 추가하여 사용함.
image_upload_type	이미지 업로드 타입 이미지 업로드시 이미지 업로드 타입. "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드 "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드 ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음 A : 대표이미지등록 B : 개별이미지등록 C : 웹FTP 등록
main	메인진열 상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.
relational_product 배열 최대사이즈: [200]	관련상품 해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.

List all products

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter	Description
discountprice embed	상품 할인판매가 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
decorationimages embed	꾸미기 이미지 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
benefits embed	혜택 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
options embed	상품 옵션 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
variants embed	품목 리소스 상품당 품목정보를 100개까지 조회할 수 있음. 자체상품코드(custom_product_code) 또는 자체품목코드(custom_variant_code)중 한 개는 필수로 입력해야 함. 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
additionalimages embed	추가 이미지 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
product_bundle	세트상품 여부 T : 사용함 F : 사용안함
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no	상품번호 조회하고자 하는 상품의 번호 ,(콤마)로 여러 건을 검색할 수 있다.
display	진열상태 진열 혹은 미진열 되어있는 상품 검색.
selling	판매상태 판매중이거나 판매안함 상태의 상품 검색.
product_name	상품명 검색어를 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
product_code	상품코드 검색어를 상품코드에 포함하고 있는 상품 검색(대소문자 구분 필요) ,(콤마)로 여러 건을 검색할 수 있다.
brand_code	브랜드 코드 브랜드 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
manufacturer_code	제조사 코드 제조사 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
supplier_code	공급사 코드 공급사 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
trend_code	트렌드 코드 트렌드 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
product_tag	상품 검색어 검색어를 상품 검색어 또는 태그에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
custom_product_code	자체상품 코드 검색어를 자체상품코드에 포함하고 있는 상품 검색(대소문자 구분 필요) ,(콤마)로 여러 건을 검색할 수 있다.
custom_variant_code	자체 품목 코드 ,(콤마)로 여러 건을 검색할 수 있다.
price_min	상품 판매가 검색 최소값 판매가가 해당 범위 이상인 상품 검색
price_max	상품 판매가 검색 최대값 판매가가 해당 범위 이하인 상품 검색
retail_price_min 최소값: [0] 최대값: [2147483647]	상품 소비자가 검색 최소값 소비자가가 해당 범위 이상인 상품 검색
retail_price_max 최소값: [0] 최대값: [2147483647]	상품 소비자가 검색 최대값 소비자가가 해당 범위 이하인 상품 검색
supply_price_min	상품 공급가 검색 최소값 공급가가 해당 범위 이하인 상품 검색
supply_price_max	상품 공급가 검색 최대값 공급가가 해당 범위 이상인 상품 검색
created_start_date timezone	상품 등록일 검색 시작일 상품 등록일이 해당 날짜 이후인 상품 검색. 등록일 검색 종료일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
created_end_date timezone	상품 등록일 검색 종료일 상품 등록일이 해당 날짜 이전인 상품 검색. 등록일 검색 시작일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
updated_start_date timezone	상품 수정일 검색 시작일 상품 수정일이 해당 날짜 이후인 상품 검색. 수정일 검색 종료일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
updated_end_date timezone	상품 수정일 검색 종료일 상품 수정일이 해당 날짜 이전인 상품 검색. 수정일 검색 시작일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
category	분류 번호 특정 분류에 진열된 상품 검색.
eng_product_name	영문 상품명 검색어를 영문 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
supply_product_name	공급사 상품명 검색어를 공급사 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
internal_product_name	상품명(관리용) ,(콤마)로 여러 건을 검색할 수 있다.
model_name	모델명 검색어를 모델명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
product_condition	상품 상태 특정 상품 상태 검색 ,(콤마)로 여러 건을 검색할 수 있다.
origin_place_value	원산지정보 원산지가 "기타(1800)"일 경우 원산지로 입력 가능한 정보. ,(콤마)로 여러 건을 검색할 수 있다.
stock_quantity_max	재고수량 검색 최대값 재고가 해당 값 이하로 남아있는 상품 검색. 품목을 여러개 갖고 있는 상품의 경우 해당 조건에 해당하는 품목이 하나라도 있을 경우 검색함.
stock_quantity_min	재고수량 검색 최소값 재고가 해당 값 이상 남아있는 상품 검색. 품목을 여러개 갖고 있는 상품의 경우 해당 조건에 해당하는 품목이 하나라도 있을 경우 검색함.
stock_safety_max	안전재고수량 검색 최대값
stock_safety_min	안전재고수량 검색 최소값
product_weight	상품 중량 해당 중량의 상품 검색. ,(콤마)로 여러 건을 검색할 수 있다.
classification_code	자체분류 ,(콤마)로 여러 건을 검색할 수 있다.
use_inventory	재고 사용여부 해당 상품 품목이 재고를 사용하고 있는지 여부 T : 사용함 F : 사용안함
category_unapplied	미적용 분류 검색 분류가 등록되지 않은 상품에 대하여 검색함. T: 미적용 분류 검색
include_sub_category	하위분류 포함 검색 하위분류에 등록된 상품을 포함하여 검색함. T: 포함
additional_information_key	추가항목 검색조건 키 추가항목에 대하여 검색하기 위한 키. 검색을 위해선 key 와 value 모두 필요함.
additional_information_value	추가항목 검색조건 값 추가항목에 대하여 검색하기 위한 키의 값. 검색을 위해선 key 와 value 모두 필요함.
approve_status	승인상태 검색 N : 승인요청 (신규상품) 상태값 E : 승인요청 (상품수정) 상태값 C : 승인완료 상태값 R : 승인거절 상태값 I : 검수진행중 상태값
since_product_no 최소값: [0] 최대값: [2147483647]	해당 상품번호 이후 검색 특정 상품번호 이후의 상품들을 검색. 해당 검색조건 사용시 offset과 관계 없이 모든 상품을 검색할 수 있다. ※ 해당 검색 조건 사용시 다음 파라메터로는 사용할 수 없다. product_no sort order offset
sort	정렬 순서 값 created_date : 등록일 updated_date : 수정일 product_name : 상품명
order	정렬 순서 asc : 순차정렬 desc : 역순 정렬
offset 최대값: [5000]	조회결과 시작위치 조회결과 시작위치
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10

Definition Copy

Request example: Copy

Response example:

Count all products

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no	상품번호 조회하고자 하는 상품의 번호 ,(콤마)로 여러 건을 검색할 수 있다.
display	진열상태 진열 혹은 미진열 되어있는 상품 검색.
selling	판매상태 판매중이거나 판매안함 상태의 상품 검색.
product_name	상품명 검색어를 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
product_code	상품코드 상품 코드 ,(콤마)로 여러 건을 검색할 수 있다.
brand_code	브랜드 코드 브랜드 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
manufacturer_code	제조사 코드 제조사 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
supplier_code	공급사 코드 공급사 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
trend_code	트렌드 코드 트렌드 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
product_tag	상품 검색어 검색어를 상품 검색어 또는 태그에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
custom_product_code	자체상품 코드 검색어를 자체상품코드에 포함하고 있는 상품 검색(대소문자 구분 필요) ,(콤마)로 여러 건을 검색할 수 있다.
custom_variant_code	자체 품목 코드 ,(콤마)로 여러 건을 검색할 수 있다.
price_min	상품 판매가 검색 최소값 판매가가 해당 범위 이상인 상품 검색
price_max	상품 판매가 검색 최대값 판매가가 해당 범위 이하인 상품 검색
retail_price_min 최소값: [0] 최대값: [2147483647]	상품 소비자가 검색 최소값 소비자가가 해당 범위 이상인 상품 검색
retail_price_max 최소값: [0] 최대값: [2147483647]	상품 소비자가 검색 최대값 소비자가가 해당 범위 이하인 상품 검색
supply_price_min	상품 공급가 검색 최소값 공급가가 해당 범위 이하인 상품 검색
supply_price_max	상품 공급가 검색 최대값 공급가가 해당 범위 이상인 상품 검색
created_start_date timezone	상품 등록일 검색 시작일 상품 등록일이 해당 날짜 이후인 상품 검색. 등록일 검색 종료일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
created_end_date timezone	상품 등록일 검색 종료일 상품 등록일이 해당 날짜 이전인 상품 검색. 등록일 검색 시작일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
updated_start_date timezone	상품 수정일 검색 시작일 상품 수정일이 해당 날짜 이후인 상품 검색. 수정일 검색 종료일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
updated_end_date timezone	상품 수정일 검색 종료일 상품 수정일이 해당 날짜 이전인 상품 검색. 수정일 검색 시작일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
category	분류 번호 특정 분류에 진열된 상품 검색.
eng_product_name	영문 상품명 검색어를 영문 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
supply_product_name	공급사 상품명 검색어를 공급사 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
internal_product_name	상품명(관리용) ,(콤마)로 여러 건을 검색할 수 있다.
model_name	모델명 검색어를 모델명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
product_condition	상품 상태 특정 상품 상태 검색 ,(콤마)로 여러 건을 검색할 수 있다.
origin_place_value	원산지정보 원산지가 "기타(1800)"일 경우 원산지로 입력 가능한 정보. ,(콤마)로 여러 건을 검색할 수 있다.
stock_quantity_max	재고수량 검색 최대값 재고가 해당 값 이하로 남아있는 상품 검색. 품목을 여러개 갖고 있는 상품의 경우 해당 조건에 해당하는 품목이 하나라도 있을 경우 검색함.
stock_quantity_min	재고수량 검색 최소값 재고가 해당 값 이상 남아있는 상품 검색. 품목을 여러개 갖고 있는 상품의 경우 해당 조건에 해당하는 품목이 하나라도 있을 경우 검색함.
stock_safety_max	안전재고수량 검색 최대값
stock_safety_min	안전재고수량 검색 최소값
product_weight	상품 중량 해당 중량의 상품 검색. ,(콤마)로 여러 건을 검색할 수 있다.
classification_code	자체분류 자체분류 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
use_inventory	재고 사용여부 해당 상품 품목이 재고를 사용하고 있는지 여부 T : 사용함 F : 사용안함
category_unapplied	미적용 분류 검색 분류가 등록되지 않은 상품에 대하여 검색함. T: 미적용 분류 검색
include_sub_category	하위분류 포함 검색 하위분류에 등록된 상품을 포함하여 검색함. T: 포함
additional_information_key	추가항목 검색조건 키 추가항목에 대하여 검색하기 위한 키. 검색을 위해선 key 와 value 모두 필요함.
additional_information_value	추가항목 검색조건 값 추가항목에 대하여 검색하기 위한 키의 값. 검색을 위해선 key 와 value 모두 필요함.
approve_status	승인상태 검색 N : 승인요청 (신규상품) 상태값 E : 승인요청 (상품수정) 상태값 C : 승인완료 상태값 R : 승인거절 상태값 I : 검수진행중 상태값
since_product_no 최소값: [0] 최대값: [2147483647]	해당 상품번호 이후 검색 특정 상품번호 이후의 상품들을 검색. 해당 검색조건 사용시 offset과 관계 없이 모든 상품을 검색할 수 있다. ※ 해당 검색 조건 사용시 다음 파라메터로는 사용할 수 없다. product_no sort order offset

Definition Copy

Request example: Copy

Response example:

Get a product

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 조회하고자 하는 상품의 번호
variants embed	품목 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
memos embed	메모 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
hits embed	상품 조회수 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
seo embed	상품 Seo 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
tags embed	상품 태그 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
options embed	상품 옵션 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
discountprice embed	상품 할인판매가 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
decorationimages embed	꾸미기 이미지 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
benefits embed	혜택 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
additionalimages embed	추가 이미지 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.

Definition Copy

Request example: Copy

Response example:

Create a product

POST

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
display	진열상태 T : 진열함 F : 진열안함 DEFAULT F
selling	판매상태 T : 판매함 F : 판매안함 DEFAULT F
product_condition	상품 상태 N : 신상품 B : 반품상품 R : 재고상품 U : 중고상품 E : 전시상품 F : 리퍼상품 S : 스크래치 상품 DEFAULT N
product_used_month 최대값: [2147483647]	중고상품 사용 개월 상품 상태(product_condition)가 중고 상품일 경우 중고 상품의 사용 개월 수
add_category_no	추가 분류 번호 분류 번호를 사용하여 진열을 원하는 카테고리에 상품 등록
category_no 분류 번호 Required recommend 추천상품 분류 등록 여부 DEFAULT F T : 추천상품 등록 F : 추천상품 등록안함 new 신상품 분류 등록 여부 DEFAULT F T : 신상품 등록 F : 신상품 등록안함
custom_product_code 최대글자수 : [40자]	자체상품 코드 사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.
product_name Required 최대글자수 : [250자]	상품명
eng_product_name 최대글자수 : [250자]	영문 상품명
supply_product_name 최대글자수 : [250자]	공급사 상품명
internal_product_name 최대글자수 : [50자]	상품명(관리용)
model_name 최대글자수 : [100자]	모델명
price_excluding_tax 최소: [0]~최대: [2147483647]	상품가(세금 제외) 상품설정조회(GET:/products/setting) 에서 "판매가 계산 기준(calculate_price_based_on)"이 "B(상품가)"일 경우 Price가 아니라 price_excluding_tax를 입력해야한다.
price 최소: [0]~최대: [2147483647]	상품 판매가
retail_price 최소: [0]~최대: [2147483647]	상품 소비자가
supply_price Required 최소: [0]~최대: [2147483647]	상품 공급가 상품의 원가. 공급가에 마진율을 더하여 판매가를 계산할 수 있음. API에서는 공급가는 참조 목적으로만 사용한다.
has_option	옵션 사용여부 T : 옵션사용함 F : 옵션 사용안함 DEFAULT F
options	옵션
name 옵션명 Required value 옵션값 Required
use_naverpay	네이버페이 사용여부 EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함
naverpay_type	네이버페이 판매타입 EC 베트남, 필리핀 버전에서는 사용할 수 없음. C : 네이버페이 + 쇼핑몰 동시판매 상품 O : 네이버페이 전용상품
manufacturer_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	제조사 코드 DEFAULT M0000000
trend_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	트렌드 코드 DEFAULT T0000000
brand_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	브랜드 코드 DEFAULT B0000000
supplier_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	공급사 코드 DEFAULT S0000000
product_weight 최소: [0]~최대: [999999.99]	상품 중량
made_date	제조일자
release_date	출시일자
expiration_date 배열 최대사이즈: [2]	유효기간
start_date 유효기간 시작일 end_date 유효기간 종료일
description	상품상세설명
mobile_description	모바일 상품 상세설명 입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.
summary_description 최대글자수 : [255자]	상품요약설명
simple_description	상품 간략 설명
product_tag 최대글자수 : [200자]	상품 검색어
payment_info	상품결제안내
shipping_info	상품배송안내
exchange_info	교환/반품안내
service_info	서비스문의/안내
icon 배열 최대사이즈: [5]	아이콘
hscode 최대글자수 : [20자]	HS코드 배송정보(shipping_scope)가 B(국내/해외) 또는 C(해외배송)일 경우 필수 입력
shipping_scope	배송정보 국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. 상점관리 > 배송관리 > 배송/반품 설정에서 상품별 개별 배송료 설정이 사용안함인 경우 설정 불가. ※ 쇼핑몰이 EC Global 쇼핑몰일 경우 "C"를 필수로 입력해야한다. EC 베트남, 필리핀 버전에서는 사용할 수 없음. A : 국내배송 C : 해외배송 B : 국내/해외배송
shipping_method	배송방법 01 : 택배 02 : 빠른등기 03 : 일반등기 04 : 직접배송 05 : 퀵배송 06 : 기타 07 : 화물배송 08 : 매장직접수령 09 : 배송필요 없음
shipping_fee_by_product	개별배송여부 T : 개별배송 F : 기본배송 DEFAULT F
shipping_area 최대글자수 : [255자]	배송지역
shipping_period 배열 최대사이즈: [2]	배송기간
minimum 최소 기간 DEFAULT 1 maximum 최대 기간 DEFAULT 7
shipping_fee_type	배송비 타입 개별배송비를 사용할 경우 상품의 배송비 타입. T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과
shipping_rates 배열 최대사이즈: [200]	배송비 금액 개별배송비를 사용할 경우 상품의 개별 배송비. shipping_fee_type이 R, N일 경우 배열 안에 shipping_fee를 정의하여 배송비를 설정할 수 있다. shipping_fee_type이 M, D, W, C일 경우 배열 안에 다음과 같이 정의하여 배송비 구간을 설정할 수 있다. shipping_rates_min : 배송비 구간 시작 기준 shipping_rates_max : 배송비 구간 종료 기준 shipping_fee : 배송비
shipping_rates_min 배송비 구간 시작 기준 shipping_rates_max 배송비 구간 종료 기준 shipping_fee 배송비
prepaid_shipping_fee	배송비 선결제 설정 EC 베트남, 필리핀 버전에서는 사용할 수 없음. C : 착불 P : 선결제 B : 선결제/착불
clearance_category_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	해외통관코드 배송정보(shipping_scope)가 B(국내/해외) 또는 C(해외배송)일 경우 필수 입력 clearance_category_code
detail_image	상세이미지
list_image	목록이미지
tiny_image	작은목록이미지
small_image	축소이미지
image_upload_type	이미지 업로드 타입 이미지 업로드시 이미지 업로드 타입. "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드 "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드 ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음 A : 대표이미지등록 B : 개별이미지등록 C : 웹FTP 등록 DEFAULT A
additional_information	추가항목
key 추가항목 키 Required value 추가항목 값
price_content 최대글자수 : [20자]	판매가 대체문구
buy_limit_by_product	구매제한 개별 설정여부 T : 사용함 F : 사용안함 DEFAULT F
buy_limit_type	구매제한 N : 회원만 구매하며 구매버튼 감추기 M : 회원만 구매하며 구매버튼 보이기 F : 구매제한 안함 DEFAULT F
buy_group_list	구매가능 회원 등급
repurchase_restriction	재구매 제한 T : 재구매 불가 F : 제한안함 DEFAULT F
single_purchase_restriction	단독구매 제한 T : 단독구매 불가 F : 제한안함 DEFAULT F
buy_unit_type	구매단위 타입 해당 상품의 구매 단위를 1개 이상으로 설정한 경우 해당 구매 단위를 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 O : 품목 기준 DEFAULT O
buy_unit 최대값: [2147483647]	구매단위 DEFAULT 1
order_quantity_limit_type	주문수량 제한 기준 해당 상품의 주문 수량 제한시 제한 기준을 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 O : 품목 기준 DEFAULT O
minimum_quantity 최대값: [2147483647]	최소 주문수량 주문 가능한 최소한의 주문 수량. 주문 수량 미만으로 구매 할 수 없음. DEFAULT 1
maximum_quantity 최대값: [2147483647]	최대 주문수량 주문 가능한 최대한의 주문 수량. 주문 수량을 초과하여 구매 할 수 없음. 최대 주문수량을 "제한없음"으로 입력하려면 0을 입력
points_by_product	적립금 개별설정 사용여부 F : 기본설정 사용 T : 개별설정 DEFAULT F
points_setting_by_payment	결제방식별 적립금 설정 여부 B : 기본 적립금설정 사용 C : 결제방식에 따른 적립
points_amount	적립금 설정 정보
payment_method 적립금 결제방법 naverpay : 네이버페이 smilepay : 스마일페이 kakaopay : 카카오페이 payco : 페이코 paynow : 페이나우 kpay : 케이페이 icash : 가상계좌 결제 deposit : 예치금 결제 tcash : 실시간 계좌이체 cell : 휴대폰 결제 card : 카드 결제 mileage : 적립금 결제 cash : 무통장 입금 points_rate 적립율 points_unit_by_payment 결제방법별 적립금 단위 P : 퍼센트 단위 W : 원단위
except_member_points	회원등급 추가 적립 제외 T : 회원등급 추가 적립 제외 설정함 F : 회원등급 추가 적립 제외 설정안함 DEFAULT F
product_volume	상품 부피 정보
use_product_volume 상품부피 사용여부 product_width 가로 product_height 세로 product_length 높이
origin_classification	원산지 국내/국외/기타 F : 국내 T : 국외 E : 기타
origin_place_no	원산지 번호 원산지 번호를 List all Origin API를 통해 원산지를 조회하여 입력 origin_classification이 F(국내)인 경우, 해외 여부(foreign)가 "F"인 원산지만 입력 가능함. origin_classification이 T(해외)인 경우, 해외 여부(foreign)가 "T"인 원산지만 입력 가능함.
origin_place_value 최대글자수 : [30자]	원산지기타정보 원산지가 "기타(1800)"일 경우 원산지로 입력 가능한 정보.
made_in_code	원산지 국가코드 원산지 국가를 두자리 국가코드로 입력 원산지를 국가 단위로만 입력하는 경우 원산지 번호(origin_place_no)와 원산지 구분(origin_classification) 대신 사용 가능하다.
main	메인진열 상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.
relational_product 배열 최대사이즈: [200]	관련상품 해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.
product_no 상품번호 Required interrelated 관련상품 상호등록 여부 Required T : 상호등록 F : 일방등록
product_material	상품소재 상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)
english_product_material	영문 상품 소재 상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.
cloth_fabric	옷감 상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음. woven : 직물(woven) knit : 편물(knit)
classification_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	자체분류
additional_price 최대값: [2147483647]	판매가 추가금액 판매가 계산시 상품의 원가와 마진율에 더하여 추가로 계산되는 금액. API에서 해당 금액은 참고 목적으로만 사용된다.
margin_rate 최소: [-999.99]~최대: [999.99]	마진률 상품의 원가에 더하여 판매가 계산을 위한 마진율. Api에서는 해당 값은 참고용으로만 사용된다.
tax_type	과세 구분 해당 상품의 과세 정보. 해당 상품의 부가세 포함 유형. 과세상품 = 세금이 부과된 상품. 면세상품 = 세금이 면제되는 상품. 가공되지 않은 농/수/축산물, 연탄, 도서류, 보험, 여성용품 등의 상품이 이에 해당하며, 과세사업자로 등록해야 함 영세상품 = 부가세가 0%로 적용되는 수출용 외화 획득 상품 A : 과세상품 B : 면세 상품 C : 영세상품 DEFAULT A
tax_amount 최소: [0]~최대: [100]	과세율 과세상품인 경우, 해당 상품에 적용되는 부가세율을 명시함. 부가세는 국가 및 지역에 따라 상이할 수 있음.
additional_image	추가이미지 상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다. 추가이미지는 최대 20개까지 등록 가능하다.
adult_certification	성인인증 성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함. 상점관리>운영관리>운영방식설정>회원관련설정>성인인증 사용 시 구매차단 설정이 설정되어야 성인인증이 적용된다. EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함 DEFAULT F
exposure_limit_type	표시제한 범위 A : 모두에게 표시 M : 회원에게만 표시 DEFAULT A
exposure_group_list	표시대상 회원 등급

Definition Copy

Request example: Copy

Response example:

Update a product

PUT

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
display	진열상태 상품을 쇼핑몰에 진열할지 여부 변경. T : 진열함 F : 진열안함
selling	판매상태 T : 판매함 F : 판매안함
product_condition	상품 상태 N : 신상품 B : 반품상품 R : 재고상품 U : 중고상품 E : 전시상품 F : 리퍼상품 S : 스크래치 상품
product_used_month 최대값: [2147483647]	중고상품 사용 개월 상품 상태(product_condition)가 중고 상품일 경우 중고 상품의 사용 개월 수
add_category_no	추가 분류 번호 상품분류 번호를 입력하여 해당 상품에 특정 상품분류를 추가 등록
category_no 분류 번호 Required recommend 추천상품 분류 등록 여부 DEFAULT F T : 추천상품 등록 F : 추천상품 등록안함 new 신상품 분류 등록 여부 DEFAULT F T : 신상품 등록 F : 신상품 등록안함
delete_category_no	삭제 분류 번호 상품분류 번호를 입력하여 해당 상품에 특정 상품분류 삭제
custom_product_code 최대글자수 : [40자]	자체상품 코드 사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.
product_name 최대글자수 : [250자]	상품명
eng_product_name 최대글자수 : [250자]	영문 상품명
supply_product_name 최대글자수 : [250자]	공급사 상품명
internal_product_name 최대글자수 : [50자]	상품명(관리용)
model_name 최대글자수 : [100자]	모델명
price_excluding_tax 최소: [0]~최대: [2147483647]	상품가(세금 제외) 상품설정조회(GET:/products/setting) 에서 "판매가 계산 기준(calculate_price_based_on)"이 "B(상품가)"일 경우 Price가 아니라 price_excluding_tax를 입력해야한다.
price 최소: [0]~최대: [2147483647]	상품 판매가
retail_price 최소: [0]~최대: [2147483647]	상품 소비자가
supply_price 최소: [0]~최대: [2147483647]	상품 공급가 상품의 원가. 공급가에 마진율을 더하여 판매가를 계산할 수 있음. API에서는 공급가는 참조 목적으로만 사용한다.
has_option	옵션 사용여부 F : 옵션 사용안함
use_naverpay	네이버페이 사용여부 EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함
naverpay_type	네이버페이 판매타입 EC 베트남, 필리핀 버전에서는 사용할 수 없음. C : 네이버페이 + 쇼핑몰 동시판매 상품 O : 네이버페이 전용상품
manufacturer_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	제조사 코드
trend_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	트렌드 코드
brand_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	브랜드 코드
supplier_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	공급사 코드
product_weight 최소: [0]~최대: [999999.99]	상품 중량
made_date	제조일자
release_date	출시일자
expiration_date 배열 최대사이즈: [2]	유효기간
start_date 유효기간 시작일 end_date 유효기간 종료일
description	상품상세설명
mobile_description	모바일 상품 상세설명 입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.
summary_description 최대글자수 : [255자]	상품요약설명
simple_description	상품 간략 설명
product_tag 최대글자수 : [200자]	상품 검색어
payment_info	상품결제안내
shipping_info	상품배송안내
exchange_info	교환/반품안내
service_info	서비스문의/안내
icon 배열 최대사이즈: [5]	아이콘
use_icon_exposure_term	표시기간 사용 여부 T : 사용함 F : 사용안함
icon_exposure_begin_datetime	표시기간 시작 일자
icon_exposure_end_datetime	표시기간 종료 일자
hscode 최대글자수 : [20자]	HS코드 배송정보(shipping_scope)가 B(국내/해외) 또는 C(해외배송)일 경우 필수 입력
shipping_scope	배송정보 국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. 상점관리 > 배송관리 > 배송/반품 설정에서 상품별 개별 배송료 설정이 사용안함인 경우 설정 불가. EC 베트남, 필리핀 버전에서는 사용할 수 없음. A : 국내배송 C : 해외배송 B : 국내/해외배송
shipping_method	배송방법 01 : 택배 02 : 빠른등기 03 : 일반등기 04 : 직접배송 05 : 퀵배송 06 : 기타 07 : 화물배송 08 : 매장직접수령 09 : 배송필요 없음
shipping_fee_by_product	개별배송여부 T : 개별배송 F : 기본배송
shipping_area 최대글자수 : [255자]	배송지역
shipping_period	배송기간
minimum 최소 기간 DEFAULT 1 maximum 최대 기간 DEFAULT 7
shipping_fee_type	배송비 타입 개별배송비를 사용할 경우 상품의 배송비 타입. T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과
shipping_rates 배열 최대사이즈: [200]	배송비 금액 개별배송비를 사용할 경우 상품의 개별 배송비. shipping_fee_type이 R, N일 경우 배열 안에 shipping_fee를 정의하여 배송비를 설정할 수 있다. shipping_fee_type이 M, D, W, C일 경우 배열 안에 다음과 같이 정의하여 배송비 구간을 설정할 수 있다. shipping_rates_min : 배송비 구간 시작 기준 shipping_rates_max : 배송비 구간 종료 기준 shipping_fee : 배송비
shipping_rates_min 배송비 구간 시작 기준 shipping_rates_max 배송비 구간 종료 기준 shipping_fee 배송비
prepaid_shipping_fee	배송비 선결제 설정 EC 베트남, 필리핀 버전에서는 사용할 수 없음. C : 착불 P : 선결제 B : 선결제/착불
clearance_category_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	해외통관코드 배송정보(shipping_scope)가 B(국내/해외) 또는 C(해외배송)일 경우 필수 입력 clearance_category_code
detail_image	상세이미지
list_image	목록이미지
tiny_image	작은목록이미지
small_image	축소이미지
image_upload_type	이미지 업로드 타입 이미지 업로드시 이미지 업로드 타입. "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드 "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드 ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음 A : 대표이미지등록 B : 개별이미지등록 C : 웹FTP 등록
additional_information	추가항목
key 추가항목 키 Required value 추가항목 값
price_content 최대글자수 : [20자]	판매가 대체문구
buy_limit_by_product	구매제한 개별 설정여부 T : 사용함 F : 사용안함
buy_limit_type	구매제한 N : 회원만 구매하며 구매버튼 감추기 M : 회원만 구매하며 구매버튼 보이기 F : 구매제한 안함
buy_group_list	구매가능 회원 등급
repurchase_restriction	재구매 제한 T : 재구매 불가 F : 제한안함
single_purchase_restriction	단독구매 제한 T : 단독구매 불가 F : 제한안함
buy_unit_type	구매단위 타입 해당 상품의 구매 단위를 1개 이상으로 설정한 경우 해당 구매 단위를 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 O : 품목 기준
buy_unit 최대값: [2147483647]	구매단위
order_quantity_limit_type	주문수량 제한 기준 해당 상품의 주문 수량 제한시 제한 기준을 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 O : 품목 기준
minimum_quantity 최대값: [2147483647]	최소 주문수량
maximum_quantity 최대값: [2147483647]	최대 주문수량 주문 가능한 최대한의 주문 수량. 주문 수량을 초과하여 구매 할 수 없음. 최대 주문수량을 "제한없음"으로 입력하려면 0을 입력 최소주문수량 수정시 최대주문수량을 같이 수정해야한다.
points_by_product	적립금 개별설정 사용여부 F : 기본설정 사용 T : 개별설정
points_setting_by_payment	결제방식별 적립금 설정 여부 B : 기본 적립금설정 사용 C : 결제방식에 따른 적립
points_amount	적립금 설정 정보
payment_method 적립금 결제방법 naverpay : 네이버페이 smilepay : 스마일페이 kakaopay : 카카오페이 payco : 페이코 paynow : 페이나우 kpay : 케이페이 icash : 가상계좌 결제 deposit : 예치금 결제 tcash : 실시간 계좌이체 cell : 휴대폰 결제 card : 카드 결제 mileage : 적립금 결제 cash : 무통장 입금 points_rate 적립율 points_unit_by_payment 결제방법별 적립금 단위 P : 퍼센트 단위 W : 원단위
except_member_points	회원등급 추가 적립 제외 T : 회원등급 추가 적립 제외 설정함 F : 회원등급 추가 적립 제외 설정안함
product_volume	상품 부피 정보
use_product_volume 상품부피 사용여부 product_width 가로 product_height 세로 product_length 높이
origin_classification	원산지 국내/국외/기타 F : 국내 T : 국외 E : 기타
origin_place_no	원산지 번호 원산지 번호를 List all Origin API를 통해 원산지를 조회하여 입력 origin_classification이 F(국내)인 경우, 해외 여부(foreign)가 "F"인 원산지만 입력 가능함. origin_classification이 T(해외)인 경우, 해외 여부(foreign)가 "T"인 원산지만 입력 가능함.
origin_place_value 최대글자수 : [30자]	원산지기타정보 원산지가 "기타(1800)"일 경우 원산지로 입력 가능한 정보.
made_in_code	원산지 국가코드 원산지 국가를 두자리 국가코드로 입력 원산지를 국가 단위로만 입력하는 경우 원산지 번호(origin_place_no)와 원산지 구분(origin_classification) 대신 사용 가능하다.
main	메인진열 상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.
relational_product 배열 최대사이즈: [200]	관련상품 해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.
product_no 상품번호 interrelated 관련상품 상호등록 여부 Required T : 상호등록 F : 일방등록
product_material	상품소재 상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)
english_product_material	영문 상품 소재 상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.
cloth_fabric	옷감 상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음. woven : 직물(woven) knit : 편물(knit)
classification_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	자체분류
additional_price 최대값: [2147483647]	판매가 추가금액 판매가 계산시 상품의 원가와 마진율에 더하여 추가로 계산되는 금액. API에서 해당 금액은 참고 목적으로만 사용된다.
margin_rate 최소: [-999.99]~최대: [999.99]	마진률 상품의 원가에 더하여 판매가 계산을 위한 마진율. Api에서는 해당 값은 참고용으로만 사용된다.
tax_type	과세 구분 해당 상품의 과세 정보. 해당 상품의 부가세 포함 유형. 과세상품 = 세금이 부과된 상품. 면세상품 = 세금이 면제되는 상품. 가공되지 않은 농/수/축산물, 연탄, 도서류, 보험, 여성용품 등의 상품이 이에 해당하며, 과세사업자로 등록해야 함 영세상품 = 부가세가 0%로 적용되는 수출용 외화 획득 상품 A : 과세상품 B : 면세 상품 C : 영세상품
tax_amount 최소: [0]~최대: [100]	과세율 과세상품인 경우, 해당 상품에 적용되는 부가세율을 명시함. 부가세는 국가 및 지역에 따라 상이할 수 있음.
additional_image	추가이미지 상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다. 추가이미지는 최대 20개까지 등록 가능하다.
adult_certification	성인인증 성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함. 상점관리>운영관리>운영방식설정>회원관련설정>성인인증 사용 시 구매차단 설정이 설정되어야 성인인증이 적용된다. EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함
exposure_limit_type	표시제한 범위 A : 모두에게 표시 M : 회원에게만 표시
exposure_group_list	표시대상 회원 등급

Definition Copy

Request example: Copy

Response example:

Delete a product

DELETE

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Definition Copy

Request example: Copy

Response example:

Products additionalimages

상품 추가 이미지(Products additionalimages)는 상품의 추가이미지를 조회할 수 있는 하위 리소스로, 상품(Products)리소스의 하위에서만 사용할 수 있습니다.

Endpoints

POST /api/v2/admin/products/{product_no}/additionalimages
PUT /api/v2/admin/products/{product_no}/additionalimages

Products additionalimages properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
additional_image	추가이미지

Create a products additionalimage

POST

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

additional_image
Required

추가이미지

● 최대요청건수 : 20개
● 이미지 파일 용량 제한 : 5MB
● 한 호출당 이미지 전체 용량 제한 : 30MB

Definition Copy

Request example: Copy

Response example:

Update a products additionalimage

PUT

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

additional_image
Required

추가이미지

● 최대요청건수 : 20개
● 이미지 파일 용량 제한 : 5MB
● 한 호출당 이미지 전체 용량 제한 : 30MB

Definition Copy

Request example: Copy

Response example:

Products approve

공급사의 상품 승인 기능을 사용중인 몰에서만 사용할 수 있는 API입니다.

Endpoints

GET /api/v2/admin/products/{product_no}/approve
POST /api/v2/admin/products/{product_no}/approve
PUT /api/v2/admin/products/{product_no}/approve

Products approve properties

Attribute

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

status
Required

상태

공급사가 승인 요청한 해당 상품의 승인 상태

N : 승인요청 (신규상품) 상태값
E : 승인요청 (상품수정) 상태값
C : 승인완료 상태값
R : 승인거절 상태값
I : 검수진행중 상태값
Empty Value : 요청된적 없음

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

Get products approve status

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

Definition Copy

Request example: Copy

Response example:

Create a products approve

POST

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

user_id
Required

공급사 운영자 아이디

승인 요청한 공급사의 아이디

Definition Copy

Request example: Copy

Response example:

Update a products approve

PUT

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.
user_id Required	공급사 운영자 아이디 승인 요청한 공급사의 아이디
status Required	상태 공급사가 승인 요청한 해당 상품의 승인 상태 C : 승인완료 상태값 R : 승인거절 상태값 I : 검수진행중 상태값

Definition Copy

Request example: Copy

Response example:

Products decorationimages

꾸미기 이미지(Decorationimages)는 쇼핑몰에 진열된 상품 이미지 위에 추가하여 상품에 포인트를 줄 수 있는 기능입니다. 쇼핑몰에 등록되어있는 꾸미기 이미지를 조회하여 상품별로 꾸미기 이미지를 지정하거나 상품에 등록되어있는 꾸미기 이미지를 조회할 수 있습니다.

꾸미기 이미지는 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/products/decorationimages
GET /api/v2/admin/products/{product_no}/decorationimages
POST /api/v2/admin/products/{product_no}/decorationimages
PUT /api/v2/admin/products/{product_no}/decorationimages
DELETE /api/v2/admin/products/{product_no}/decorationimages/{code}

Products decorationimages properties

Attribute	Description
code	꾸미기 이미지 코드
path	꾸미기 이미지 URL
shop_no	멀티쇼핑몰 번호
use_show_date	표시기간 사용 여부 T : 사용함 F : 사용안함
show_start_date timezone	표시기간 시작 일자
show_end_date timezone	표시기간 종료 일자
image_list	꾸미기 이미지 리스트

List all decoration images

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

Definition Copy

Request example: Copy

Response example:

List all products decoration images

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Definition Copy

Request example: Copy

Response example:

Select decoration images to a product

POST

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호
use_show_date	표시기간 사용 여부 T : 사용함 F : 사용안함
show_start_date 날짜 timezone	표시기간 시작 일자
show_end_date 날짜 timezone	표시기간 종료 일자
image_list Required	꾸미기 이미지 리스트
code 꾸미기 이미지 코드 path 꾸미기 이미지 경로 image_horizontal_position 꾸미기 이미지 수평값 image_vertical_position 꾸미기 이미지 수직값

Definition Copy

Request example: Copy

Response example:

Update a decoration images to a product

PUT

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
use_show_date	표시기간 사용 여부 T : 사용함 F : 사용안함
show_start_date 날짜 timezone	표시기간 시작 일자
show_end_date 날짜 timezone	표시기간 종료 일자
image_list Required	꾸미기 이미지 리스트
code 꾸미기 이미지 코드 path 꾸미기 이미지 경로 image_horizontal_position 꾸미기 이미지 수평값 image_vertical_position 꾸미기 이미지 수직값

Definition Copy

Request example: Copy

Response example:

Deselect a decoration images to a product

DELETE

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

code
Required

꾸미기 이미지 코드

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Definition Copy

Request example: Copy

Response example:

Products discountprice

상품 할인가(Discountprice)는 상품의 할인가격을 표시하는 리소스입니다. 혜택(Benefits)이 적용된 상품의 경우 상품의 할인가를 조회할 수 있습니다.

상품 할인가는 하위 리소스로서 상품(Products) 하위에서만 사용가능합니다. 상품 목록 조회시 Embed 파라메터로 호출하여 상품의 할인가를 같이 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/products/{product_no}/discountprice

Products discountprice properties

Attribute	Description
pc_discount_price	PC 할인 판매가
mobile_discount_price	모바일 할인 판매가

List all products discountprice

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

Definition Copy

Request example: Copy

Response example:

Products hits

상품 조회수(Hits)는 상품을 쇼핑몰 고객들이 얼마나 조회했는지를 나타내는 지표입니다. 상품 조회수를 확인하여 고객들이 어떤 상품을 가장 많이 조회하는지 알 수 있습니다.
상품 조회수는 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/products/{product_no}/hits/count

Count all products hits

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

Definition Copy

Request example: Copy

Response example:

Products icons

상품 아이콘은 상품을 강조하기 위해 상품 옆에 추가할 수 있는 작은 이미지들입니다. 진열된 상품에 할인 정보, "매진 임박" 등의 메시지를 추가하여 상품을 강조할 수 있습니다.
상품 아이콘는 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/products/icons
GET /api/v2/admin/products/{product_no}/icons
POST /api/v2/admin/products/{product_no}/icons
PUT /api/v2/admin/products/{product_no}/icons
DELETE /api/v2/admin/products/{product_no}/icons/{code}

Products icons properties

Attribute	Description
code	상품 아이콘 코드
path	아이콘 URL
shop_no	멀티쇼핑몰 번호
use_show_date	표시기간 사용 여부 T : 사용함 F : 사용안함
show_start_date timezone	표시기간 시작 일자
show_end_date timezone	표시기간 종료 일자
image_list	상품 아이콘 리스트

List all icons

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

Definition Copy

Request example: Copy

Response example:

List all products icons

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Definition Copy

Request example: Copy

Response example:

Select product icons to a product

POST

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
product_no Required	상품번호
image_list Required 배열 최대사이즈: [5]	상품 아이콘 리스트
code 상품 아이콘 코드 Required

Definition Copy

Request example: Copy

Response example:

Update a product icons to a product

PUT

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
product_no Required	상품번호
use_show_date	표시기간 사용 여부 T : 사용함 F : 사용안함
show_start_date 날짜 timezone	표시기간 시작 일자
show_end_date 날짜 timezone	표시기간 종료 일자
image_list 배열 최대사이즈: [5]	상품 아이콘 리스트
code 상품 아이콘 코드 Required

Definition Copy

Request example: Copy

Response example:

Deselect a product icons to a product

DELETE

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

code
Required

상품 아이콘 코드

Definition Copy

Request example: Copy

Response example:

Products images

상품 이미지(Products Images)는 상품의 판매를 위해서 업로드한 상품의 사진이나 그림을 의미합니다. 상품 이미지 API를 사용해 상품 상세설명에서 사용할 이미지를 업로드하거나, 상품의 이미지를 업로드할 수 있습니다.
상품의 이미지는 Base64 코드 로 인코딩하여 업로드할 수 있습니다.

Endpoints

POST /api/v2/admin/products/images
POST /api/v2/admin/products/{product_no}/images
DELETE /api/v2/admin/products/{product_no}/images

Products images properties

Attribute	Description
path	상세이미지
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
product_no	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
detail_image	상세이미지 상품 상세 화면에 표시되는 상품 이미지.
list_image	목록이미지 상품 분류 화면, 메인 화면, 상품 검색 화면에 표시되는 상품의 목록 이미지.
tiny_image	작은목록이미지 상품 상세 화면 하단에 표시되는 상품 목록 이미지.
small_image	축소이미지 최근 본 상품 영역에 표시되는 상품의 목록 이미지.

Upload Images

POST

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	20

요청사양

Parameter

Description

image
Required

상세이미지

상품 상세 화면에 표시되는 상품 이미지.

● 이미지 파일 용량 제한 : 5MB
● 한 호출당 이미지 전체 용량 제한 : 30MB

Definition Copy

Request example: Copy

Response example:

Upload product images

POST

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
detail_image	상세이미지 상품 상세 화면에 표시되는 상품 이미지.
list_image	목록이미지 상품 분류 화면, 메인 화면, 상품 검색 화면에 표시되는 상품의 목록 이미지.
tiny_image	작은목록이미지 상품 상세 화면 하단에 표시되는 상품 목록 이미지.
small_image	축소이미지 최근 본 상품 영역에 표시되는 상품의 목록 이미지.
image_upload_type Required	이미지 업로드 타입 이미지 타입이 대표 이미지 인지, 개별 이미지 인지 업로드 타입을 지정할 수 있음. 대표 이미지(A)로 업로드 하는 경우 상세이미지(detail_image)에 이미지를 업로드하면 다른 나머지 이미지에도 모두 반영됨. A : 대표이미지등록 B : 개별이미지등록

Definition Copy

Request example: Copy

Response example:

Delete a products image

DELETE

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

Definition Copy

Request example: Copy

Response example:

Products memos

상품 메모는 상품에 간략하게 남길 수 있는 메모로서 상품에 관한 특이사항을 메모하거나 운영자 간의 의사소통을 위한 도구로 활용할 수 있습니다.
상품 메모는 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/products/{product_no}/memos
GET /api/v2/admin/products/{product_no}/memos/{memo_no}
POST /api/v2/admin/products/{product_no}/memos
PUT /api/v2/admin/products/{product_no}/memos/{memo_no}
DELETE /api/v2/admin/products/{product_no}/memos/{memo_no}

Products memos properties

Attribute	Description
memo_no	메모 번호 시스템에서 부여한 상품 메모의 고유한 번호. 상품 메모 번호는 쇼핑몰 내에서 중복되지 않는다.
author_id 최대글자수 : [20자]	작성자 아이디 메모를 작성한 관리자의 아이디 정보.
created_date timezone	생성일 메모를 작성한 시간.
memo	메모 메모의 내용. HTML을 사용하여 등록할 수 있다.

List all products memos

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

limit

최소: [1]~최대: [100]

조회결과 최대건수

조회하고자 하는 최대 건수를 지정할 수 있음.
예) 10 입력시 10건만 표시함.

DEFAULT 10

offset

최대값: [8000]

조회결과 시작위치

Definition Copy

Request example: Copy

Response example:

Get a products memo

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

memo_no
Required

메모 번호

시스템에서 부여한 상품 메모의 고유한 번호. 상품 메모 번호는 쇼핑몰 내에서 중복되지 않는다.

Definition Copy

Request example: Copy

Response example:

Create a products memo

POST

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

author_id
Required

최대글자수 : [20자]

작성자 아이디

메모를 작성한 관리자의 아이디 정보.

memo
Required

메모

메모의 내용. HTML을 사용하여 등록할 수 있다.

Definition Copy

Request example: Copy

Response example:

Update a products memo

PUT

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
product_no Required	상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.
memo_no Required	메모 번호 시스템에서 부여한 상품 메모의 고유한 번호. 상품 메모 번호는 쇼핑몰 내에서 중복되지 않는다.
author_id Required 최대글자수 : [20자]	작성자 아이디 메모를 작성한 관리자의 아이디 정보.
memo Required	메모 메모의 내용. HTML을 사용하여 등록할 수 있다.

Definition Copy

Request example: Copy

Response example:

Delete a products memo

DELETE

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

memo_no
Required

메모 번호

시스템에서 부여한 상품 메모의 고유한 번호. 상품 메모 번호는 쇼핑몰 내에서 중복되지 않는다.

Definition Copy

Request example: Copy

Response example:

Products options

옵션(Options)은 상품이 다른 색상이나 사이즈를 갖고 있는 경우 고객이 선택하여 구매할 수 있도록 하는 기능입니다. 옵션은 색상, 사이즈 같은 옵션명(option_name)과 색상 중 빨간색, 노란색과 같은 옵션값(option_value)으로 구성되어있습니다. 상품에 옵션 등록시 옵션을 기반으로 품목(variants)이 생성됩니다.

옵션은 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/products/{product_no}/options
POST /api/v2/admin/products/{product_no}/options
PUT /api/v2/admin/products/{product_no}/options
DELETE /api/v2/admin/products/{product_no}/options

Products options properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
has_option	옵션 사용여부 T : 사용함 F : 사용안함
option_type	옵션 구성방식 옵션을 사용할 경우, 옵션의 유형 표시 ● 조합형 : 옵션명을 기준으로 옵션값을 조합할 수 있음 ● 상품 연동형 : 옵션표시방식은 조합형과 유사하지만 필수옵션과 선택옵션을 선택할 수 있음. 옵션의 조합을 제한 없이 생성할 수 있음. ● 독립 선택형 : 독립적인 조건 여러개를 각각 선택할 수 있는 옵션으로 옵션 값이 조합되지 않고 각각의 품목으로 생성됨. T : 조합형 E : 연동형 F : 독립형
option_list_type	옵션 표시방식 조합형 옵션을 사용할 경우, 조합형 옵션의 유형 표시 * 조합 일체선택형 : 하나의 셀렉스박스(버튼 이나 라디오버튼)에 모든 옵션이 조합되어 표시됨 * 조합 분리선택형 : 옵션을 각각의 셀렉스박스(버튼 이나 라디오버튼)로 선택할 수 있으며 옵션명을 기준으로 옵션값을 조합할 수 있음 독립형이나 상품 연동형 옵션을 사용하고 있을 경우 S(분리형)로 입력됨. C : 일체형 S : 분리형
option_preset_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	옵션세트 코드 상품연동형 옵션을 사용할 경우, 옵션 세트 코드 표시
options	옵션
select_one_by_option	옵션별로 한 개씩 선택 (독립형 옵션) 독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함. T : 사용함 F : 사용안함
option_preset_name	연동형 옵션 세트명 상품연동형 옵션을 사용할 경우, 옵션 세트의 이름 표시
use_additional_option	추가입력 옵션 사용여부 T : 사용함 F : 사용안함
additional_options	추가입력 옵션
use_attached_file_option	파일 첨부 옵션 사용여부 T : 사용함 F : 사용안함
attached_file_option	파일 첨부 옵션

List all products options

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Definition Copy

Request example: Copy

Response example:

Create a products option

POST

상품 옵션 등록 API를 통해 옵션을 등록할 수 있습니다. 옵션 등록 API로 옵션을 등록하면 품목은 자동으로 생성됩니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
has_option	옵션 사용여부 T : 사용함 F : 사용안함
option_type	옵션 구성방식 옵션을 사용할 경우, 옵션의 유형 입력 ● 조합형 : 옵션명을 기준으로 옵션값을 조합할 수 있음 ● 상품 연동형 : 옵션표시방식은 조합형과 유사하지만 필수옵션과 선택옵션을 선택할 수 있음. 옵션의 조합을 제한 없이 생성할 수 있음. ● 독립 선택형 : 독립적인 조건 여러개를 각각 선택할 수 있는 옵션으로 옵션 값이 조합되지 않고 각각의 품목으로 생성됨. T : 조합형 E : 연동형 F : 독립형
option_list_type	옵션 표시방식 조합형 옵션을 사용할 경우, 조합형 옵션의 유형 입력 * 조합 일체선택형 : 하나의 셀렉스박스(버튼 이나 라디오버튼)에 모든 옵션이 조합되어 표시됨 * 조합 분리선택형 : 옵션을 각각의 셀렉스박스(버튼 이나 라디오버튼)로 선택할 수 있으며 옵션명을 기준으로 옵션값을 조합할 수 있음 독립형이나 상품 연동형 옵션을 사용하고 있을 경우 S(분리형)로 입력됨. S : 조합 분리선택형 C : 조합 일체선택형
options	옵션
option_name 옵션명 Required option_value Array 옵션값 Required option_text 옵션값 option_image_file 옵션 버튼 이미지 option_color 컬러칩 색상 option_display_type 옵션 표시방식 DEFAULT S S : 셀렉트박스 P : 미리보기 B : 텍스트버튼 R : 라디오버튼
select_one_by_option	옵션별로 한 개씩 선택 (독립형 옵션) 독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함. T : 사용함 F : 사용안함 독립형에만 존재 체크시 옵션별로 한개씩 선택 값 처리
option_preset_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	옵션세트 코드
option_preset_name	연동형 옵션 세트명 상품연동형 옵션을 사용할 경우, 옵션 세트의 이름 입력
use_additional_option	추가입력 옵션 사용여부 T : 사용함 F : 사용안함
additional_options	추가입력 옵션
additional_option_name 추가입력옵션명 Required additional_option_text_length 추가입력옵션 길이제한 Required 1~30 50 100 200 required_additional_option 추가입력옵션 필수 여부 Required DEFAULT T T : 필수 F : 선택
use_attached_file_option	파일 첨부 옵션 사용여부 T : 사용함 F : 사용안함
attached_file_option	파일 첨부 옵션

Definition Copy

Request example: Copy

Response example:

Update a products option

PUT

상품 옵션 수정 API는 옵션을 수정하면서 품목을 초기화하지 않습니다. 옵션명과 옵션값, 추가입력 옵션과 파일첨부 옵션의 수정만 가능하며, 옵션 항목을 추가하거나 삭제할 수는 없습니다.

옵션을 추가하거나 삭제하고 싶을 경우에는 옵션 삭제 API로 삭제하신 다음, 다시 등록하셔야 합니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
option_list_type	옵션 표시방식 조합형 옵션을 사용할 경우, 조합형 옵션의 유형 입력 * 조합 일체선택형 : 하나의 셀렉스박스(버튼 이나 라디오버튼)에 모든 옵션이 조합되어 표시됨 * 조합 분리선택형 : 옵션을 각각의 셀렉스박스(버튼 이나 라디오버튼)로 선택할 수 있으며 옵션명을 기준으로 옵션값을 조합할 수 있음 독립형이나 상품 연동형 옵션을 사용하고 있을 경우 S(분리형)로 입력됨. S : 조합 분리선택형 C : 조합 일체선택형
option_preset_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	옵션세트 코드 상품연동형 옵션을 사용할 경우, 옵션 세트 코드 입력
options	옵션
option_name 옵션명 Required option_value Array 옵션값 option_text 옵션값 option_image_file 옵션 버튼 이미지 option_link_image 옵션 연결 이미지 option_color 컬러칩 색상 option_display_type 옵션 표시방식 DEFAULT S S : 셀렉트박스 P : 미리보기 B : 텍스트버튼 R : 라디오버튼
original_options	수정되기전 옵션값
option_name 옵션명 Required option_value Array 옵션값 Required option_text 옵션값
select_one_by_option	옵션별로 한 개씩 선택 (독립형 옵션) 독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함. T : 사용함 F : 사용안함 독립형에만 존재 체크시 옵션별로 한개씩 선택 값 처리
option_preset_name	연동형 옵션 세트명 상품연동형 옵션을 사용할 경우, 옵션 세트의 이름 입력
use_additional_option	추가입력 옵션 사용여부 T : 사용함 F : 사용안함
additional_options	추가입력 옵션
additional_option_name 추가입력옵션명 Required additional_option_text_length 추가입력옵션 길이제한 Required 1~30 50 100 200 required_additional_option 추가입력옵션 필수 여부 Required DEFAULT T T : 필수 F : 선택
use_attached_file_option	파일 첨부 옵션 사용여부 T : 사용함 F : 사용안함
attached_file_option	파일 첨부 옵션

Definition Copy

Request example: Copy

Response example:

Delete a products option

DELETE

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Definition Copy

Request example: Copy

Response example:

Products seo

SEO는 검색엔진 최적화(Search Engine Optimization)의 약자로서 SEO API는 검색엔진에 상품이나 쇼핑몰이 더 잘 검색될 수 있도록 할 수 있습니다.
상품의 하위 리소스로서 SEO API는 해당 상품의 검색엔진 최적화 설정을 할 수 있습니다.

Endpoints

GET /api/v2/admin/products/{product_no}/seo
PUT /api/v2/admin/products/{product_no}/seo

Products seo properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
meta_title	브라우저 타이틀 해당 상품의 상품 상세 페이지의 Title 태그에 표시되는 정보. Title 태그는 브라우저에 표시되는 정보로 검색엔진에서 검색시 가장 기본적인 정보이다.
meta_author	메타태그1 : Author 해당 상품의 상품 상세 페이지의 태그에 표시되는 정보. author 메타 태그에는 해당 상품을 제조한 사람 또는 등록한 사람을 기입한다.
meta_description	메타태그2 : Description 해당 상품의 상품 상세 페이지의 태그에 표시되는 정보. description 태그에 검색 결과 페이지에서 검색 결과 아래에 표시될 간략한 정보를 입력할 수 있다.
meta_keywords	메타태그3 : Keywords 해당 상품의 상품 상세 페이지의 태그에 표시되는 정보. keyword 태그에 해당 상품이 검색되었으면 하는 검색 키워드를 입력할 수 있다.
meta_alt	상품 이미지 Alt 텍스트 상품 이미지에 표시되는 Alt 텍스트 정보. Alt 텍스트를 입력해놓으면 검색엔진에서 이미지 검색시 검색될 가능성이 높아지며, 브라우저에서 이미지 대신 해당 텍스트를 출력할 수 있어 웹 접근성에도 유리하다.
search_engine_exposure	검색 엔진 노출 설정 해당 상품을 검색엔진에 노출할 것인지 설정. '노출안함'으로 설정할 경우 해당 상품이 검색엔진에 노출되지 않는다. T : 사용함 F : 사용안함

Get products seo

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

Definition Copy

Request example: Copy

Response example:

Update a products seo

PUT

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.
meta_title	브라우저 타이틀 해당 상품의 상품 상세 페이지의 Title 태그에 표시되는 정보. Title 태그는 브라우저에 표시되는 정보로 검색엔진에서 검색시 가장 기본적인 정보이다.
meta_author	메타태그1 : Author 해당 상품의 상품 상세 페이지의 태그에 표시되는 정보. author 메타 태그에는 해당 상품을 제조한 사람 또는 등록한 사람을 기입한다.
meta_description	메타태그2 : Description 해당 상품의 상품 상세 페이지의 태그에 표시되는 정보. description 태그에 검색 결과 페이지에서 검색 결과 아래에 표시될 간략한 정보를 입력할 수 있다.
meta_keywords	메타태그3 : Keywords 해당 상품의 상품 상세 페이지의 태그에 표시되는 정보. keyword 태그에 해당 상품이 검색되었으면 하는 검색 키워드를 입력할 수 있다.
meta_alt	상품 이미지 Alt 텍스트 상품 이미지에 표시되는 Alt 텍스트 정보. Alt 텍스트를 입력해놓으면 검색엔진에서 이미지 검색시 검색될 가능성이 높아지며, 브라우저에서 이미지 대신 해당 텍스트를 출력할 수 있어 웹 접근성에도 유리하다.
search_engine_exposure	검색 엔진 노출 설정 해당 상품을 검색엔진에 노출할 것인지 설정. '노출안함'으로 설정할 경우 해당 상품이 검색엔진에 노출되지 않는다.

Definition Copy

Request example: Copy

Response example:

Products tags

검색어(Tags)는 상품이 특정 단어로 검색 되어야할 경우 추가할 수 있는 검색 키워드입니다. 상품명이나 상품 상세 설명 외에 다른 단어로도 상품이 검색되길 원할 경우 검색어를 상품에 추가할 수 있습니다.

검색어는 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/products/{product_no}/tags
GET /api/v2/admin/products/{product_no}/tags/count
POST /api/v2/admin/products/{product_no}/tags
DELETE /api/v2/admin/products/{product_no}/tags/{tag}

Products tags properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
tag	상품 태그 검색 또는 분류를 위하여 상품에 입력하는 검색어 정보(해시태그)
tags Required	상품 태그
product_no	상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

List all products tags

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

Definition Copy

Request example: Copy

Response example:

Count all products tags

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

Definition Copy

Request example: Copy

Response example:

Create a products tag

POST

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.
tag Required	상품 태그 검색 또는 분류를 위하여 상품에 입력하는 검색어 정보(해시태그)
tags Required	상품 태그

Definition Copy

Request example: Copy

Response example:

Delete a products tag

DELETE

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

tag

상품 태그

검색 또는 분류를 위하여 상품에 입력하는 검색어 정보(해시태그)

Definition Copy

Request example: Copy

Response example:

Products variants

품목(Variants)은 쇼핑몰에서 판매되는 상품의 기본 단위입니다. 쇼핑몰은 일반적으로 고객에게 다양한 선택권을 제공하기 위해 같은 상품이지만 사이즈가 다르거나, 혹은 색상이 다른 품목들을 판매합니다.
품목은 다음과 같은 리소스를 하위 리소스로 갖고 있습니다.

● 재고(Inventories)

Endpoints

GET /api/v2/admin/products/{product_no}/variants
GET /api/v2/admin/products/{product_no}/variants/{variant_code}
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}
PUT /api/v2/admin/products/{product_no}/variants
DELETE /api/v2/admin/products/{product_no}/variants/{variant_code}

Products variants properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
variant_code 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	상품 품목 코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않음.
options	옵션
custom_variant_code 최대글자수 : [40자]	자체 품목 코드 사용자가 품목에 부여 가능한 코드. 재고 관리 등의 이유로 자체적으로 상품을 관리하고 있는 경우 사용함.
display	진열상태 해당 품목을 진열할지 여부. 품목을 진열할 경우 상품 상세 또는 상품 목록에서 해당 품목을 선택할 수 있다. 품목이 진열되어있지 않을 경우 해당 품목이 표시되지 않으며 해당 품목을 구매할 수 없다. T : 판매함 F : 판매안함
selling	판매상태 해당 품목을 판매할지 여부. 진열은 되어있으나 판매는 하지 않을 경우 해당 품목은 "품절"로 표시되며 해당 품목을 구매할 수 없다. 품목이 "판매함" 상태여도 "진열안함"으로 되어있다면 해당 품목을 구매할 수 없다. T : 진열함 F : 진열안함
additional_amount	추가금액 해당 품목을 구매할 경우, 상품의 판매가에 더하여 지불해야하는 추가 가격.
use_inventory	재고 사용여부 T : 사용함 F : 사용안함
important_inventory	중요재고 여부 A : 일반재고 B : 중요재고
inventory_control_type	재고 수량체크 기준 A : 주문기준 B : 결제기준
display_soldout	품절표시여부 T : 품절표시 사용 F : 품절표시 사용안함
quantity	수량
safety_inventory	안전재고수량
inventories	재고 리소스 품목의 재고 리소스
duplicated_custom_variant_code	자체품목코드 중복여부 T : 중복됨 F : 중복안됨
product_no	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

List all products variants

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

inventories
embed

재고 리소스

품목의 재고 리소스
조회시 Embed 파라메터를 사용하여 조회할 수 있다.

,(콤마)로 여러 건을 검색할 수 있다.

Definition Copy

Request example: Copy

Response example:

Get a products variant

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
variant_code Required 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	품목코드
inventories embed	재고 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.

Definition Copy

Request example: Copy

Response example:

Update a products variant

PUT

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.
variant_code Required 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	상품 품목 코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않음.
custom_variant_code 최대글자수 : [40자]	자체 품목 코드 사용자가 품목에 부여 가능한 코드. 재고 관리 등의 이유로 자체적으로 상품을 관리하고 있는 경우 사용함.
display	진열상태 해당 품목을 진열할지 여부. 품목을 진열할 경우 상품 상세 또는 상품 목록에서 해당 품목을 선택할 수 있다. 품목이 진열되어있지 않을 경우 해당 품목이 표시되지 않으며 해당 품목을 구매할 수 없다. T : 진열함 F : 진열안함
selling	판매상태 해당 품목을 판매할지 여부. 진열은 되어있으나 판매는 하지 않을 경우 해당 품목은 "품절"로 표시되며 해당 품목을 구매할 수 없다. 품목이 "판매함" 상태여도 "진열안함"으로 되어있다면 해당 품목을 구매할 수 없다. T : 판매함 F : 판매안함
additional_amount	추가금액 해당 품목을 구매할 경우, 상품의 판매가에 더하여 지불해야하는 추가 가격.
quantity	수량
use_inventory	재고 사용여부 T : 사용함 F : 사용안함
important_inventory	중요재고 여부 A : 일반재고 B : 중요재고
inventory_control_type	재고 수량체크 기준 A : 주문기준 B : 결제기준
display_soldout	품절표시여부 T : 품절표시 사용 F : 품절표시 사용안함
safety_inventory	안전재고수량

Definition Copy

Request example: Copy

Response example:

Update products variants(batch)

PUT

한 상품의 여러 품목을 한번에 수정할 수 있는 품목 수정(멀티) API입니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
product_no Required	상품번호
variant_code Required 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	상품 품목 코드
custom_variant_code 최대글자수 : [40자]	자체 품목 코드
display	진열상태 T : 진열함 F : 진열안함
selling	판매상태 T : 판매함 F : 판매안함
additional_amount	추가금액
quantity	수량
use_inventory	재고 사용여부 T : 사용함 F : 사용안함
important_inventory	중요재고 여부 A : 일반재고 B : 중요재고
inventory_control_type	재고 수량체크 기준 A : 주문기준 B : 결제기준
display_soldout	품절표시여부 T : 품절표시 사용 F : 품절표시 사용안함
safety_inventory	안전재고수량

Definition Copy

Request example: Copy

Response example:

Delete a products variant

DELETE

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

variant_code
Required

형식 : [A-Z0-9]
글자수 최소: [12자]~최대: [12자]

상품 품목 코드

시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않음.

Definition Copy

Request example: Copy

Response example:

Products variants inventories

재고(Inventories)는 판매 가능한 해당 품목의 수량을 의미합니다. 재고는 품목(Variants)별로 존재하며 해당 재고 이상 품목이 판매되면 해당 상품은 품절 상태가 됩니다.

Endpoints

GET /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories

Products variants inventories properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
variant_code 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	품목코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않는다.
use_inventory	재고 사용여부 해당 품목에서 재고 관리를 사용할 것인지 여부. 해당 품목에 재고 관리를 사용할 경우 재고 수량을 입력할 수 있다. 재고 관리를 사용하지 않을 경우 해당 상품은 재고와 관계 없이 판매할 수 있으며, 재고 수량, 재고수량 체크 기준, 품절 표시 여부를 사용할 수 없다. T : 사용함 F : 사용안함
important_inventory	중요재고 여부 해당 재고를 중요하게 관리하는지 여부. 쇼핑몰에서는 검색을 하기위한 구분 데이터로 사용한다. A : 일반재고 B : 중요재고
inventory_control_type	재고 수량체크 기준 재고 수량을 어느 시점에 차감할 것인지 여부. 무통장 입금처럼 결제 시점과 주문 시점이 다른 경우 재고를 차감하는 기준을 다르게 설정할 수 있다. 주문 기준 : 주문한 시점에 재고 차감. 무통장 입금의 경우 입금 완료가 되지 않아도 재고를 차감한다. 결제 기준 : 결제한 시점에 재고 차감. 무통장 입금의 경우 입금 완료가 된 다음 재고를 차감한다. A : 주문기준 B : 결제기준
display_soldout	품절표시여부 재고가 다 판매되었을 경우 해당 품목을 품절로 표시할 것인지 여부. 품절로 표시되면 주문을 할 수 없다. 모든 품목이 품절이 될 경우 해당 상품에 품절 아이콘이 표시된다. "표시안함" 선택시 재고가 다 판매되어도 주문이 가능하며 재고가 마이너스(-)로 표기된다. T : 품절표시 사용 F : 품절표시 사용안함
quantity	수량 해당 품목에 판매가 가능한 재고 수량. 재고 수량은 주문 또는 결제시 차감되며, 품절 표시를 위하여 체크된다.
safety_inventory	안전재고수량

Get products variants inventory

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

variant_code
Required

형식 : [A-Z0-9]
글자수 최소: [12자]~최대: [12자]

품목코드

판매 수량을 검색할 품목 코드

Definition Copy

Request example: Copy

Response example:

Update a products variants inventory

PUT

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
variant_code Required 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	품목코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않는다.
use_inventory	재고 사용여부 해당 품목에서 재고 관리를 사용할 것인지 여부. 해당 품목에 재고 관리를 사용할 경우 재고 수량을 입력할 수 있다. 재고 관리를 사용하지 않을 경우 해당 상품은 재고와 관계 없이 판매할 수 있으며, 재고 수량, 재고수량 체크 기준, 품절 표시 여부를 사용할 수 없다. T : 사용함 F : 사용안함
important_inventory	중요재고 여부 해당 재고를 중요하게 관리하는지 여부. 쇼핑몰에서는 검색을 하기위한 구분 데이터로 사용한다. A : 일반재고 B : 중요재고
inventory_control_type	재고 수량체크 기준 재고 수량을 어느 시점에 차감할 것인지 여부. 무통장 입금처럼 결제 시점과 주문 시점이 다른 경우 재고를 차감하는 기준을 다르게 설정할 수 있다. 주문 기준 : 주문한 시점에 재고 차감. 무통장 입금의 경우 입금 완료가 되지 않아도 재고를 차감한다. 결제 기준 : 결제한 시점에 재고 차감. 무통장 입금의 경우 입금 완료가 된 다음 재고를 차감한다. A : 주문기준 B : 결제기준
display_soldout	품절표시여부 재고가 다 판매되었을 경우 해당 품목을 품절로 표시할 것인지 여부. 품절로 표시되면 주문을 할 수 없다. 모든 품목이 품절이 될 경우 해당 상품에 품절 아이콘이 표시된다. "표시안함" 선택시 재고가 다 판매되어도 주문이 가능하며 재고가 마이너스(-)로 표기된다. T : 품절표시 사용 F : 품절표시 사용안함
quantity	수량 해당 품목에 판매가 가능한 재고 수량. 재고 수량은 주문 또는 결제시 차감되며, 품절 표시를 위하여 체크된다.
safety_inventory	안전재고수량

Definition Copy

Request example: Copy

Response example:

Collection

Brands

브랜드(Brands)는 상품의 "제작정보" 중 브랜드에 입력하는 정보를 의미합니다. 브랜드는 쇼핑몰의 상품을 구분하는 판매분류의 하나로 상품은 반드시 하나의 브랜드를 갖고 있습니다.(미지정시 "자체브랜드"를 사용함)

Endpoints

GET /api/v2/admin/brands
GET /api/v2/admin/brands/count
POST /api/v2/admin/brands
PUT /api/v2/admin/brands/{brand_code}
DELETE /api/v2/admin/brands/{brand_code}

Brands properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
brand_code	브랜드 코드
brand_name 최대글자수 : [50자]	브랜드 명
use_brand	브랜드 사용여부 T : 사용함 F : 사용안함
search_keyword 최대글자수 : [200자]	검색어 설정
product_count	상품수
created_date timezone	생성일

List all brands

GET

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
brand_code	브랜드 코드 ,(콤마)로 여러 건을 검색할 수 있다.
brand_name	브랜드 명 ,(콤마)로 여러 건을 검색할 수 있다.
use_brand	브랜드 사용여부 T : 사용함 F : 사용안함
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치

Definition Copy

Request example: Copy

Response example:

Count all brands

GET

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
brand_code	브랜드 코드 ,(콤마)로 여러 건을 검색할 수 있다.
brand_name	브랜드 명 ,(콤마)로 여러 건을 검색할 수 있다.
use_brand	브랜드 사용여부 T : 사용함 F : 사용안함

Definition Copy

Request example: Copy

Response example:

Create a brand

POST

기본스펙

Property	Description
SCOPE	판매분류 쓰기권한 (mall.write_collection)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
brand_name Required	브랜드 명
use_brand	브랜드 사용여부 T : 사용함 F : 사용안함 DEFAULT T
search_keyword 최대글자수 : [200자]	검색어 설정

Definition Copy

Request example: Copy

Response example:

Update a brand

PUT

기본스펙

Property	Description
SCOPE	판매분류 쓰기권한 (mall.write_collection)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
brand_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	브랜드 코드
brand_name	브랜드 명
use_brand	브랜드 사용여부 T : 사용함 F : 사용안함 DEFAULT T
search_keyword 최대글자수 : [200자]	검색어 설정

Definition Copy

Request example: Copy

Response example:

Delete a brand

DELETE

기본스펙

Property	Description
SCOPE	판매분류 쓰기권한 (mall.write_collection)
호출건수 제한	40

요청사양

Parameter	Description
brand_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	브랜드 코드

Definition Copy

Request example: Copy

Response example:

Classifications

자체분류(Classifications)는 상품의 "제작정보" 중 자체분류에 입력하는 정보를 의미합니다. 자체분류는 상품을 구분하는 판매분류의 하나이며, 상품은 반드시 하나의 자체분류를 갖고 있습니다.(미지정시 "기본 자체분류"를 사용함)

Endpoints

GET /api/v2/admin/classifications
GET /api/v2/admin/classifications/count

Classifications properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
classification_code 형식 : [A-Z0-9] 최소글자수 : [8자] 최대글자수 : [8자]	자체분류 코드
classification_name 최대글자수 : [200자]	자체분류 명
classification_description 최대글자수 : [300자]	자체분류 설명
use_classification	사용여부
created_date timezone	생성일
product_count	상품수

List all classifications

GET

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
classification_code	자체분류 코드 ,(콤마)로 여러 건을 검색할 수 있다.
classification_name	자체분류 명 ,(콤마)로 여러 건을 검색할 수 있다.
use_classification	사용여부
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치

Definition Copy

Request example: Copy

Response example:

Count all classifications

GET

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
classification_code	자체분류 코드 ,(콤마)로 여러 건을 검색할 수 있다.
classification_name	자체분류 명 ,(콤마)로 여러 건을 검색할 수 있다.
use_classification	사용여부

Definition Copy

Request example: Copy

Response example:

Manufacturers

제조사(Manufacturers)는 상품의 "제작정보" 중 제조사에 입력하는 정보를 의미합니다. 제조사는 상품을 제작, 생산한 주체를 나타내며, 상품을 구분하는 판매분류의 하나입니다. 상품은 반드시 하나의 제조사를 갖고 있습니다.(미지정시 "자체제조사"를 사용함)

Endpoints

GET /api/v2/admin/manufacturers
GET /api/v2/admin/manufacturers/count
GET /api/v2/admin/manufacturers/{manufacturer_code}
POST /api/v2/admin/manufacturers
PUT /api/v2/admin/manufacturers/{manufacturer_code}

Manufacturers properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
manufacturer_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	제조사 코드 시스템이 부여한 제조사의 코드. 해당 쇼핑몰 내에서 제조사 코드는 중복되지 않는다.
manufacturer_name 최대글자수 : [50자]	제조사명 제조사의 이름. 제조사명은 쇼핑몰 관리자 화면에서 제조사를 구분할 수 있는 기본적인 정보이다.
president_name 최대글자수 : [30자]	대표자명 제조사의 대표자 이름.
use_manufacturer	사용여부 해당 제조사를 사용하는지 여부 표시 T : 사용함 F : 사용안함
email 최대글자수 : [255자]	이메일 제조사의 문의 메일. 상세 조회시에만 확인 가능하다.
phone 최대글자수 : [20자]	전화번호 제조사의 전화번호. 상세 조회시에만 확인 가능하다.
homepage 최대글자수 : [255자]	홈페이지 제조사의 홈페이지 주소 상세 조회시에만 확인 가능하다.
zipcode	우편번호 제조사의 사업장 우편번호. 상세 조회시에만 확인 가능하다.
address1 최대글자수 : [255자]	기본 주소 제조사의 사업장 주소(시/군/구 단위 표기) 상세 조회시에만 확인 가능하다.
address2 최대글자수 : [255자]	상세 주소 제조사의 사업장 주소(상세 주소 표기) 상세 조회시에만 확인 가능하다.
created_date timezone	생성일 상세 조회시에만 확인 가능하다.

List all manufacturers

GET

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
manufacturer_code	제조사 코드 조회하고자 하는 제조사의 코드. ,(콤마)로 여러 건을 검색할 수 있다.
manufacturer_name	제조사명 ,(콤마)로 여러 건을 검색할 수 있다.
use_manufacturer	제조사 사용여부 T : 사용함 F : 사용안함
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치 조회결과 시작위치

Definition Copy

Request example: Copy

Response example:

Count all manufacturers

GET

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
manufacturer_code	제조사 코드 조회하고자 하는 제조사의 코드. ,(콤마)로 여러 건을 검색할 수 있다.
manufacturer_name	제조사명 검색어를 제조사명에 포함하고 있는 공급사 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
use_manufacturer	제조사 사용여부 T : 사용함 F : 사용안함

Definition Copy

Request example: Copy

Response example:

Get a manufacturer

GET

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

manufacturer_code
Required

형식 : [A-Z0-9]
글자수 최소: [8자]~최대: [8자]

제조사 코드

Definition Copy

Request example: Copy

Response example:

Create a manufacturer

POST

기본스펙

Property	Description
SCOPE	판매분류 쓰기권한 (mall.write_collection)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
manufacturer_name Required	제조사명
president_name Required 최대글자수 : [30자]	대표자명
email 최대글자수 : [255자] 이메일	이메일
phone 최대글자수 : [20자] 전화번호	전화번호
homepage 최대글자수 : [255자]	홈페이지
zipcode	우편번호
address1 최대글자수 : [255자]	기본 주소
address2 최대글자수 : [255자]	상세 주소
use_manufacturer	사용여부 T : 사용함 F : 사용안함

Definition Copy

Request example: Copy

Response example:

Update a manufacturer

PUT

기본스펙

Property	Description
SCOPE	판매분류 쓰기권한 (mall.write_collection)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
manufacturer_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	제조사 코드
manufacturer_name	제조사명
president_name	대표자명
email 최대글자수 : [255자] 이메일	이메일
phone 최대글자수 : [20자] 전화번호	전화번호
homepage 최대글자수 : [255자]	홈페이지
zipcode	우편번호
address1 최대글자수 : [255자]	기본 주소
address2 최대글자수 : [255자]	상세 주소
use_manufacturer	사용여부 T : 사용함 F : 사용안함

Definition Copy

Request example: Copy

Response example:

Origin

원산지(Origin)는 상품이 생산된 지역을 의미합니다. 원산지는 국외 배송 등에 중요한 데이터입니다. 카페24는 다양한 원산지가 코드화 되어있으며, 원산지 조회 API를 통해 원산지 코드 정보를 확인할 수 있습니다.

Endpoints

GET /api/v2/admin/origin

Origin properties

Attribute	Description
origin_place_no	원산지 번호
origin_place_name	원산지 이름
foreign	해외 여부
made_in_code	원산지 국가코드

List all origin

GET

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
origin_place_no	원산지 번호
origin_place_name 최대글자수 : [50자]	원산지 이름
foreign	해외 여부
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치

Definition Copy

Request example: Copy

Response example:

Trends

트렌드(Trends)는 상품의 "제작정보" 중 트렌드에 입력하는 정보를 의미합니다. 트렌드는 상품을 구분하는 판매분류의 하나이며, 상품은 반드시 하나의 트렌드를 갖고 있습니다.(미지정시 "기본트렌드"를 사용함)

Endpoints

GET /api/v2/admin/trends
GET /api/v2/admin/trends/count

Trends properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
trend_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	트렌드 코드
trend_name 최대글자수 : [50자]	트렌드 명
use_trend	트렌드 사용여부 T : 사용함 F : 사용안함
created_date timezone	생성일
product_count	상품수

List all trends

GET

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
trend_code	트렌드 코드 ,(콤마)로 여러 건을 검색할 수 있다.
trend_name	트렌드 명 ,(콤마)로 여러 건을 검색할 수 있다.
use_trend	트렌드 사용여부 T : 사용함 F : 사용안함
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치

Definition Copy

Request example: Copy

Response example:

Count all trends

GET

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
trend_code	트렌드 코드 ,(콤마)로 여러 건을 검색할 수 있다.
trend_name	트렌드 명 ,(콤마)로 여러 건을 검색할 수 있다.
use_trend	트렌드 사용여부 T : 사용함 F : 사용안함

Definition Copy

Request example: Copy

Response example:

Supply

Suppliers

공급사(Suppliers)는 상품의 "제작정보" 중 공급사에 입력하는 정보를 의미합니다. 공급사는 쇼핑몰에 물품을 공급하여 상품을 팔 수 있게 하는 회사 또는 개인을 의미합니다. 공급사는 상품을 구분하는 판매분류의 하나이며, 상품은 반드시 하나의 공급사를 갖고 있습니다.(미지정시 "자체공급"을 사용함)

Endpoints

GET /api/v2/admin/suppliers
GET /api/v2/admin/suppliers/count
GET /api/v2/admin/suppliers/{supplier_code}
POST /api/v2/admin/suppliers
PUT /api/v2/admin/suppliers/{supplier_code}
DELETE /api/v2/admin/suppliers/{supplier_code}

Suppliers properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
supplier_code	공급사 코드 시스템이 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.
supplier_name 최대글자수 : [100자]	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.
status	상태 해당 공급사와의 거래 현황 정보. A : 거래중 P : 거래중지 N : 거래해지
commission	수수료 정산유형이 수수료형(P)일 경우 사용하는 수수료 정보
payment_period	정산주기 공급사에 정산을 얼마나 자주할 것인지 설정할 수 있음. 0 : 선택안함 C : 일일정산 B : 주간정산 A : 월간정산
business_item 최대글자수 : [255자]	거래상품 유형 공급사와 거래하는 상품의 유형 정보.
payment_type	정산유형 공급사에 지불할 금액을 어떤 유형으로 정산할 것인지 설정할 수 있음. 수수료형 : 상품의 판매가격에 수수료를 책정하여 수수료 금액을 반영하여 정산함 매입형 : 상품 등록시 입력한 공급가격을 기준으로 정산함 P : 수수료형 D : 매입형
supplier_type	공급사구조 공급사의 영업 형태. 도매업체 : 최종 고객에게는 판매하지 않고 소매업체에 판매하는 업체 사입업체 : 도매업체로부터 물건을 구입해서 소매업체에 판매하는 업체 입점업체 : 쇼핑몰에 입점하여 판매중인 업체 WS : 도매업체 SF : 사입업체 BS : 입점업체 ET : 기타
use_supplier	사용여부 해당 공급사를 사용하는지 여부 표시 T : 사용함 F : 사용안함
created_date timezone	등록일 공급사 정보가 등록된 날짜
updated_date timezone	수정일 공급사 정보가 수정된 날짜
country_code	사업장 주소 국가 코드 KOR : 한국 JPN : 일본 CHN : 중국 TWN : 대만 ETC : 기타
zipcode 최대글자수 : [10자]	우편번호 공급사의 사업장 주소 우편번호.
address1 최대글자수 : [255자]	기본 주소 공급사의 사업장 주소(시/군/구 단위 표기).
address2 최대글자수 : [255자]	상세 주소 공급사의 사업장 주소(상세 주소 표기).
manager_information	담당자 공급사의 담당자 연락처 정보. 담당자는 세명까지 지정 가능하다.
trading_type	공급사유형 상품이 공급사에서 배송되는 형태. 사입 : 상품을 판매자가 구입하여 구매자에게 배송함. 직배송 : 상품에 주문이 들어오면 공급사가 구매자에게 바로 배송함. 상세 조회시에만 확인 가능하다. D : 사입 C : 직배송
payment_method	정산시기 정산이 되는 기준 시점. 10 : 결제완료 30 : 배송시작 40 : 배송완료 상세 조회시에만 확인 가능하다. 10 : 결제완료 30 : 배송시작 40 : 배송완료
payment_start_day 최소: [0]~최대: [6]	정산시작 요일 정산주기가 주간정산(B)일 경우 아래 요일에 따라 정산이 진행됨. 0 : 일요일마다 정산 진행 1 : 월요일마다 정산 진행 2 : 화요일마다 정산 진행 3 : 수요일마다 정산 진행 4 : 목요일마다 정산 진행 5 : 금요일마다 정산 진행 6 : 토요일마다 정산 진행 상세 조회시에만 확인 가능하다. 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
payment_end_day 최소: [0]~최대: [6]	정산종료 요일 정산주기가 주간정산(B)일 경우 아래 요일에 따라 정산이 진행됨. 0 : 일요일마다 정산 진행 1 : 월요일마다 정산 진행 2 : 화요일마다 정산 진행 3 : 수요일마다 정산 진행 4 : 목요일마다 정산 진행 5 : 금요일마다 정산 진행 6 : 토요일마다 정산 진행 상세 조회시에만 확인 가능하다. 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
payment_start_date 최소: [1]~최대: [31]	정산시작 일 정산주기가 월간정산(A)일 경우 해당 일자를 정산시작 일로 정함. 상세 조회시에만 확인 가능하다.
payment_end_date 최소: [1]~최대: [31]	정산종료 일 정산주기가 월간정산(A)일 경우 해당 일자를 정산종료 일로 정함. 상세 조회시에만 확인 가능하다.
bank_code 최대글자수 : [50자]	은행코드 공급사 정산시 사용하는 계좌의 입금은행 코드 bank_code 상세 조회시에만 확인 가능하다.
bank_account_no	계좌번호 공급사 정산시 사용하는 계좌의 계좌 번호 상세 조회시에만 확인 가능하다.
bank_account_name	예금주 공급사 정산시 사용하는 계좌의 예금주 명 상세 조회시에만 확인 가능하다.
phone 최대글자수 : [20자]	전화번호 공급사의 사업장 전화번호. 상세 조회시에만 확인 가능하다.
fax 최대글자수 : [20자]	팩스번호 공급사의 사업장 팩스번호. 상세 조회시에만 확인 가능하다.
market_country_code	시장 주소 국가 코드 상세 조회시에만 확인 가능하다. KOR : 한국 JPN : 일본 CHN : 중국 TWN : 대만 ETC : 기타
market_zipcode 최대글자수 : [10자]	시장주소 우편번호 상세 조회시에만 확인 가능하다.
market_address1	시장 기본 주소 상세 조회시에만 확인 가능하다.
market_address2	시장 상세 주소 상세 조회시에만 확인 가능하다.
exchange_country_code	반품 주소 국가 코드 상세 조회시에만 확인 가능하다. KOR : 한국 JPN : 일본 CHN : 중국 TWN : 대만 ETC : 기타
exchange_zipcode 최대글자수 : [10자]	반품주소 우편번호 상세 조회시에만 확인 가능하다.
exchange_address1 최대글자수 : [255자]	반품 기본 주소 상세 조회시에만 확인 가능하다.
exchange_address2 최대글자수 : [255자]	반품 상세 주소 상세 조회시에만 확인 가능하다.
homepage_url 최대글자수 : [100자]	홈페이지 주소 상세 조회시에만 확인 가능하다.
mall_url 최대글자수 : [100자]	쇼핑몰 주소 상세 조회시에만 확인 가능하다.
account_start_date 최대글자수 : [10자]	거래개시일 상세 조회시에만 확인 가능하다.
account_stop_date 최대글자수 : [10자]	거래중지일 상세 조회시에만 확인 가능하다.
show_supplier_info 최대글자수 : [100자]	공급사정보 표시 상세 조회시에만 확인 가능하다. SP : 전화번호 SM : 사업장주소 MA : 시장주소 EA : 반품주소 MN : 담당자명 MI : 담당자연락처
memo 최대글자수 : [255자]	메모 해당 공급사에 대한 관리용 메모 상세 조회시에만 확인 가능하다.
company_registration_no 최대글자수 : [12자]	사업자등록번호 해당 공급사의 사업자 등록 번호. 국가에 따라 해당 사업자의 등록 고유 번호가 발급되는 경우 표시한다. 상세 조회시에만 확인 가능하다.
company_name	상호명 사업자 등록시 공급사에서 등록한 상호명 상세 조회시에만 확인 가능하다.
president_name	대표자명 사업자 등록시 공급사에서 등록한 대표자명 상세 조회시에만 확인 가능하다.
company_condition	업태 사업자 등록시 공급사에서 등록한 업태 상세 조회시에만 확인 가능하다.
company_line	종목 사업자 등록시 공급사에서 등록한 종목 상세 조회시에만 확인 가능하다.
company_introduction	회사소개 공급사에 대한 간략한 소개 표시. 쇼핑몰의 회사 소개 화면에 표시된다. 상세 조회시에만 확인 가능하다.

List all suppliers

GET

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
supplier_code	공급사 코드 시스템이 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다. ,(콤마)로 여러 건을 검색할 수 있다.
supplier_name	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다. ,(콤마)로 여러 건을 검색할 수 있다.
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치

Definition Copy

Request example: Copy

Response example:

Count all suppliers

GET

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

supplier_code

공급사 코드

시스템이 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.

,(콤마)로 여러 건을 검색할 수 있다.

supplier_name

공급사명

공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.

,(콤마)로 여러 건을 검색할 수 있다.

Definition Copy

Request example: Copy

Response example:

Get a supplier

GET

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

supplier_code
Required

공급사 코드

시스템이 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.

Definition Copy

Request example: Copy

Response example:

Create a supplier

POST

기본스펙

Property	Description
SCOPE	공급사 정보 쓰기권한 (mall.write_supply)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
supplier_name Required 최대글자수 : [50자]	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.
manager_information 배열 최대사이즈: [3]	담당자 담당자는 최대 세명까지 입력할 수 있다.
no 담당자 일련번호 Required name 담당자 이름 Required phone 담당자 연락처 email 담당자 이메일
use_supplier	사용여부 해당 공급사를 사용하는지 여부 표시 T : 사용함 F : 사용안함 DEFAULT T
trading_type	공급사유형 상품이 공급사에서 배송되는 형태. 사입 : 상품을 판매자가 구입하여 구매자에게 배송함. 직배송 : 상품에 주문이 들어오면 공급사가 구매자에게 바로 배송함. D : 사입 C : 직배송 DEFAULT D
supplier_type	공급사구조 공급사의 영업 형태. 도매업체 : 최종 고객에게는 판매하지 않고 소매업체에 판매하는 업체 사입업체 : 도매업체로부터 물건을 구입해서 소매업체에 판매하는 업체 입점업체 : 쇼핑몰에 입점하여 판매중인 업체 WS : 도매업체 SF : 사입업체 BS : 입점업체 ET : 기타 DEFAULT WS
status	상태 해당 공급사와의 거래 현황 정보. A : 거래중 P : 거래중지 N : 거래해지 DEFAULT A
business_item 최대글자수 : [255자]	거래상품 유형 공급사와 거래하는 상품의 유형 정보.
payment_type	정산유형 공급사에 지불할 금액을 어떤 유형으로 정산할 것인지 설정할 수 있음. 수수료형 : 상품의 판매가격에 수수료를 책정하여 수수료 금액을 반영하여 정산함 매입형 : 상품 등록시 입력한 공급가격을 기준으로 정산함 P : 수수료형 D : 매입형 DEFAULT P
payment_period	정산주기 공급사에 정산을 얼마나 자주할 것인지 설정할 수 있음. 0 : 선택안함 C : 일일정산 B : 주간정산 A : 월간정산
payment_method	정산시기 정산이 되는 기준 시점. 10 : 결제완료 30 : 배송시작 40 : 배송완료 10 : 결제완료 30 : 배송시작 40 : 배송완료
payment_start_day 최소: [0]~최대: [6]	정산시작 요일 정산주기가 주간정산(B)일 경우 아래 요일에 따라 정산이 진행됨. 0 : 일요일마다 정산 진행 1 : 월요일마다 정산 진행 2 : 화요일마다 정산 진행 3 : 수요일마다 정산 진행 4 : 목요일마다 정산 진행 5 : 금요일마다 정산 진행 6 : 토요일마다 정산 진행 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
payment_end_day 최소: [0]~최대: [6]	정산종료 요일 정산주기가 주간정산(B)일 경우 아래 요일에 따라 정산이 진행됨. 0 : 일요일마다 정산 진행 1 : 월요일마다 정산 진행 2 : 화요일마다 정산 진행 3 : 수요일마다 정산 진행 4 : 목요일마다 정산 진행 5 : 금요일마다 정산 진행 6 : 토요일마다 정산 진행 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
payment_start_date 최소: [1]~최대: [31]	정산시작 일 정산주기가 월간정산(A)일 경우 해당 일자를 정산시작 일로 정함.
payment_end_date 최소: [1]~최대: [31]	정산종료 일 정산주기가 월간정산(A)일 경우 해당 일자를 정산종료 일로 정함.
commission	수수료율 정산유형이 수수료형(P)일 경우 사용하는 수수료 정보 DEFAULT 10
phone 최대글자수 : [20자] 전화번호	전화번호 공급사의 사업장 전화번호.
fax 최대글자수 : [20자] 전화번호	팩스번호 공급사의 사업장 팩스번호.
country_code	사업장 주소 국가 코드 KOR : 한국 JPN : 일본 CHN : 중국 TWN : 대만 VNM : 베트남 ETC : 기타
zipcode 최대글자수 : [10자]	우편번호 공급사의 사업장 주소 우편번호.
address1 최대글자수 : [255자]	기본 주소 공급사의 사업장 주소(시/군/구 단위 표기).
address2 최대글자수 : [255자]	상세 주소 공급사의 사업장 주소(상세 주소 표기).
market_country_code	시장 주소 국가 코드 KOR : 한국 JPN : 일본 CHN : 중국 TWN : 대만 VNM : 베트남 ETC : 기타
market_zipcode 최대글자수 : [10자]	시장주소 우편번호
market_address1	시장 기본 주소
market_address2	시장 상세 주소
exchange_country_code	반품 주소 국가 코드 KOR : 한국 JPN : 일본 CHN : 중국 TWN : 대만 VNM : 베트남 ETC : 기타
exchange_zipcode 최대글자수 : [10자]	반품주소 우편번호
exchange_address1 최대글자수 : [255자]	반품 기본 주소
exchange_address2 최대글자수 : [255자]	반품 상세 주소
homepage_url 최대글자수 : [100자]	홈페이지 주소
mall_url 최대글자수 : [100자]	쇼핑몰 주소
account_start_date 최대글자수 : [10자] 날짜	거래개시일
account_stop_date 최대글자수 : [10자] 날짜	거래중지일
memo 최대글자수 : [255자]	메모 해당 공급사에 대한 관리용 메모
company_registration_no 최대글자수 : [12자] 사업자번호	사업자등록번호 해당 공급사의 사업자 등록 번호. 국가에 따라 해당 사업자의 등록 고유 번호가 발급되는 경우 표시한다.
company_name 최대글자수 : [30자]	상호명 사업자 등록시 공급사에서 등록한 상호명
president_name 최대글자수 : [20자]	대표자명 사업자 등록시 공급사에서 등록한 대표자명
company_condition 최대글자수 : [20자]	업태 사업자 등록시 공급사에서 등록한 업태
company_line 최대글자수 : [20자]	종목 사업자 등록시 공급사에서 등록한 종목
company_introduction	회사소개 공급사에 대한 간략한 소개 표시. 쇼핑몰의 회사 소개 화면에 표시된다.

Definition Copy

Request example: Copy

Response example:

Update a supplier

PUT

기본스펙

Property	Description
SCOPE	공급사 정보 쓰기권한 (mall.write_supply)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
supplier_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	공급사 코드 시스템이 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.
supplier_name 최대글자수 : [50자]	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.
use_supplier	사용여부 해당 공급사를 사용하는지 여부 표시 T : 사용함 F : 사용안함
trading_type	공급사유형 상품이 공급사에서 배송되는 형태. 사입 : 상품을 판매자가 구입하여 구매자에게 배송함. 직배송 : 상품에 주문이 들어오면 공급사가 구매자에게 바로 배송함. D : 사입 C : 직배송
supplier_type	공급사구조 공급사의 영업 형태. 도매업체 : 최종 고객에게는 판매하지 않고 소매업체에 판매하는 업체 사입업체 : 도매업체로부터 물건을 구입해서 소매업체에 판매하는 업체 입점업체 : 쇼핑몰에 입점하여 판매중인 업체 WS : 도매업체 SF : 사입업체 BS : 입점업체 ET : 기타
status	상태 해당 공급사와의 거래 현황 정보. A : 거래중 P : 거래중지 N : 거래해지
payment_type	정산유형 공급사에 지불할 금액을 어떤 유형으로 정산할 것인지 설정할 수 있음. 수수료형 : 상품의 판매가격에 수수료를 책정하여 수수료 금액을 반영하여 정산함 매입형 : 상품 등록시 입력한 공급가격을 기준으로 정산함 P : 수수료형 D : 매입형
payment_period	정산주기 공급사에 정산을 얼마나 자주할 것인지 설정할 수 있음. 0 : 선택안함 C : 일일정산 B : 주간정산 A : 월간정산
commission	수수료율 정산유형이 수수료형(P)일 경우 사용하는 수수료 정보
manager_information 배열 최대사이즈: [3]	담당자 담당자는 세명까지 지정할 수 있으며, "no"를 통해 특정 담당자를 지정하여 정보를 수정할 수 있다.
no 담당자 일련번호 Required name 담당자 이름 Required phone 담당자 연락처 email 담당자 이메일 use_sms SMS 수신여부 T : 수신 F : 수신안함
business_item 최대글자수 : [255자]	거래상품 유형 공급사와 거래하는 상품의 유형 정보.
payment_method	정산시기 정산이 되는 기준 시점. 10 : 결제완료 30 : 배송시작 40 : 배송완료 10 : 결제완료 30 : 배송시작 40 : 배송완료
payment_start_day 최소: [0]~최대: [6]	정산시작 요일 정산주기가 주간정산(B)일 경우 아래 요일에 따라 정산이 진행됨. 0 : 일요일마다 정산 진행 1 : 월요일마다 정산 진행 2 : 화요일마다 정산 진행 3 : 수요일마다 정산 진행 4 : 목요일마다 정산 진행 5 : 금요일마다 정산 진행 6 : 토요일마다 정산 진행 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
payment_end_day 최소: [0]~최대: [6]	정산종료 요일 정산주기가 주간정산(B)일 경우 아래 요일에 따라 정산이 진행됨. 0 : 일요일마다 정산 진행 1 : 월요일마다 정산 진행 2 : 화요일마다 정산 진행 3 : 수요일마다 정산 진행 4 : 목요일마다 정산 진행 5 : 금요일마다 정산 진행 6 : 토요일마다 정산 진행 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
payment_start_date 최소: [1]~최대: [31]	정산시작 일 정산주기가 월간정산(A)일 경우 해당 일자를 정산시작 일로 정함.
payment_end_date 최소: [1]~최대: [31]	정산종료 일 정산주기가 월간정산(A)일 경우 해당 일자를 정산종료 일로 정함.
phone 최대글자수 : [20자] 전화번호	전화번호 공급사의 사업장 전화번호.
fax 최대글자수 : [20자] 전화번호	팩스번호 공급사의 사업장 팩스번호.
country_code	사업장 주소 국가 코드 KOR : 한국 JPN : 일본 CHN : 중국 TWN : 대만 VNM : 베트남 ETC : 기타
zipcode 최대글자수 : [10자]	우편번호 공급사의 사업장 주소 우편번호.
address1 최대글자수 : [255자]	기본 주소 공급사의 사업장 주소(시/군/구 단위 표기).
address2 최대글자수 : [255자]	상세 주소 공급사의 사업장 주소(상세 주소 표기).
market_country_code	시장 주소 국가 코드 KOR : 한국 JPN : 일본 CHN : 중국 TWN : 대만 VNM : 베트남 ETC : 기타
market_zipcode 최대글자수 : [10자]	시장주소 우편번호
market_address1	시장 기본 주소
market_address2	시장 상세 주소
exchange_country_code	반품 주소 국가 코드 KOR : 한국 JPN : 일본 CHN : 중국 TWN : 대만 VNM : 베트남 ETC : 기타
exchange_zipcode 최대글자수 : [10자]	반품주소 우편번호
exchange_address1 최대글자수 : [255자]	반품 기본 주소
exchange_address2 최대글자수 : [255자]	반품 상세 주소
homepage_url 최대글자수 : [100자]	홈페이지 주소
mall_url 최대글자수 : [100자]	쇼핑몰 주소
account_start_date 최대글자수 : [10자] 날짜	거래개시일
account_stop_date 최대글자수 : [10자] 날짜	거래중지일
memo 최대글자수 : [255자]	메모 해당 공급사에 대한 관리용 메모
company_registration_no 최대글자수 : [12자] 사업자번호	사업자등록번호 해당 공급사의 사업자 등록 번호. 국가에 따라 해당 사업자의 등록 고유 번호가 발급되는 경우 표시한다.
company_name 최대글자수 : [30자]	상호명 사업자 등록시 공급사에서 등록한 상호명
president_name 최대글자수 : [20자]	대표자명 사업자 등록시 공급사에서 등록한 대표자명
company_condition 최대글자수 : [20자]	업태 사업자 등록시 공급사에서 등록한 업태
company_line 최대글자수 : [20자]	종목 사업자 등록시 공급사에서 등록한 종목
company_introduction	회사소개 공급사에 대한 간략한 소개 표시. 쇼핑몰의 회사 소개 화면에 표시된다.

Definition Copy

Request example: Copy

Response example:

Delete a supplier

DELETE

기본스펙

Property	Description
SCOPE	공급사 정보 쓰기권한 (mall.write_supply)
호출건수 제한	40

요청사양

Parameter	Description
supplier_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	공급사 코드

Definition Copy

Request example: Copy

Response example:

Suppliers users

공급사 운영자(Supplier Users)는 공급사가 쇼핑몰에 로그인하여 상품을 직접 등록해야할 경우 사용합니다. 공급사 운영자에게 상품 업로드, 분류 관리, 게시판 관리 등 제한적인 권한을 부여할 수 있습니다.

Endpoints

GET /api/v2/admin/suppliers/users
GET /api/v2/admin/suppliers/users/count
GET /api/v2/admin/suppliers/users/{user_id}

Suppliers users properties

Attribute	Description
user_id 형식 : [a-zA-Z0-9] 최대글자수 : [20자]	공급사 운영자 아이디 공급사 운영자가 로그인할 경우 사용하는 로그인 아이디. 부운영자와 마찬가지로 쇼핑몰 관리자 화면에 로그인하면 공급사 관리자 화면에 접근할 수 있다.
supplier_code 최대글자수 : [8자]	공급사 코드 시스템에서 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.
supplier_name 최대글자수 : [100자]	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.
permission_category_select	상품 등록 시 분류선택 권한 공급사 운영자가 상품 등록시 상품 분류를 선택하여 등록할 수 있는지에 대한 권한 설정 T : 허용함 F : 허용안함
permission_product_modify	상품 수정 권한 공급사 운영자가 상품을 등록한 후 상품 정보를 수정할 수 있는 권한 설정 T : 허용함 F : 허용안함
permission_product_display	상품 진열 권한 공급사 운영자가 상품을 등록한 후 쇼핑몰 화면에 진열할 수 있는 권한 설정 T : 허용함 F : 허용안함
permission_product_selling	상품 판매 권한 공급사 운영자가 상품을 등록한 후 해당 상품의 판매여부를 설정할 수 있는 권한 설정 T : 허용함 F : 허용안함
permission_product_delete	등록 상품 삭제 권한 공급사 운영자가 자신이 등록한 상품을 삭제할 수 있는 권한 설정 T : 허용함 F : 허용안함
permission_board_manage	게시판 권한 설정 공급사 운영자가 쇼핑몰의 게시판에 접근할 수 있는 권한 설정 T : 허용함 F : 허용안함
user_name	공급사운영자명 공급사 운영자의 이름. 공급사 운영자 명은 공급사 운영자가 쇼핑몰 관리자 화면에서 어떤 작업을 할 경우 "작업을 실행한 사람(처리자)" 부분에 표시되는 이름을 의미한다. 공급사 운영자 상세 조회 API에서만 확인 가능하다. 상세 조회시에만 확인 가능하다.
nick_name 글자수 최소: [4자]~최대: [20자]	운영자 별명 공급사 운영자의 별명. 공급사 운영자 별명은 공급사 운영자가 게시판에 게시글 작성할 경우 "게시자" 부분에 표시되는 별명을 의미한다.(단, 해당 게시판이 작성자명 대신 '별명'을 노출하도록 설정되어있을 경우에 한 함) 공급사 운영자 상세 조회 API에서만 확인 가능하다. 상세 조회시에만 확인 가능하다.
nick_name_icon_type	별명 아이콘 타입 공급사 운영자의 별명 옆에 표시되는 아이콘을 설정할 수 있다. 직접 아이콘 등록 : 별명 아이콘을 직접 업로드하여 설정할 수 있다. 샘플 아이콘 등록 : 미리 제공되는 아이콘을 선택하여 설정할 수 있다. 공급사 운영자 상세 조회 API에서만 확인 가능하다. 상세 조회시에만 확인 가능하다. D : 직접 S : 샘플
nick_name_icon_url 최대글자수 : [255자]	별명 아이콘 URL 공급사 운영자의 별명 아이콘의 이미지 경로. 공급사 운영자 상세 조회 API에서만 확인 가능하다. 상세 조회시에만 확인 가능하다.
use_nick_name_icon	게시판 닉네임 아이콘 노출 설정 공급사 운영자가 게시판에 게시글 작성시 별명 아이콘을 노출할 것인지 여부 표시 공급사 운영자 상세 조회 API에서만 확인 가능하다. 상세 조회시에만 확인 가능하다. T : 노출 F : 노출안함
use_writer_name_icon	게시판 작성자 노출 설정 공급사 운영자가 게시판에 게시글 작성시 작성자 명을 노출할 것인지 여부 표시 공급사 운영자 상세 조회 API에서만 확인 가능하다. 상세 조회시에만 확인 가능하다. T : 노출 F : 노출안함
email	이메일 공급사 운영자의 이메일 주소. 공급사 운영자의 연락처 저장 목적으로 사용함. 공급사 운영자 상세 조회 API에서만 확인 가능하다. 상세 조회시에만 확인 가능하다.
phone	전화번호 공급사 운영자의 전화번호. 공급사 운영자의 연락처 저장 목적으로 사용함. 공급사 운영자 상세 조회 API에서만 확인 가능하다. 상세 조회시에만 확인 가능하다.
permission_shop_no	접근가능 쇼핑몰 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. 상세 조회시에만 확인 가능하다.
permitted_category_list	상품 등록시 허용 상품분류 공급사 운영자가 상품 등록시 선택 가능한 상품 분류. 공급사 운영자는 상품 등록시 해당 상품 분류에만 상품을 올릴 수 있다. 공급사 운영자 상세 조회 API에서만 확인 가능하다. 상세 조회시에만 확인 가능하다.

List all suppliers users

GET

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	10

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
user_id 형식 : [a-zA-Z0-9] 최대글자수 : [20자]	공급사 운영자 아이디 공급사 운영자가 로그인할 경우 사용하는 로그인 아이디. 부운영자와 마찬가지로 쇼핑몰 관리자 화면에 로그인하면 공급사 관리자 화면에 접근할 수 있다.
supplier_code 최대글자수 : [8자]	공급사 코드 시스템에서 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.
supplier_name 최대글자수 : [100자]	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.

Definition Copy

Request example: Copy

Response example:

Count all suppliers users

GET

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	10

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
user_id 형식 : [a-zA-Z0-9] 최대글자수 : [20자]	공급사 운영자 아이디 공급사 운영자가 로그인할 경우 사용하는 로그인 아이디. 부운영자와 마찬가지로 쇼핑몰 관리자 화면에 로그인하면 공급사 관리자 화면에 접근할 수 있다.
supplier_code 최대글자수 : [8자]	공급사 코드 시스템에서 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.
supplier_name 최대글자수 : [100자]	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.

Definition Copy

Request example: Copy

Response example:

Get a suppliers user

GET

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	10

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

user_id

형식 : [a-zA-Z0-9]
최대글자수 : [20자]

공급사 운영자 아이디

공급사 운영자가 로그인할 경우 사용하는 로그인 아이디. 부운영자와 마찬가지로 쇼핑몰 관리자 화면에 로그인하면 공급사 관리자 화면에 접근할 수 있다.

Definition Copy

Request example: Copy

Response example:

Personal

Carts

Endpoints

GET /api/v2/admin/carts

Carts properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
basket_product_no	장바구니 상품번호
member_id	회원아이디
created_date timezone	담은일자
product_no	상품번호
additional_option_values	추가입력 옵션
variant_code 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	상품 품목 코드
quantity	수량
product_price	상품 판매가
option_price	옵션 추가 가격
product_bundle	세트상품 여부 T : 세트상품 F : 세트상품 아님
shipping_type	배송 유형 A : 국내 B : 해외
category_no	분류 번호

List all carts

GET

기본스펙

Property	Description
SCOPE	개인화정보 읽기권한 (mall.read_personal)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
member_id Required	회원아이디 ,(콤마)로 여러 건을 검색할 수 있다.
offset 최대값: [10000]	조회결과 시작위치
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Definition Copy

Request example: Copy

Response example:

Customers wishlist

회원 관심상품(Customers wishlist)은 회원의 관심상품을 조회할 수 있는 관계형 리소스입니다.

Endpoints

GET /api/v2/admin/customers/{member_id}/wishlist
GET /api/v2/admin/customers/{member_id}/wishlist/count

Customers wishlist properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
wishlist_no	관심상품번호
product_no	상품번호
variant_code 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	품목코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않음.
additional_option	추가입력 옵션
attached_file_option	파일 첨부 옵션
price	상품 판매가 상품의 판매 가격. 쿠폰 및 혜택을 적용하기 전의 가격. 상품 등록시엔 모든 멀티 쇼핑몰에 동일한 가격으로 등록하며, 멀티쇼핑몰별로 다른 가격을 입력하고자 할 경우 상품 수정을 통해 가격을 다르게 입력할 수 있다. ※ 판매가 = [ 공급가 + (공급가 * 마진율) + 추가금액 ]
product_bundle	세트상품 여부
created_date timezone	담은일자 관심상품을 담은 일자
price_content 최대글자수 : [20자]	판매가 대체문구

List all customers wishlist

GET

회원의 관심상품 목록 조회

기본스펙

Property	Description
SCOPE	개인화정보 읽기권한 (mall.read_personal)
호출건수 제한	40

요청사양

Parameter

Description

member_id
Required

회원아이디

shop_no

멀티쇼핑몰 번호

DEFAULT 1

Definition Copy

Request example: Copy

Response example:

Count all customers wishlist

GET

회원의 관심상품 수 조회

기본스펙

Property	Description
SCOPE	개인화정보 읽기권한 (mall.read_personal)
호출건수 제한	40

요청사양

Parameter

Description

member_id
Required

회원아이디

shop_no

멀티쇼핑몰 번호

DEFAULT 1

Definition Copy

Request example: Copy

Response example:

Products carts

Endpoints

GET /api/v2/admin/products/{product_no}/carts
GET /api/v2/admin/products/{product_no}/carts/count

Products carts properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
member_id	회원아이디
created_date timezone	담은일자
product_no	상품번호
variant_code	상품 품목 코드
quantity	수량
product_bundle	세트상품 여부 T : 세트상품 F : 세트상품 아님

List all products carts

GET

기본스펙

Property	Description
SCOPE	개인화정보 읽기권한 (mall.read_personal)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
product_no Required	상품번호
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10
offset 최대값: [10000]	조회결과 시작위치

Definition Copy

Request example: Copy

Response example:

Count all products carts

GET

기본스펙

Property	Description
SCOPE	개인화정보 읽기권한 (mall.read_personal)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

Definition Copy

Request example: Copy

Response example:

Order

Cancellation

Endpoints

GET /api/v2/admin/cancellation/{claim_code}
POST /api/v2/admin/cancellation

Cancellation properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
order_id	주문번호
claim_code	취소 번호
claim_reason_type	구분 상세 조회시에만 확인 가능하다. A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
claim_reason	사유 상세 조회시에만 확인 가능하다.
refund_method	환불 방식 상세 조회시에만 확인 가능하다.
refund_reason	비고 상세 조회시에만 확인 가능하다.
order_price_amount	상품구매금액 상세 조회시에만 확인 가능하다.
refund_amount	환불금액 상세 조회시에만 확인 가능하다.
shipping_fee	배송비 상세 조회시에만 확인 가능하다.
return_ship_type	반품배송비 적용구분 상세 조회시에만 확인 가능하다.
defer_commission	후불 결제 수수료 상세 조회시에만 확인 가능하다.
partner_discount_amount	제휴할인 취소액 상세 조회시에만 확인 가능하다.
add_discount_amount	상품별추가할인 취소액 상세 조회시에만 확인 가능하다.
member_grade_discount_amount	회원등급할인 취소액 상세 조회시에만 확인 가능하다.
shipping_discount_amount	배송비할인 취소액 상세 조회시에만 확인 가능하다.
coupon_discount_amount	쿠폰할인 취소액 상세 조회시에만 확인 가능하다.
point_used	사용된 적립금 반환액 상세 조회시에만 확인 가능하다.
credit_used	사용된 예치금 반환액 상세 조회시에만 확인 가능하다.
items	품주코드
status	주문상태 canceled : 취소완료

Get a cancellation

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

claim_code
Required

취소번호

Definition Copy

Request example: Copy

Response example:

Create cancellation

POST

배송 전의 여러 주문을 취소 처리할 수 있는 API입니다. 해당 API를 사용하여 취소 처리할 경우 환불완료 처리 되지만 PG 취소까지는 진행되지 않으며 솔루션에서 별도 PG 취소처리를 해주어야 합니다.

부분취소할 경우 각 환불 금액은 자동 계산되어 환불처리됩니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
status Required	주문상태 canceled : 취소완료
recover_inventory	재고복구 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon	쿠폰 복원 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가 T : 복구함 F : 복구안함 DEFAULT F
add_memo_too	관리자 메모에도 추가 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가 T : 사용함 F : 사용안함 DEFAULT F
reason 최대글자수 : [2000자]	취소사유
claim_reason_type	취소사유 구분 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가 A : 고객변심 B : 배송지연 C : 배송불가지역 L : 수출/통관 불가 D : 포장불량 E : 상품불만족 F : 상품정보상이 G : 서비스불만족 H : 품절 I : 기타
naverpay_cancel_reason_type	네이버페이 취소사유 구분 쇼핑몰/오픈마켓 주문을 취소할 경우 사용 불가 EC 베트남, 필리핀 버전에서는 사용할 수 없음. 51 : 구매 의사 취소 52 : 색상 및 사이즈 변경 53 : 다른 상품 잘못 주문 54 : 서비스 및 상품 불만족 55 : 배송 지연 56 : 상품 품절 60 : 상품 정보 상이
refund_method_code	환불 방식 T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 I : 기타
combined_refund_method	복합 환불 방식 결제수단이 복수인 주문(카드 등으로 결제한 주문을 결제 후 품목을 추가한 경우)의 환불수단(refund_method_code)을 신용카드/계좌이체/휴대폰 등 주 결제수단으로 환불할 경우 나머지 금액을 환불 받을 수 있는 복합환불수단을 입력할 수 있다. 환불수단을 현금/적립금/예치금 등 현금성 환불 수단으로 하거나 환불 금액이 PG 결제 금액보다 작을 경우 모든 금액이 주결제 수단으로 취소되므로 복합환불 수단은 기입하지 않는다. 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가 T : 현금 M : 적립금 D : 예치금
refund_bank_code	환불 은행 코드 환불 방식(refund_method)이 현금(T)일 경우 필수 refund_bank_code 해당 쇼핑몰이 EC Korea 쇼핑몰일 경우 필수 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가
refund_bank_name 최대글자수 : [250자]	환불은행명 환불 방식(refund_method)이 현금(T)일 경우 필수 ※ 해당 쇼핑몰이 EC Global 쇼핑몰일 경우 필수 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가
refund_bank_account_no 최대글자수 : [50자]	환불 계좌번호 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
items	품주코드
order_item_code 품주코드 Required quantity 수량 Required

Definition Copy

Request example: Copy

Response example:

Cashreceipt

Endpoints

GET /api/v2/admin/cashreceipt
POST /api/v2/admin/cashreceipt
PUT /api/v2/admin/cashreceipt/{cashreceipt_no}

Cashreceipt properties

Attribute	Description
cashreceipt_no	현금영수증 번호
approval_no	승인번호
request_date	신청일자
order_id	주문번호
member_id	회원아이디
name	요청자 이름
order_price_amount	상품구매금액
vat	부가세
subtotal	총 신청금액
order_status	주문상태 입금전: unpaid 미배송: unshipped 배송중: shipping 배송대기: standby 배송완료: shipped 부분취소: partially_canceled 전체취소: canceled
status	처리상태 신청: request 발행대기: await_issuance 발행: issued 발행거부: issuance_rejected 신청취소: canceled_request 발행취소: canceled_issuance 발행실패: failed_issuance
type	발행 타입 개인: personal 사업자: business
company_registration_no	사업자등록번호
cellphone	휴대전화
tax_amount	과세금액
tax_free_amount	면세금액
supply_price	공급가액

List all cashreceipt

GET

해당 API는 한국어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
start_date Required 날짜 timezone	검색 시작일
end_date Required 날짜 timezone	검색 종료일
order_id 주문번호	주문번호
approval_no 최대글자수 : [9자]	승인번호
name 최대글자수 : [20자]	요청자 이름
member_id 최대글자수 : [20자]	회원아이디
status	처리상태 전체: all 신청: request 발행: issued 신청취소: canceled_request 발행취소: canceled_issuance 발행실패: failed_issuance DEFAULT all
limit 최소: [1]~최대: [500]	조회결과 최대건수 DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치

Definition Copy

Request example: Copy

Response example:

Create a cashreceipt

POST

해당 API는 한국어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
order_id Required 주문번호	주문번호
type Required	발행 타입 개인: personal 사업자: business
company_registration_no 사업자번호 최대글자수 : [10자]	사업자등록번호
cellphone 모바일 최대글자수 : [11자]	휴대전화

Definition Copy

Request example: Copy

Response example:

Update a cashreceipt

PUT

해당 API는 한국어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
cashreceipt_no Required 최소값: [1]	현금영수증 번호
order_id Required 주문번호	주문번호
type	발행 타입 개인: personal 사업자: business
company_registration_no 사업자번호 최대글자수 : [10자]	사업자등록번호
cellphone 모바일 최대글자수 : [11자]	휴대전화

Definition Copy

Request example: Copy

Response example:

Cashreceipt cancellation

Endpoints

PUT /api/v2/admin/cashreceipt/{cashreceipt_no}/cancellation

Cashreceipt cancellation properties

Attribute

Description

cashreceipt_no

현금영수증 번호

order_id

주문번호

status

처리상태

신청취소: canceled_request
발행취소: canceled_issuance

Update a cashreceipt cancellation

PUT

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

cashreceipt_no
Required

최소값: [1]

현금영수증 번호

order_id
Required

주문번호

주문번호

type
Required

취소 타입

신청취소: request
발행취소: issue

Definition Copy

Request example: Copy

Response example:

Collectrequests

Endpoints

PUT /api/v2/admin/collectrequests/{request_no}

Collectrequests properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
request_no	요청 번호
order_id	주문번호
order_item_code	품주코드
shipping_company_name	수거 배송사명
collect_tracking_no	수거 송장 번호

Update a collectrequest

PUT

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	30
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

request_no
Required

요청 번호

collect_tracking_no
Required

최대글자수 : [30자]

수거 송장 번호

Definition Copy

Request example: Copy

Response example:

Exchange

Endpoints

GET /api/v2/admin/exchange/{claim_code}

Exchange properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 상세 조회시에만 확인 가능하다.
order_id	주문번호 상세 조회시에만 확인 가능하다.
claim_code	교환번호 상세 조회시에만 확인 가능하다.
claim_reason_type	구분 상세 조회시에만 확인 가능하다. A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
claim_reason	사유 상세 조회시에만 확인 가능하다.
claim_due_date	교환처리 예정일 상세 조회시에만 확인 가능하다.
receiver	수령자 상세 조회시에만 확인 가능하다.
reshipping_detail	교환 재발송 정보 상세 조회시에만 확인 가능하다.
pickup	수거지 - 주소 상세 조회시에만 확인 가능하다.
additional_payment	추가결제 상세 조회시에만 확인 가능하다.
return_invoice_no	반품 송장 번호 상세 조회시에만 확인 가능하다.
return_shipping_company_name	반품 배송업체명 상세 조회시에만 확인 가능하다.
refund_method	환불 방식 상세 조회시에만 확인 가능하다.
refund_reason	비고 상세 조회시에만 확인 가능하다.
order_price_amount	상품구매금액 상세 조회시에만 확인 가능하다.
refund_amount	환불금액 상세 조회시에만 확인 가능하다.
shipping_fee	배송비 상세 조회시에만 확인 가능하다.
return_ship_type	반품배송비 적용구분 상세 조회시에만 확인 가능하다.
defer_commission	후불 결제 수수료 상세 조회시에만 확인 가능하다.
partner_discount_amount	제휴할인 취소액 상세 조회시에만 확인 가능하다.
add_discount_amount	상품별추가할인 취소액 상세 조회시에만 확인 가능하다.
member_grade_discount_amount	회원등급할인 취소액 상세 조회시에만 확인 가능하다.
shipping_discount_amount	배송비할인 취소액 상세 조회시에만 확인 가능하다.
coupon_discount_amount	쿠폰할인 취소액 상세 조회시에만 확인 가능하다.
point_used	사용된 적립금 반환액 상세 조회시에만 확인 가능하다.
credit_used	사용된 예치금 반환액 상세 조회시에만 확인 가능하다.
items	품주 리소스 상세 조회시에만 확인 가능하다.
exchanged_items	교환상품 상세 조회시에만 확인 가능하다.

Get an exchange

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

claim_code
Required

교환번호

Definition Copy

Request example: Copy

Response example:

Orders

Orders 리소스 관계도

주문(order)은 쇼핑몰에서 쇼핑몰 고객이 상품을 구입하기 위해 쇼핑몰에 요청한 내역입니다. 쇼핑몰 운영자는 결제가 완료된 주문 정보를 참고하여 쇼핑몰 고객에게 물건을 배송합니다. 주문 정보에는 주문과 결제를 진행한 주문자의 정보와 상품을 배송 받을 수령자 정보가 포함됩니다.

주문은 다음과 같은 리소스를 하위 리소스로 갖고 있습니다.
● 품주(Items)
● 수령자정보(Receivers)

Endpoints

GET /api/v2/admin/orders
GET /api/v2/admin/orders/count
GET /api/v2/admin/orders/{order_id}
PUT /api/v2/admin/orders/{order_id}
PUT /api/v2/admin/orders

Orders properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
currency	화폐단위 해당 멀티쇼핑몰의 화폐단위
order_id	주문번호
market_id	마켓 구분값 가격 비교 사이트를 통하여 마켓 등에서 상품 구매 시 해당 사이트를 구분하기 위한 ID
market_order_info	마켓 기타 정보 마켓 또는 주문경로에 대한 기타 정보
member_id	회원아이디
member_email	회원 이메일
member_authentication	회원인증여부 회원 인증여부. 인증여부에 따라 3가지로 회원타입이 나눠짐. T : 승인 B : 특별관리회원 J : 14세미만회원
billing_name	결제자명 입금자 이름. 주문자 혹은 수령자 이름과는 다를 수 있음.
bank_code	은행코드 bank_code
bank_code_name	입금자 은행명
payment_method	결제수단 코드 주문자가 이용한 결제수단의 코드 cash : 무통장 card : 신용카드 cell : 휴대폰 tcash : 계좌이체 icash : 가상계좌 prepaid : 선불금 credit : 예치금 point : 적립금 pointfy : 통합포인트 cvs : 편의점 cod : 후불 coupon : 쿠폰 market_discount : 마켓할인 etc : 기타
payment_method_name	결제수단명 주문자가 이용한 결제수단의 이름
payment_gateway_name	PG 이름 주문자가 이용한 PG 사의 이름
sub_payment_method_name	해외 결제수단명
sub_payment_method_code	해외 결제수단코드 sub_payment_method_code
paid	결제 여부 결제가 완료되었는지 여부 T : 결제 F : 미결제 M : 부분 결제
order_date timezone	주문일
first_order	최초 주문여부 해당 주문이 최초 주문인지 여부 T : 최초 주문 F : 최초 주문 아님
payment_date timezone	결제일
order_from_mobile	모바일 구분 주문이 모바일에서 이루어졌는지 여부 T : 모바일 주문 F : 모바일 주문 아님
use_escrow	에스크로 사용여부 에스크로를 사용했는지 여부 T : 에스크로 사용 F : 에스크로 미사용
group_no_when_ordering	주문시 회원등급
initial_order_amount	최초 주문 금액
actual_order_amount	현재 주문 금액
bank_account_no	계좌번호 해당 주문건에 대한 쇼핑몰의 계좌번호
bank_account_owner_name	예금주
market_seller_id	마켓 판매자 아이디
payment_amount	최종 결제 금액
cancel_date timezone	주문취소일
order_place_name	주문경로 텍스트
order_place_id	주문경로
payment_confirmation	후불결제 입금확인 가능 여부 T : 입금확인 F : 입금미확인
commission	결제 수수료
postpay	후불결제여부 T : 후불결제 F : 후불결제 아님
admin_additional_amount	관리자 입력 금액
additional_shipping_fee	추가 배송비
international_shipping_insurance	해외배송 보험료
additional_handling_fee	해외배송 부가금액
shipping_type	배송 유형 배송 유형. 국내배송인지 해외배송인지 둘 다 가능한지 여부. A : 국내 B : 해외
shipping_type_text	배송 유형명 배송 유형의 설명. 국내배송인지 해외배송인지 둘 다 가능한지 여부.
shipping_status	배송상태 F : 배송전 M : 배송중 T : 배송완료 W : 배송보류
wished_delivery_date	희망배송일
wished_delivery_time	희망배송시간
wished_carrier_id	희망배송사 코드
wished_carrier_name	희망배송사 명
return_confirmed_date timezone	반품승인일시
total_supply_price	총 공급가액
naver_point	네이버포인트
additional_order_info_list	주문서 추가항목
store_pickup	매장수령여부 T : 매장수령 F : 매장수령 아님
easypay_name	간편결제 결제사 이름
loan_status	여신상태 OK : GOOD NG : NOT GOOD ER : ERROR
subscription	정기결제 여부 T : 정기결제 F : 정기결제 아님
items	품주 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
receivers	수령자정보 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
buyer	주문자정보 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
shipping_fee_detail	배송비 정보
regional_surcharge_detail	지역별 배송비 정보
return	반품상세 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
cancellation	취소상세 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
exchange	교환상세 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
multiple_addresses	멀티 배송지 여부 T : 멀티 배송지 주문 F : 멀티 배송지 주문 아님
exchange_rate	결제 화폐 환율 정보
first_payment_method	최초 결제수단 코드 cash : 무통장 card : 신용카드 cell : 휴대폰 tcash : 계좌이체 icash : 가상계좌 prepaid : 선불금 credit : 예치금 point : 적립금 pointfy : 통합포인트 cvs : 편의점 cod : 후불 etc : 기타
naverpay_payment_information	네이버페이 PG 결제 정보 P : PG결제 N : 네이버결제
customer_group_no_when_ordering	주문시 회원등급 주문 당시의 회원등급 상세 조회시에만 확인 가능하다.
benefits	혜택 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다. 상세 조회시에만 확인 가능하다.
coupons	쿠폰 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다. 상세 조회시에만 확인 가능하다.
refunds	환불상세 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다. 상세 조회시에만 확인 가능하다.
process_status	주문상태 prepare : 배송준비중 prepareproduct : 상품준비중 hold : 배송보류 unhold : 배송보류해제
order_item_code	품주코드

List all orders

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
items embed	품주 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
receivers embed	수령자정보 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
buyer embed	주문자정보 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
return embed	반품상세 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
cancellation embed	취소상세 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
exchange embed	교환상세 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
start_date Required 날짜 timezone	검색 시작일 검색을 시작할 기준일
end_date Required 날짜 timezone	검색 종료일 검색을 종료할 기준일 검색 시작일과 같이 사용해야함.
order_id 주문번호	주문번호 ,(콤마)로 여러 건을 검색할 수 있다.
order_status	주문상태 주문상태. 주문 상태별로 각각의 코드가 있음. ,(콤마)로 여러 건을 검색할 수 있다. N00 : 입금전 N10 : 상품준비중 N20 : 배송준비중 N21 : 배송대기 N22 : 배송보류 N30 : 배송중 N40 : 배송완료 C00 : 취소신청 C10 : 취소접수 - 관리자 C34 : 취소처리중 - 환불전 C36 : 취소처리중 - 환불보류 C40 : 취소완료 C47 : 입금전취소 - 구매자 C48 : 입금전취소 - 자동취소 C49 : 입금전취소 - 관리자 R00 : 반품신청 R10 : 반품접수 R12 : 반품보류 R30 : 반품처리중 - 수거전 R34 : 반품처리중 - 환불전 R36 : 반품처리중 - 환불보류 R40 : 반품완료 - 환불완료 E00 : 교환신청 E10 : 교환접수 E12 : 교환보류 E20 : 교환준비 E30 : 교환처리중 - 수거전 E32 : 교환처리중 - 입금전 E34 : 교환처리중 - 환불전 E36 : 교환처리중 - 환불보류 E40 : 교환완료
member_type	회원여부 회원여부. 회원과 비회원 각각의 코드가 있음. 2 : 회원 3 : 비회원
group_no	회원등급번호
buyer_name	주문자명 주문자 이름. 입금자 혹은 수령자 이름과는 다를 수 있음.
receiver_name	수령자명 수령자 이름. 주문자 혹은 입금자 이름과는 다를 수 있음.
name_furigana	수령자명 (발음)
receiver_address	수령자주소 수령자 주소. 주문자 혹은 입금자 주소와는 다를 수 있음.
member_id	회원아이디 회원 아이디
member_email	회원 이메일
product_no	상품번호 상품 번호
product_code	상품코드 상품 코드
date_type	검색날짜 유형 검색을 위한 날짜 유형 기준. 기본값은 주문일로 설정되어 있음. order_date : 주문일 pay_date : 결제일 shipbegin_date : 배송시작일 shipend_date : 배송완료일 cancel_date : 주문취소일 place_date : 발주일 updatereceiver_date : 수령자정보 수정일 cancel_complete_date : 취소완료일 exchange_request_date : 교환신청일 exchange_accept_date : 교환접수일 exchange_complete_date : 교환완료일 return_request_date : 반품신청일 return_accept_date : 반품접수일 return_complete_date : 반품완료일 DEFAULT order_date
supplier_id	공급사 아이디 ,(콤마)로 여러 건을 검색할 수 있다.
order_place_id	주문경로 ,(콤마)로 여러 건을 검색할 수 있다. cafe24:카페24 mobile:모바일웹 mobile_d:모바일앱 NCHECKOUT:네이버페이 inpark:인터파크 auction:옥션 sk11st:11번가 gmarket:G마켓 coupang:쿠팡 shopn:스마트스토어
buyer_cellphone	주문자 휴대 전화
buyer_phone	주문자 일반 전화
buyer_email	주문자 이메일
inflow_path	유입경로
subscription	정기결제 여부 T : 정기결제 F : 정기결제 아님
market_cancel_request	마켓 취소요청 여부 T : 취소 요청된 마켓 주문
payment_method	결제수단 코드 ,(콤마)로 여러 건을 검색할 수 있다. cash : 무통장 card : 신용카드 tcash : 계좌이체 icash : 가상계좌 cell : 휴대폰 deferpay : 후불 cvs : 편의점 point : 선불금 mileage : 적립금 deposit : 예치금 etc : 기타
payment_gateway_name	PG 이름 ,(콤마)로 여러 건을 검색할 수 있다.
market_seller_id	마켓 판매자 아이디
limit 최소: [1]~최대: [500]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치

Definition Copy

Request example: Copy

Response example:

Count all orders

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
start_date Required 날짜 timezone	검색 시작일 검색을 시작할 기준일
end_date Required 날짜 timezone	검색 종료일 검색을 종료할 기준일 검색 시작일과 같이 사용해야함.
order_id 주문번호	주문번호 ,(콤마)로 여러 건을 검색할 수 있다.
order_status	주문상태 주문상태. 주문 상태별로 각각의 코드가 있음. ,(콤마)로 여러 건을 검색할 수 있다. N00 : 입금전 N10 : 상품준비중 N20 : 배송준비중 N21 : 배송대기 N22 : 배송보류 N30 : 배송중 N40 : 배송완료 C00 : 취소신청 C10 : 취소접수 - 관리자 C34 : 취소처리중 - 환불전 C36 : 취소처리중 - 환불보류 C40 : 취소완료 C47 : 입금전취소 - 구매자 C48 : 입금전취소 - 자동취소 C49 : 입금전취소 - 관리자 R00 : 반품신청 R10 : 반품접수 R12 : 반품보류 R30 : 반품처리중 - 수거전 R34 : 반품처리중 - 환불전 R36 : 반품처리중 - 환불보류 R40 : 반품완료 - 환불완료 E00 : 교환신청 E10 : 교환접수 E12 : 교환보류 E20 : 교환준비 E30 : 교환처리중 - 수거전 E32 : 교환처리중 - 입금전 E34 : 교환처리중 - 환불전 E36 : 교환처리중 - 환불보류 E40 : 교환완료
member_type	회원여부 회원여부. 회원과 비회원 각각의 코드가 있음. 2 : 회원 3 : 비회원
group_no	회원등급번호
buyer_name	주문자명 주문자 이름. 입금자 혹은 수령자 이름과는 다를 수 있음.
receiver_name	수령자명 수령자 이름. 주문자 혹은 입금자 이름과는 다를 수 있음.
name_furigana	수령자명 (발음)
receiver_address	수령자주소 수령자 주소. 주문자 혹은 입금자 주소와는 다를 수 있음.
member_id	회원아이디 회원 아이디
member_email	회원 이메일
product_no	상품번호 상품 번호
product_code	상품코드 검색어를 상품코드에 포함하고 있는 상품 검색(대소문자 구분 필요)
date_type	검색날짜 유형 검색을 위한 날짜 유형 기준. 기본값은 주문일로 설정되어 있음. order_date : 주문일 pay_date : 결제일 shipbegin_date : 배송시작일 shipend_date : 배송완료일 cancel_date : 주문취소일 place_date : 발주일 updatereceiver_date : 수령자정보 수정일 cancel_complete_date : 취소완료일 exchange_request_date : 교환신청일 exchange_accept_date : 교환접수일 exchange_complete_date : 교환완료일 return_request_date : 반품신청일 return_accept_date : 반품접수일 return_complete_date : 반품완료일 DEFAULT order_date
supplier_id	공급사 아이디 ,(콤마)로 여러 건을 검색할 수 있다.
order_place_id	주문경로 ,(콤마)로 여러 건을 검색할 수 있다. cafe24:카페24 mobile:모바일웹 mobile_d:모바일앱 NCHECKOUT:네이버페이 inpark:인터파크 auction:옥션 sk11st:11번가 gmarket:G마켓 coupang:쿠팡 shopn:스마트스토어
buyer_cellphone	주문자 휴대 전화
buyer_phone	주문자 일반 전화
buyer_email	주문자 이메일
inflow_path	유입경로
subscription	정기결제 여부 T : 정기결제 F : 정기결제 아님
market_cancel_request	마켓 취소요청 여부 T : 취소 요청된 마켓 주문
payment_method	결제수단 코드 ,(콤마)로 여러 건을 검색할 수 있다. cash : 무통장 card : 신용카드 tcash : 계좌이체 icash : 가상계좌 cell : 휴대폰 deferpay : 후불 cvs : 편의점 point : 선불금 mileage : 적립금 deposit : 예치금 etc : 기타
payment_gateway_name	PG 이름 ,(콤마)로 여러 건을 검색할 수 있다.
market_seller_id	마켓 판매자 아이디

Definition Copy

Request example: Copy

Response example:

Get an order

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
items embed	품주 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
receivers embed	수령자정보 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
buyer embed	주문자정보 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
benefits embed	혜택 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
coupons embed	쿠폰 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
return embed	반품상세 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
cancellation embed	취소상세 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
exchange embed	교환상세 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
refunds embed	환불상세 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.

Definition Copy

Request example: Copy

Response example:

Update an order

PUT

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
process_status Required	주문상태 prepare : 배송준비중 prepareproduct : 상품준비중 hold : 배송보류 unhold : 배송보류해제
order_item_code	품주코드

Definition Copy

Request example: Copy

Response example:

Update orders

PUT

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
process_status Required	주문상태 prepare : 배송준비중 prepareproduct : 상품준비중 hold : 배송보류 unhold : 배송보류해제
order_item_code	품주코드

Definition Copy

Request example: Copy

Response example:

Orders autocalculation

Endpoints

DELETE /api/v2/admin/orders/{order_id}/autocalculation

Orders autocalculation properties

Attribute

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id

주문번호

Delete an orders autocalculation

DELETE

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

Definition Copy

Request example: Copy

Response example:

Orders buyer

구매자(Buyer)는 주문을 한 주문자의 이름, 연락처, 주소 정보 등을 나타냅니다. 구매자 정보는 하위 리소스로서 주문(Order) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/{order_id}/buyer
PUT /api/v2/admin/orders/{order_id}/buyer

Orders buyer properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
member_id	회원아이디
member_group_no	주문당시 주문자 회원 등급 번호
name	주문자명
names_furigana	주문자 이름 후리가나
email	주문자 이메일 해당 회원의 이메일
phone	주문자 일반 전화
cellphone	주문자 휴대 전화
customer_notification	고객 알림 고객에게 알릴 문구
updated_date timezone	수정일
user_id	주문자 수정자 ID 주문자정보를 수정한 사람의 ID
user_name	주문자 수정자 명 주문자정보를 수정한 사람의 이름
order_id 주문번호	주문번호

Get an orders buyer

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

Definition Copy

Request example: Copy

Response example:

Update an orders buyer

PUT

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
order_id Required 주문번호	주문번호
name	주문자명
email 이메일	주문자 이메일 해당 회원의 이메일
phone	주문자 일반 전화
cellphone	주문자 휴대 전화
customer_notification	고객 알림 고객에게 알릴 문구

Definition Copy

Request example: Copy

Response example:

Orders buyer history

Endpoints

GET /api/v2/admin/orders/{order_id}/buyer/history

Orders buyer history properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
name	주문자명
email 이메일	주문자 이메일
phone	주문자 일반 전화
cellphone	주문자 휴대 전화
customer_notification	고객 알림
updated_date timezone	수정일
user_id	주문자 수정자 ID
user_name	주문자 수정자 명

List all orders buyer history

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

Definition Copy

Request example: Copy

Response example:

Orders cancellation

Endpoints

POST /api/v2/admin/orders/{order_id}/cancellation

Orders cancellation properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
order_id	주문번호
status	주문상태 canceled : 취소완료
claim_code	취소 번호
items	품주코드

Create an orders cancellation

POST

배송 전의 특정 주문 하나를 취소 처리할 수 있는 API입니다. 해당 API를 사용하여 취소완료처리할 경우 환불완료 처리와 함께 PG 취소도 같이 진행할 수 있습니다.(payment_gateway_cancel : "T"로 요청시)

부분취소할 경우 각 환불 금액은 자동 계산되어 환불처리됩니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
payment_gateway_cancel	PG 취소 요청 여부 주문을 취소함과 동시에 PG취소도 같이 처리할 수 있다. 결제수단이 복수인 주문(카드 등으로 결제한 주문을 결제 후 품목을 추가한 경우)의 경우에는 PG 결제를 취소할 수 없으며 관리자 화면에서 취소해야 한다. 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가 T : 취소함 F : 취소안함 DEFAULT F
status Required	주문상태 canceled : 취소완료
recover_inventory	재고복구 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon	쿠폰 복원 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가 T : 복구함 F : 복구안함 DEFAULT F
add_memo_too	관리자 메모에도 추가 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가 T : 사용함 F : 사용안함 DEFAULT F
reason 최대글자수 : [2000자]	취소사유
claim_reason_type	취소사유 구분 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가 A : 고객변심 B : 배송지연 C : 배송불가지역 L : 수출/통관 불가 D : 포장불량 E : 상품불만족 F : 상품정보상이 G : 서비스불만족 H : 품절 I : 기타
naverpay_cancel_reason_type	네이버페이 취소사유 구분 쇼핑몰/오픈마켓 주문을 취소할 경우 사용 불가 EC 베트남, 필리핀 버전에서는 사용할 수 없음. 51 : 구매 의사 취소 52 : 색상 및 사이즈 변경 53 : 다른 상품 잘못 주문 54 : 서비스 및 상품 불만족 55 : 배송 지연 56 : 상품 품절 60 : 상품 정보 상이
refund_method_code	환불 방식 T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 I : 기타
combined_refund_method	복합 환불 방식 결제수단이 복수인 주문(카드 등으로 결제한 주문을 결제 후 품목을 추가한 경우)의 환불수단(refund_method_code)을 신용카드/계좌이체/휴대폰 등 주 결제수단으로 환불할 경우 나머지 금액을 환불 받을 수 있는 복합환불수단을 입력할 수 있다.(이 경우, payment_gateway="F"만 사용 가능하다.) 환불수단을 현금/적립금/예치금 등 현금성 환불 수단으로 하거나 환불 금액이 PG 결제 금액보다 작을 경우 모든 금액이 주결제 수단으로 취소되므로 복합환불 수단은 기입하지 않는다. 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가 T : 현금 M : 적립금 D : 예치금
refund_bank_code	환불 은행 코드 환불 방식(refund_method)이 현금(T)일 경우 필수 refund_bank_code 해당 쇼핑몰이 EC Korea 쇼핑몰일 경우 필수 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가
refund_bank_name 최대글자수 : [250자]	환불은행명 환불 방식(refund_method)이 현금(T)일 경우 필수 ※ 해당 쇼핑몰이 EC Global 쇼핑몰일 경우 필수 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가
refund_bank_account_no 최대글자수 : [50자]	환불 계좌번호 환불 방식(refund_method)이 현금(T)일 경우 필수 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
items	품주코드
order_item_code 품주코드 Required quantity 수량 Required

Definition Copy

Request example: Copy

Response example:

Orders inflowgroups

Endpoints

GET /api/v2/admin/orders/inflowgroups
POST /api/v2/admin/orders/inflowgroups
PUT /api/v2/admin/orders/inflowgroups/{inflow_group_id}
DELETE /api/v2/admin/orders/inflowgroups/{inflow_group_id}

Orders inflowgroups properties

Attribute	Description
inflow_group_id	유입경로 그룹 아이디
inflow_group_name	유입경로 그룹 이름

List all orders inflowgroups

GET

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

Definition Copy

Request example: Copy

Response example:

Create an orders inflowgroup

POST

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
inflow_group_id Required 최대글자수 : [40자] 형식 : [a-zA-Z0-9]	유입경로 그룹 아이디
inflow_group_name Required 최대글자수 : [100자]	유입경로 그룹 이름

Definition Copy

Request example: Copy

Response example:

Update an orders inflowgroup

PUT

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
inflow_group_id Required 형식 : [a-zA-Z0-9] 최대글자수 : [40자]	유입경로 그룹 아이디
inflow_group_name Required 최대글자수 : [100자]	유입경로 그룹 이름

Definition Copy

Request example: Copy

Response example:

Delete an orders inflowgroup

DELETE

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40

요청사양

Parameter	Description
inflow_group_id Required 최대글자수 : [40자] 형식 : [a-zA-Z0-9]	유입경로 그룹 아이디

Definition Copy

Request example: Copy

Response example:

Orders inflowgroups inflows

Endpoints

GET /api/v2/admin/orders/inflowgroups/{group_id}/inflows
POST /api/v2/admin/orders/inflowgroups/{group_id}/inflows
PUT /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}
DELETE /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}

Orders inflowgroups inflows properties

Attribute	Description
inflow_id	유입경로 그룹 멤버 아이디
inflow_name	유입경로 그룹 멤버 이름
inflow_icon	유입경로 아이콘
group_id	유입경로 그룹 아이디

List all orders inflowgroups inflows

GET

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
group_id Required 최대글자수 : [40자]	유입경로 그룹 아이디

Definition Copy

Request example: Copy

Response example:

Create an orders inflowgroups inflow

POST

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
group_id Required 최대글자수 : [40자]	유입경로 그룹 아이디
inflow_id Required 최대글자수 : [40자]	유입경로 그룹 멤버 아이디
inflow_name Required 최대글자수 : [100자]	유입경로 그룹 멤버 이름
inflow_icon Required URL 최대글자수 : [500자]	유입경로 아이콘

Definition Copy

Request example: Copy

Response example:

Update an orders inflowgroups inflow

PUT

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
group_id Required 최대글자수 : [40자]	유입경로 그룹 아이디
inflow_id Required 최대글자수 : [40자]	유입경로 그룹 멤버 아이디
inflow_name Required 최대글자수 : [100자]	유입경로 그룹 멤버 이름
inflow_icon Required URL 최대글자수 : [500자]	유입경로 아이콘

Definition Copy

Request example: Copy

Response example:

Delete an orders inflowgroups inflow

DELETE

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40

요청사양

Parameter	Description
group_id Required 최대글자수 : [40자]	유입경로 그룹 아이디
inflow_id Required 최대글자수 : [40자]	유입경로 그룹 멤버 아이디

Definition Copy

Request example: Copy

Response example:

Orders items

품주(Items)는 쇼핑몰 고객이 주문할 때 구매한 품목 정보입니다. 쇼핑몰의 품목은 쇼핑몰에서 판매하는 상품의 기본 단위로, 품주에는 구입한 상품의 품목 정보와 더불어, 구매시 선택한 옵션, 주문 수량 등의 정보를 추가로 확인할 수 있습니다.
품주는 하위 리소스로서 주문(Order) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/{order_id}/items
PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}

Orders items properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
item_no	품주 아이디 품목별 주문번호의 아이디
order_item_code	품주코드 품목별 주문번호의 코드
variant_code	품목코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않음.
product_no	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
product_code	상품코드 시스템이 상품에 부여한 코드. 해당 쇼핑몰 내에서 상품코드는 중복되지 않음.
custom_product_code 최대글자수 : [40자]	자체상품 코드
custom_variant_code	자체 품목 코드
eng_product_name	영문 상품명 상품의 영문 이름. 해외 배송 등에 사용 가능함.
option_id	상품옵션 아이디 상품옵션의 아이디
option_value	옵션값 주문한 상품의 옵션값
option_value_default	기본옵션값
additional_option_value	추가입력 옵션 값
additional_option_values	추가입력 옵션 목록
product_name	상품명 상품의 이름. 상품명은 상품을 구분하는 가장 기초적인 정보이며 검색 정보가 됨.
product_name_default	기본 상품명
product_price	상품 판매가 상품의 판매가. 멀티쇼핑몰 운영 시에는 판매가를 쇼핑별 화폐단위로 환산하여 보여줌.
option_price	옵션 추가 가격 옵션별로 해당하는 추가 가격이 있을 경우 그 추가가격.
additional_discount_price	상품추가할인액 상품에 대한 추가 할인금액
coupon_discount_price	상품별 쿠폰 할인금액
app_item_discount_amount	앱 상품할인금액
actual_payment_amount	품목별 실결제금액 상점관리 > 운영방식설정 > 주문 관련 설정 > '취소/교환/반품 접수 시 할인/적립금액 설정'이 "할인금액 자동계산"일 경우 사용 가능
quantity	수량 주문한 상품의 수량
product_tax_type	상품 세금 구분 A : 과세 B : 면세 C : 비과세
tax_amount	과세율
supplier_product_name	공급사 상품명 공급사의 상품명
supplier_transaction_type	공급사 거래 유형 공급사의 거래 유형 D: 직등록형 P: 수수료형
supplier_id	공급사 아이디 공급사의 아이디
supplier_name	공급사명 공급사의 이름
tracking_no	송장번호
shipping_code	배송번호 배송번호. 품목별 주문번호를 배송준비중으로 처리하면 시스템이 자동으로 부여하는 번호.
claim_code	취소/교환/반품 번호
claim_reason_type	취소/교환/반품 요청 사유 타입 구매자의 취소/교환/반품 신청 사유 구분. 판매자의 접수 사유는 각 취소/교환/반품 리소스의 claim_reason_type으로 조회할 수 있다.
claim_reason	취소/교환/반품 요청 사유 구매자의 취소/교환/반품 신청 사유 상세 내용. 판매자의 접수 사유는 각 취소/교환/반품 리소스의 claim_reason으로 조회할 수 있다.
refund_bank_name	환불은행명
refund_bank_account_no	환불 계좌번호
refund_bank_account_holder	환불계좌 예금주 명의
post_express_flag	우체국 택배연동 우체국 택배연동 상태
order_status	주문상태 주문상태. 주문 상태별로 각각의 코드가 있음.
request_undone	철회상태 Cancellation : 취소철회 Exchange : 교환철회 Return : 반품철회
order_status_additional_info	주문상태 추가정보 주문상태의 추가정보
claim_quantity	취소/교환/반품 요청 수량
status_code	현재 처리상태 코드 현재 처리상태의 코드 N1 : 정상 N2 : 교환상품 C1 : 입금전취소 C2 : 배송전취소 C3 : 반품 E1 : 교환
status_text	현재 처리상태 현재 처리상태 문구설명
open_market_status	마켓연동 상태값
bundled_shipping_type	묶음배송 타입 배송 대상 주문건의 묶음배송 유형 N : 단일 주문 일반 배송(Normal) C :복합 주문 결합 배송(Combination)
shipping_company_id	배송업체 아이디 배송업체의 아이디
shipping_company_name	배송업체 이름 배송업체의 이름
shipping_company_code	배송업체 코드 shipping_company_code
product_bundle	세트상품 여부 T : 세트상품 F : 세트상품 아님
product_bundle_no	세트상품번호 분리형 세트상품의 번호 일체형 세트 상품의 번호는 product_no에서 표시됨.
product_bundle_name	세트상품명 분리형 세트상품의 이름 일체형 세트 상품의 이름은 product_name에서 표시됨
product_bundle_name_default	세트상품명(기본) 분리형 세트상품의 이름 일체형 세트 상품의 이름은 product_name에서 표시됨
product_bundle_type	세트상품 타입 세트상품의 타입 C : 일체형 S : 분리형
was_product_bundle	세트품주 분리여부 세트상품의 품목주문번호 분리 여부 T : 분리되었던 적이 있음
original_bundle_item_no	분리된 세트상품의 기존 품주번호 분리형 세트 상품의 기존 품목 번호
naver_pay_order_id	네이버페이 상품별 주문번호 네이버페이 주문의 상품별 주문번호
naver_pay_claim_status	네이버페이 클레임 타입 네이버페이 주문의 클레임 타입 PAYMENT_WAITING : 입금대기 PAYED : 결제완료 DELIVERING : 배송중 DELIVERED : 배송완료 PURCHASE_DECIDED : 구매확정 EXCHANGED : 교환 CANCELED : 취소 RETURNED : 반품 CANCELED_BY_NOPAYMENT : 미입금취소 NOT_YET : 발주 미확인 OK : 발주 확인 CANCEL : 발주 확인 해제 CANCEL_REQUEST : 취소요청 CANCELING : 취소처리중 CANCEL_DONE : 취소처리완료 CANCEL_REJECT : 취소철회 RETURN_REQUEST : 반품요청 COLLECTING : 수거처리중 COLLECT_DONE : 수거완료 RETURN_DONE : 반품완료 RETURN_REJECT : 반품철회 EXCHANGE_REQUEST : 교환요청 COLLECTING : 수거처리중 COLLECT_DONE : 수거완료 EXCHANGE_REDELIVERING : 교환 재배송 중 EXCHANGE_DONE : 교환완료 EXCHANGE_REJECT : 교환거부 PURCHASE_DECISION_HOLDBACK : 구매 확정 보류 PURCHASE_DECISION_HOLDBACK_REDELIVERING : 구매 확정 보류 재배송 중 PURCHASE_DECISION_REQUEST : 구매 확정 요청 PURCHASE_DECISION_HOLDBACK_RELEASE : 구매 확정 보류 해제 ADMIN_CANCELING : 직권 취소 중 ADMIN_CANCEL_DONE : 직권 취소 완료
individual_shipping_fee	개별배송비 개별 배송비
shipping_fee_type	배송비 타입 (개별배송비를 사용할 경우) 상품의 배송비 타입. T : 무료 F : 착불 D : 차등(금액) M : 조건(금액) I : 고정 N : 비례(수량) W : 차등(무게) C : 차등(수량) X : 기본배송
shipping_fee_type_text	배송비타입 배송비 타입 설명
shipping_payment_option	선/착불 구분 C : 착불 P : 선결제 F : 무료
payment_info_id	결제정보 아이디
original_item_no	기존 품주 아이디
store_pickup	매장수령여부 매장수령 상품 여부 T : 매장수령 F : 매장수령 아님
ordered_date timezone	주문일
shipped_date timezone	배송시작일 배송 시작일
delivered_date timezone	배송완료일 배송 완료일
cancel_date timezone	주문취소일 주문 취소일
return_confirmed_date timezone	반품승인일시
return_request_date timezone	반품요청일 반품 요청일
return_collected_date timezone	반품수거일
cancel_request_date timezone	취소요청일 주문취소 요청일
refund_date timezone	환불완료일 환불 완료일
exchange_request_date timezone	교환요청일 교환 요청일
exchange_date timezone	교환완료일 교환 완료일
product_material	상품소재 상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)
product_material_eng	영문 상품 소재 상품소재 영문 설명
cloth_fabric	옷감 상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음.
product_weight	상품 중량 상품의 전체 중량(kg). 배송을 위해 상품 자체의 무게와 박스 무게, 포장무게를 모두 포함한 중량 기재가 필요하다.
volume_size	상품 부피 상품의 부피
volume_size_weight	상품 부피 무게 상품의 부피 무게
clearance_category	해외통관용 상품구분
clearance_category_info	해외통관용 상품정보
clearance_category_code	해외통관코드 clearance_category_code
hs_code	HS코드 통관을 위한 hs 코드
one_plus_n_event	1+N이벤트 여부 1개 구매시 N개 증정하는 이벤트 여부
origin_place	원산지정보 상품의 원산지
origin_place_no	원산지 코드
made_in_code	원산지 국가코드
gift	사은품 여부 상품이 사은품인지 여부 T : 사은품 F : 사은품 아님
item_granting_gift	사은품증정 조건품주목록
subscription	정기결제 여부 T : 정기결제 F : 정기결제 아님
product_bundle_list	세트상품 목록
market_cancel_request	마켓 취소요청 여부 T : 취소 요청된 마켓 주문 F : 취소 요청되지 않은 마켓 주문
market_cancel_request_quantity	마켓 취소신청 수량
market_fail_reason	마켓 실패사유
market_fail_reason_guide	마켓 실패사유 가이드
market_custom_variant_code	마켓 자체 품목 코드
order_id	주문번호
claim_type	취소/교환/반품 타입
claim_status	취소/교환/반품 요청 상태

List all orders items

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

order_id
Required

주문번호

주문번호

Definition Copy

Request example: Copy

Response example:

Update an orders item

PUT

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
order_item_code Required	품주코드
claim_type Required	취소/교환/반품 타입 C:취소 R:반품
claim_status Required	취소/교환/반품 요청 상태 T : 신청함 F : 신청안함
claim_reason_type Required	취소/교환/반품 요청 사유 타입 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
claim_reason	취소/교환/반품 요청 사유
claim_quantity	취소/교환/반품 요청 수량

Definition Copy

Request example: Copy

Response example:

Orders memos

Endpoints

GET /api/v2/admin/orders/{order_id}/memos
POST /api/v2/admin/orders/{order_id}/memos
PUT /api/v2/admin/orders/{order_id}/memos/{memo_no}
DELETE /api/v2/admin/orders/{order_id}/memos/{memo_no}

Orders memos properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
memo_no	메모 번호
created_date timezone	메모 등록일
author_id	작성자 아이디
ip	작성자 아이피
use_customer_inquiry	고객상담 동시등록 여부 T : 사용함 F : 사용안함
attach_type	등록기준 O : 주문별 P : 품목별
content	메모 내용
starred_memo	중요 메모 여부 T : 중요 메모 F : 일반 메모
fixed	상단고정 여부 T : 사용함 F : 사용안함
product_list	상품 목록
topic_type	상담분류 cs_01 : 배송문의 cs_02 : 상품문의 cs_03 : 결제문의 cs_04 : 주문취소 cs_05 : 상품변경
status	상담결과 F : 처리중 T : 처리완료

List all orders memos

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

Definition Copy

Request example: Copy

Response example:

Create an orders memo

POST

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
content Required 최대글자수 : [1000자]	메모 내용
use_customer_inquiry	고객상담 동시등록 여부 T : 사용함 F : 사용안함 DEFAULT F
topic_type	상담분류 cs_01 : 배송문의 cs_02 : 상품문의 cs_03 : 결제문의 cs_04 : 주문취소 cs_05 : 상품변경
status	상담결과 F : 처리중 T : 처리완료
attach_type	등록기준 O : 주문별 P : 품목별 DEFAULT O
starred_memo	중요 메모 여부 T : 중요 메모 F : 일반 메모 DEFAULT F
fixed	상단고정 여부 T : 사용함 F : 사용안함 DEFAULT F
product_list	상품 목록

Definition Copy

Request example: Copy

Response example:

Update an orders memo

PUT

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
memo_no Required	메모 번호
content 최대글자수 : [1000자]	메모 내용
use_customer_inquiry	고객상담 동시등록 여부 T : 사용함 F : 사용안함 DEFAULT F
topic_type	상담분류 cs_01 : 배송문의 cs_02 : 상품문의 cs_03 : 결제문의 cs_04 : 주문취소 cs_05 : 상품변경
status	상담결과 F : 처리중 T : 처리완료
attach_type	등록기준 O : 주문별 P : 품목별 DEFAULT O
starred_memo	중요 메모 여부 T : 중요 메모 F : 일반 메모 DEFAULT F
fixed	상단고정 여부 T : 사용함 F : 사용안함 DEFAULT F
product_list	상품 목록

Definition Copy

Request example: Copy

Response example:

Delete an orders memo

DELETE

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

memo_no
Required

메모 번호

Definition Copy

Request example: Copy

Response example:

Orders payments

Endpoints

PUT /api/v2/admin/orders/{order_id}/payments

Orders payments properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
change_payment_amount	결제금액 변경 여부 T : 사용함 F : 사용안함
change_payment_method	결제수단 변경 여부 T : 사용함 F : 사용안함
payment_method	결제수단
payment_gateway_failure_message	PG 결제 취소 실패 메시지
admin_additional_amount	관리자 입력 금액
commission	결제 수수료
initial_estimated_payment_amount	최초 결제 예정 금액
change_payment_amount_reason	결제금액 변경 사유

Update an orders payment

PUT

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
change_payment_amount Required	결제금액 변경 여부 T : 사용함 F : 사용안함
change_payment_method Required	결제수단 변경 여부 T : 사용함 F : 사용안함
payment_method	결제수단 cash: 무통장 입금 daibiki : 다이비키
billing_name 최대글자수 : [40자]	입금자명 결제수단을 무통장입금으로 변경할 경우("change_payment_method:"T"이고 "payment_method":"cash"일 경우) 사용 가능
bank_account_id	무통장 입금 은행 ID 결제수단을 무통장입금으로 변경할 경우("change_payment_method:"T"이고 "payment_method":"cash"일 경우) 사용 가능
admin_additional_amount 최소값: [0] 최대값: [10000000]	관리자 입력 금액 결제금액을 변경할 경우("change_payment_amount":"T"일 경우) 사용 가능
commission 최소값: [0] 최대값: [10000000]	결제 수수료 결제수단을 다이비키로 변경할 경우("change_payment_amount:"T"이고 "payment_method":"daibiki"일 경우) 사용 가능
change_payment_amount_reason 최대글자수 : [255자]	결제금액 변경 사유 결제금액을 변경할 경우("change_payment_amount":"T"일 경우) 사용 가능

Definition Copy

Request example: Copy

Response example:

Orders paymenttimeline

Endpoints

GET /api/v2/admin/orders/{order_id}/paymenttimeline
GET /api/v2/admin/orders/{order_id}/paymenttimeline/{payment_no}

Orders paymenttimeline properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
payment_no	결제번호
payment_settle_type	결제유형 O : 최초결제 R : 추가결제 P : 환불
order_amount	주문금액
additional_payment_amount	보조 결제금액
paid_amount	결제금액
payment_methods	결제수단
payment_datetime timezone	결제일
created_datetime timezone	입력일
payment_method_detail	결제수단별 결제금액 payment_method_detail code 상세 조회시에만 확인 가능하다.
order_amount_detail	주문금액 상세 order_amount_detail code 상세 조회시에만 확인 가능하다.

List all orders paymenttimeline

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

Definition Copy

Request example: Copy

Response example:

Get an orders paymenttimeline

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

payment_no
Required

최소값: [1]

결제번호

Definition Copy

Request example: Copy

Response example:

Orders receivers

수령자 정보(Receivers)는 주문한 상품을 배송 받을 수령자의 이름, 연락처, 주소 정보 입니다.
수령자 정보는 하위 리소스로서 주문(Order) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/{order_id}/receivers
PUT /api/v2/admin/orders/{order_id}/receivers
PUT /api/v2/admin/orders/{order_id}/receivers/{shipping_code}

Orders receivers properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
name	수령자명
name_furigana	수령자명 (발음)
phone	전화번호
cellphone	수령자 휴대 전화
virtual_phone_no	수령자 안심번호
zipcode	우편번호
address1	기본 주소
address2	상세 주소
address_state	주/도
address_city	시/군/도시
address_street	도로명
address_full	전체주소
name_en	수령자명 (영문)
city_en	수령자 도시 (영문)
state_en	수령자 주 (영문)
street_en	수령자 주소 (영문)
country_code	국가코드
country_name	국가명
country_name_en	국가명 (영문)
shipping_message	배송 메세지
clearance_information_type	통관정보 유형 I : 신분증 ID P : 여권번호 C : 개인통관고유부호
clearance_information	통관정보
wished_delivery_date	희망배송일
wished_delivery_time	희망배송시간
shipping_code	배송번호
change_default_shipping_address	기본배송지 변경 여부 T : 변경함 F : 변경안함

List all orders receivers

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

order_id
Required

주문번호

주문번호

shipping_code

배송번호

,(콤마)로 여러 건을 검색할 수 있다.

Definition Copy

Request example: Copy

Response example:

Update orders receivers

PUT

복수 배송지 주문일 경우 수령자 안심번호 수정 불가

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
name 최대글자수 : [20자]	수령자명
phone 최대글자수 : [20자]	수령자 일반 전화
cellphone 최대글자수 : [20자]	수령자 휴대 전화
shipping_message	배송 메세지
name_furigana	수령자명 (발음)
zipcode 최소글자수 : [2자] 최대글자수 : [14자]	우편번호
address1 최대글자수 : [255자]	기본 주소
address2 최대글자수 : [255자]	상세 주소
address_state	주/도
address_city	시/군/도시
name_en	수령자명 (영문)
city_en	수령자 도시 (영문)
state_en	수령자 주 (영문)
street_en	수령자 주소 (영문)
country_code	국가코드
clearance_information_type	통관정보 유형 I : 신분증 ID P : 여권번호 C : 개인통관고유부호
clearance_information	통관정보
shipping_code	배송번호
change_default_shipping_address	기본배송지 변경 여부 T : 변경함 F : 변경안함 DEFAULT F
virtual_phone_no	수령자 안심번호 복수 배송지 주문일 경우 수령자 안심번호 수정 불가

Definition Copy

Request example: Copy

Response example:

Update an orders receiver

PUT

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
shipping_code Required	배송번호
name 최대글자수 : [20자]	수령자명
phone 최대글자수 : [20자]	수령자 일반 전화
cellphone 최대글자수 : [20자]	수령자 휴대 전화
shipping_message	배송 메세지
name_furigana	수령자명 (발음)
zipcode 최소글자수 : [2자] 최대글자수 : [14자]	우편번호
address1 최대글자수 : [255자]	기본 주소
address2 최대글자수 : [255자]	상세 주소
address_state	주/도
address_city	시/군/도시
name_en	수령자명 (영문)
city_en	수령자 도시 (영문)
state_en	수령자 주 (영문)
street_en	수령자 주소 (영문)
country_code	국가코드
clearance_information_type	통관정보 유형 I : 신분증 ID P : 여권번호 C : 개인통관고유부호
clearance_information	통관정보
change_default_shipping_address	기본배송지 변경 여부 T : 변경함 F : 변경안함 DEFAULT F
virtual_phone_no	수령자 안심번호 복수 배송지 주문일 경우 수령자 안심번호 수정 불가

Definition Copy

Request example: Copy

Response example:

Orders receivers history

Endpoints

GET /api/v2/admin/orders/{order_id}/receivers/history

Orders receivers history properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
name	수령자명
phone	전화번호
cellphone	수령자 휴대 전화
zipcode	우편번호
address1	기본 주소
address2	상세 주소
address_state	주/도
address_city	시/군/도시
address_street	도로명
address_full	전체주소
name_en	수령자명 (영문)
city_en	수령자 도시 (영문)
state_en	수령자 주 (영문)
street_en	수령자 주소 (영문)
country_code	국가코드
country_name	국가명
country_name_en	국가명 (영문)
shipping_message	배송 메세지
updated_date timezone	수정일
user_id	주문자 수정자 ID
user_name	주문자 수정자 명
shipping_code	배송번호

List all orders receivers history

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

Definition Copy

Request example: Copy

Response example:

Orders return

Endpoints

POST /api/v2/admin/orders/{order_id}/return

Orders return properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
status	주문상태 canceled : 취소완료
claim_code	취소 번호
items	품주코드

Create an orders return

POST

특정 배송 후 주문 하나를 반품 처리할 수 있는 API입니다. 해당 API를 사용하여 반품완료처리할 경우 환불완료 처리와 함께 PG 취소도 같이 진행할 수 있습니다.(payment_gateway_cancel : "T"로 요청시)

부분반품할 경우 각 환불 금액은 자동 계산되어 환불처리됩니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
payment_gateway_cancel	PG 취소 요청 여부 주문을 반품처리함과 동시에 PG취소도 같이 처리할 수 있다. 결제수단이 복수인 주문(카드 등으로 결제한 주문을 결제 후 품목을 추가한 경우)의 경우에는 PG 결제를 취소할 수 없으며 관리자 화면에서 취소해야 한다. 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가 T : 취소함 F : 취소안함 DEFAULT F
status Required	주문상태 returned : 반품완료
recover_inventory	재고복구 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon	쿠폰 복원 T : 복구함 F : 복구안함 DEFAULT F
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함 DEFAULT F
reason 최대글자수 : [2000자]	반품사유
claim_reason_type	반품사유 구분 A : 고객변심 B : 배송지연 C : 배송불가지역 L : 수출/통관 불가 D : 포장불량 E : 상품불만족 F : 상품정보상이 G : 서비스불만족 H : 품절 I : 기타
naverpay_return_reason_type	네이버페이 반품사유 구분 EC 베트남, 필리핀, 일본 버전에서는 사용할 수 없음. 51 : 구매 의사 취소 52 : 색상 및 사이즈 변경 53 : 다른 상품 잘못 주문 54 : 서비스 및 상품 불만족 55 : 배송 지연 56 : 상품 품절 57 : 배송 누락 58 : 미배송 59 : 상품 파손 60 : 상품 정보 상이 61 : 오배송 62 : 색상 등 옵션이 다른 상품 잘못 배송
refund_method_code	환불 방식 T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 I : 기타
combined_refund_method	복합 환불 방식 결제수단이 복수인 주문(카드 등으로 결제한 주문을 결제 후 품목을 추가한 경우)의 환불수단(refund_method_code)을 신용카드/계좌이체/휴대폰 등 주 결제수단으로 환불할 경우 나머지 금액을 환불 받을 수 있는 복합환불수단을 입력할 수 있다.(이 경우, payment_gateway="F"만 사용 가능하다.) 환불수단을 현금/적립금/예치금 등 현금성 환불 수단으로 하거나 환불 금액이 PG 결제 금액보다 작을 경우 모든 금액이 주결제 수단으로 취소되므로 복합환불 수단은 기입하지 않는다. T : 현금 M : 적립금 D : 예치금
refund_bank_code	환불 은행 코드 환불 방식(refund_method)이 현금(T)일 경우 필수 refund_bank_code ※ 해당 쇼핑몰이 EC Korea 쇼핑몰일 경우 필수
refund_bank_name 최대글자수 : [250자]	환불은행명 환불 방식(refund_method)이 현금(T)일 경우 필수 ※ 해당 쇼핑몰이 EC Global 쇼핑몰일 경우 필수 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능
refund_bank_account_no 최대글자수 : [50자]	환불 계좌번호 환불 방식(refund_method)이 현금(T)일 경우 필수
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
items	품주코드
order_item_code 품주코드 Required quantity 수량 Required

Definition Copy

Request example: Copy

Response example:

Orders shipments

주문의 배송(Shipments)은 주문을 배송처리하기 위해 필요한 배송 정보를 의미합니다. 주문의 배송 정보에는 송장번호와 배송사 정보, 배송 상태 등이 있습니다.

Endpoints

GET /api/v2/admin/orders/{order_id}/shipments
POST /api/v2/admin/orders/{order_id}/shipments
PUT /api/v2/admin/orders/{order_id}/shipments/{shipping_code}
DELETE /api/v2/admin/orders/{order_id}/shipments/{shipping_code}

Orders shipments properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
shipping_code	배송번호
order_id	주문번호
tracking_no	송장번호
tracking_no_updated_date timezone	송장번호입력일
shipping_company_code	배송업체 코드 shipping_company_code
items	품주 목록
status	주문상태 standby : 배송대기 shipping : 배송중 shipped : 배송완료
order_item_code	품주코드
status_additional_info	주문상태 추가정보

List all orders shipments

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

Definition Copy

Request example: Copy

Response example:

Register shipments information

POST

주문에 배송정보를 등록하여 주문을 배송대기 시키거나 배송중 처리할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
tracking_no Required 최대글자수 : [30자]	송장번호
shipping_company_code Required	배송업체 코드 shipping_company_code
order_item_code	품주코드
status Required	주문상태 standby : 배송대기 shipping : 배송중
shipping_code	배송번호

Definition Copy

Request example: Copy

Response example:

Update orders shipment information

PUT

주문의 배송상태 또는 송장번호를 수정할 수 있습니다. 배송상태와 송장번호는 동시에 수정할 수 없으며 각각 나누어 호출해야 합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
shipping_code Required	배송번호
status	주문상태 status 사용하여 배송상태 수정시 tracking_no, shipping_company_code는 사용 불가 standby : 배송대기 shipping : 배송중 shipped : 배송완료
status_additional_info 최대글자수 : [30자]	주문상태 추가정보
tracking_no 최대글자수 : [30자]	송장번호 tracking_no 사용시 shipping_company_code를 함께 사용해야 하며, 송장번호 수정시 status는 사용 불가
shipping_company_code	배송업체 코드 shipping_company_code tracking_no 사용시 shipping_company_code를 함께 사용해야 하며, 송장번호 수정시 status는 사용 불가

Definition Copy

Request example: Copy

Response example:

Delete an orders shipment

DELETE

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

shipping_code
Required

배송번호

Definition Copy

Request example: Copy

Response example:

Orders shippingfeecancellation

Endpoints

GET /api/v2/admin/orders/{order_id}/shippingfeecancellation
POST /api/v2/admin/orders/{order_id}/shippingfeecancellation

Orders shippingfeecancellation properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
default_shipping_fee	기본 배송비
supplier_shipping_fee	업체기본배송비
individual_shipping_fee	개별배송비
international_shipping_fee	해외배송비
international_shipping_insurance_fee	해외배송 보험료
additional_shipping_fee	추가 배송비
additional_handling_fee	해외배송 부가금액
regional_surcharge_amount	지역별 배송비
claim_code	취소 번호
claim_reason_type	구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
claim_reason	사유
refund_method	환불 방식
shipping_discount_amount	배송비할인 취소액
coupon_discount_amount	쿠폰할인 취소액
refund_amount	환불금액
point_used	사용된 적립금 반환액
credit_used	사용된 예치금 반환액
mixed_refund_amount	복합 환불 금액
mixed_refund_methods	복합 환불 방식
status	주문상태 canceled: 취소완료 canceling : 취소처리중

List all orders shippingfeecancellation

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

Definition Copy

Request example: Copy

Response example:

Create an orders shippingfeecancellation

POST

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
reason 최대글자수 : [2000자]	취소사유
claim_reason_type	취소사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
recover_coupon	쿠폰 복원 T : 복구함 F : 복구안함 DEFAULT F
refund_method_code	환불 방식 T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 I : 기타
combined_refund_method	복합 환불 방식 T : 현금 M : 적립금 D : 예치금
refund_bank_code	환불 은행 코드
refund_bank_name 최대글자수 : [250자]	환불은행명
refund_bank_account_no 최대글자수 : [50자]	환불 계좌번호
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
payment_gateway_cancel	PG 취소 요청 여부 T : 취소함 F : 취소안함 DEFAULT F

Definition Copy

Request example: Copy

Response example:

Orders shortagecancellation

Endpoints

POST /api/v2/admin/orders/{order_id}/shortagecancellation

Orders shortagecancellation properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
order_id	주문번호
status	주문상태 canceled : 취소완료
claim_code	취소 번호
items	품주코드

Create an orders shortagecancellation

POST

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
order_id Required	주문번호
payment_gateway_cancel	PG 취소 요청 여부 T : 취소함 F : 취소안함 DEFAULT F
keep_auto_calculation	할인금액 자동계산 플래그 보존여부 보존함 : T 제거함 : F DEFAULT F
collect_gift	사은품 자동 회수 T : 사용함 F : 사용안함 DEFAULT F
status Required	주문상태 canceled : 취소완료
recover_inventory	재고복구 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon	쿠폰 복원 T : 복구함 F : 복구안함 DEFAULT F
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함 DEFAULT F
reason 최대글자수 : [2000자]	취소사유
claim_reason_type	취소사유 구분 A : 고객변심 B : 배송지연 C : 배송불가지역 L : 수출/통관 불가 D : 포장불량 E : 상품불만족 F : 상품정보상이 G : 서비스불만족 H : 품절 I : 기타
naverpay_cancel_reason_type	네이버페이 취소사유 구분 EC 베트남, 필리핀 버전에서는 사용할 수 없음. 51 : 구매 의사 취소 52 : 색상 및 사이즈 변경 53 : 다른 상품 잘못 주문 54 : 서비스 및 상품 불만족 55 : 배송 지연 56 : 상품 품절 60 : 상품 정보 상이
refund_method_code	환불 방식 T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 I : 기타
combined_refund_method	복합 환불 방식 T : 현금 M : 적립금 D : 예치금
refund_bank_code	환불 은행 코드
refund_bank_name 최대글자수 : [250자]	환불은행명
refund_bank_account_no 최대글자수 : [50자]	환불 계좌번호
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
items	품주코드
order_item_code 품주코드 Required quantity 수량 Required

Definition Copy

Request example: Copy

Response example:

Payments

Endpoints

PUT /api/v2/admin/payments

Payments properties

Attribute

Description

shop_no

멀티쇼핑몰 번호

order_id

주문번호

status

주문상태

paid: 입금확인
unpaid: 입금전
canceled: 결제취소

Update payments

PUT

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	10

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
status Required	주문상태 paid: 입금확인 unpaid: 입금전 canceled: 결제취소
recover_inventory	재고복구 T : 복구함 F : 복구안함

Definition Copy

Request example: Copy

Response example:

Refunds

Endpoints

GET /api/v2/admin/refunds
GET /api/v2/admin/refunds/{refund_code}

Refunds properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
member_email	회원 이메일
buyer_email	주문자 이메일
order_date timezone	주문일
accepted_refund_date timezone	환불접수일자
refund_date timezone	환불완료일자
order_id	주문번호
refund_code	환불번호
order_item_code	품주코드 목록
quantity	수량
actual_refund_amount	실환불금액
used_points	사용된 적립금 반환액
used_credits	사용된 예치금 반환액
used_transferable_points	사용된 통합포인트 반환액
currency	화폐단위
payment_methods	결제수단 cash : 무통장 card : 신용카드 cell : 휴대폰 tcash : 계좌이체 icash : 가상계좌 prepaid : 선불금 credit : 예치금 point : 적립금 pointfy : 통합포인트 cvs : 편의점 cod : 후불 coupon : 쿠폰 market_discount : 마켓할인 etc : 기타
refund_payment_methods	환불 결제수단 cash : 무통장 card : 신용카드 cell : 휴대폰 tcash : 계좌이체 prepaid : 선불금 credit : 예치금 point : 적립금 pointfy : 통합포인트 cvs : 편의점 cod : 후불 etc : 기타
payment_gateway_cancel_status	PG 취소상태 F : 취소전 M : 부분취소 완료 T : 전체취소 완료
payment_gateway_cancel_date timezone	PG 취소처리 일자
status	환불상태 T : 환불전 F : 환불완료
refund_point	적립금 반환액 상세 조회시에만 확인 가능하다.
refund_credit	예치금 반환액 상세 조회시에만 확인 가능하다.
refund_naver_point	네이버 포인트 반환액 상세 조회시에만 확인 가능하다.
refund_naver_cash	네이버 캐시 반환액 상세 조회시에만 확인 가능하다.
refund_amount	환불금액 상세 조회시에만 확인 가능하다.
product_price	상품 판매가 상세 조회시에만 확인 가능하다.
shipping_fee	배송비 상세 조회시에만 확인 가능하다.
shipping_fee_discount_amount	배송비할인 상세 조회시에만 확인 가능하다.
cod_fees	후불 결제 수수료 상세 조회시에만 확인 가능하다.
foreign_shipping_additional_fee	해외배송 부가금액 상세 조회시에만 확인 가능하다.
product_discount_amount	상품별 할인금액 상세 조회시에만 확인 가능하다.
member_group_discount_amount	회원등급 할인금액 상세 조회시에만 확인 가능하다.
app_item_discount_amount	앱 상품할인금액 상세 조회시에만 확인 가능하다.
app_discount_amount	앱 주문할인금액 상세 조회시에만 확인 가능하다.
coupon_discount_amount	쿠폰 할인금액 상세 조회시에만 확인 가능하다.
product_bundle_discount_amount	세트상품 할인금액 상세 조회시에만 확인 가능하다.
points_spent_amount	적립금사용금액 상세 조회시에만 확인 가능하다.
credits_spent_amount	예치금사용금액 상세 조회시에만 확인 가능하다.
transferable_points_spent_amount	통합포인트 사용금액 상세 조회시에만 확인 가능하다.
naver_point	네이버포인트 상세 조회시에만 확인 가능하다.
naver_cash	네이버캐시 상세 조회시에만 확인 가능하다.
additional_product_amount	상품 추가 결제금액 상세 조회시에만 확인 가능하다.
manually_input_amount	관리자 입력 금액 상세 조회시에만 확인 가능하다.
changed_refund_amount	변경된 환불금액 상세 조회시에만 확인 가능하다.
refund_bank_name	환불은행명 상세 조회시에만 확인 가능하다.
refund_bank_account_no	환불 계좌번호 상세 조회시에만 확인 가능하다.
refund_bank_account_holder	환불계좌 예금주 명의 상세 조회시에만 확인 가능하다.
refund_manager	환불 담당자 상세 조회시에만 확인 가능하다.
refund_reason	환불사유 상세 조회시에만 확인 가능하다.
refund_methods	환불 방식 상세 조회시에만 확인 가능하다.
send_sms	환불처리후 SMS 발송 여부 상세 조회시에만 확인 가능하다. T : 발송함 F : 발송안함
send_mail	환불처리후 메일 발송 여부 상세 조회시에만 확인 가능하다. T : 발송함 F : 발송안함
items	품주 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다. 상세 조회시에만 확인 가능하다.

List all refunds

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
start_date Required 날짜 timezone	검색 시작일
end_date Required 날짜 timezone	검색 종료일
date_type	검색날짜 유형 accepted_refund_date : 환불접수일 refund_date : 환불완료일 DEFAULT refund_date
member_email	회원 이메일
buyer_email	주문자 이메일
limit 최소: [1]~최대: [500]	조회결과 최대건수 DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치

Definition Copy

Request example: Copy

Response example:

Get a refund

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

refund_code
Required

환불번호

items
embed

품주 리소스

조회시 Embed 파라메터를 사용하여 조회할 수 있다.

Definition Copy

Request example: Copy

Response example:

Return

반품(Return)은 쇼핑몰 고객이 배송 후 주문을 취소하는 것을 의미합니다. 반품 리소스에서는 반품 정보를 조회하거나 반품을 처리할 수 있습니다.

반품 리소스는 반품접수 이후부터 반품완료까지의 주문 상태를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/return/{claim_code}
POST /api/v2/admin/return

Return properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
claim_code	취소 번호
claim_reason_type	구분 판매자의 반품 접수 사유 구분. 구매자의 반품 신청 사유는 items(품목 주문) > claim_reason_type으로 조회할 수 있다. 상세 조회시에만 확인 가능하다. A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
claim_reason	사유 판매자의 반품 접수 사유 상세 내용. 구매자의 반품 신청 사유 상세 내용은 items(품목 주문) > claim_reason으로 조회할 수 있다. 상세 조회시에만 확인 가능하다.
claim_due_date	반품처리 예정일 상세 조회시에만 확인 가능하다.
return_address	반품주소 상세 조회시에만 확인 가능하다.
pickup	수거지 - 주소 상세 조회시에만 확인 가능하다.
return_invoice_no	반품 송장 번호 상세 조회시에만 확인 가능하다.
return_shipping_company_name	반품 배송업체명 상세 조회시에만 확인 가능하다.
pickup_request_state	수거 신청 상태 상세 조회시에만 확인 가능하다. E : 수거 미신청 W : 수거 미접수 S : 수거접수대기(송장발급전) F : 수거접수실패 T : 수거접수완료(송장발급완료) N : 미집하
refund_method	환불 방식 상세 조회시에만 확인 가능하다.
refund_reason	비고 상세 조회시에만 확인 가능하다.
order_price_amount	상품구매금액 상세 조회시에만 확인 가능하다.
refund_amount	환불금액 상세 조회시에만 확인 가능하다.
shipping_fee	배송비 상세 조회시에만 확인 가능하다.
return_ship_type	반품배송비 적용구분 상세 조회시에만 확인 가능하다.
return_shipping_fee	반품배송비 상세 조회시에만 확인 가능하다.
return_shipping_fee_detail	반품배송비 상세 상세 조회시에만 확인 가능하다.
return_regional_shipping_fee	지역별 반품배송비 상세 조회시에만 확인 가능하다.
return_regional_surcharge_detail	지역별 반품배송비 상세 상세 조회시에만 확인 가능하다.
defer_commission	후불 결제 수수료 상세 조회시에만 확인 가능하다.
partner_discount_amount	제휴할인 취소액 상세 조회시에만 확인 가능하다.
add_discount_amount	상품별추가할인 취소액 상세 조회시에만 확인 가능하다.
member_grade_discount_amount	회원등급할인 취소액 상세 조회시에만 확인 가능하다.
shipping_discount_amount	배송비할인 취소액 상세 조회시에만 확인 가능하다.
coupon_discount_amount	쿠폰할인 취소액 상세 조회시에만 확인 가능하다.
point_used	사용된 적립금 반환액 상세 조회시에만 확인 가능하다.
credit_used	사용된 예치금 반환액 상세 조회시에만 확인 가능하다.
items	품주코드
status	주문상태 canceled : 취소완료

Get a return

GET

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

claim_code
Required

반품번호

Definition Copy

Request example: Copy

Response example:

Create return

POST

여러 배송 후 주문을 반품 처리할 수 있는 API입니다. 해당 API를 사용하여 반품 처리할 경우 환불완료 처리 되지만 PG 취소까지는 진행되지 않으며 솔루션에서 별도 PG 취소처리를 해주어야 합니다.

부분반품할 경우 각 환불 금액은 자동 계산되어 환불처리됩니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
status Required	주문상태 returned : 반품완료
recover_inventory	재고복구 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon	쿠폰 복원 T : 복구함 F : 복구안함 DEFAULT F
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함 DEFAULT F
reason 최대글자수 : [2000자]	반품사유
claim_reason_type	반품사유 구분 A : 고객변심 B : 배송지연 C : 배송불가지역 L : 수출/통관 불가 D : 포장불량 E : 상품불만족 F : 상품정보상이 G : 서비스불만족 H : 품절 I : 기타
naverpay_return_reason_type	네이버페이 반품사유 구분 EC 베트남, 필리핀, 일본 버전에서는 사용할 수 없음. 51 : 구매 의사 취소 52 : 색상 및 사이즈 변경 53 : 다른 상품 잘못 주문 54 : 서비스 및 상품 불만족 55 : 배송 지연 56 : 상품 품절 57 : 배송 누락 58 : 미배송 59 : 상품 파손 60 : 상품 정보 상이 61 : 오배송 62 : 색상 등 옵션이 다른 상품 잘못 배송
refund_method_code	환불 방식 T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 I : 기타
combined_refund_method	복합 환불 방식 결제수단이 복수인 주문(카드 등으로 결제한 주문을 결제 후 품목을 추가한 경우)의 환불수단(refund_method_code)을 신용카드/계좌이체/휴대폰 등 주 결제수단으로 환불할 경우 나머지 금액을 환불 받을 수 있는 복합환불수단을 입력할 수 있다. 환불수단을 현금/적립금/예치금 등 현금성 환불 수단으로 하거나 환불 금액이 PG 결제 금액보다 작을 경우 모든 금액이 주결제 수단으로 취소되므로 복합환불 수단은 기입하지 않는다. T : 현금 M : 적립금 D : 예치금
refund_bank_code	환불 은행 코드 환불 방식(refund_method)이 현금(T)일 경우 필수 refund_bank_code ※ 해당 쇼핑몰이 EC Korea 쇼핑몰일 경우 필수
refund_bank_name 최대글자수 : [250자]	환불은행명 환불 방식(refund_method)이 현금(T)일 경우 필수 ※ 해당 쇼핑몰이 EC Global 쇼핑몰일 경우 필수 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능
refund_bank_account_no 최대글자수 : [50자]	환불 계좌번호 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
items	품주코드
order_item_code 품주코드 Required quantity 수량 Required

Definition Copy

Request example: Copy

Response example:

Shipments

배송(Shipments)은 주문 하위의 배송 정보와 다르게 여러 주문의 배송 정보를 한번에 등록하거나 수정할 수 있습니다. 주문의 배송 정보에는 송장번호와 배송사 정보, 배송 상태 등이 있습니다.

Endpoints

POST /api/v2/admin/shipments
PUT /api/v2/admin/shipments

Shipments properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
tracking_no	송장번호
shipping_code	배송번호
shipping_company_code	배송업체 코드 shipping_company_code
status	주문상태 standby : 배송대기 shipping : 배송중 shipped : 배송완료
order_item_code	품주코드
status_additional_info	주문상태 추가정보

Create shipments

POST

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
tracking_no Required 최대글자수 : [30자]	송장번호
shipping_company_code Required	배송업체 코드 shipping_company_code
status Required	주문상태 standby : 배송대기 shipping : 배송중
order_item_code	품주코드
shipping_code	배송번호

Definition Copy

Request example: Copy

Response example:

Update shipments

PUT

주문의 배송상태 또는 송장번호를 수정할 수 있습니다. 배송상태와 송장번호는 동시에 수정할 수 없으며 각각 나누어 호출해야 합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
status	주문상태 status 사용하여 배송상태 수정시 tracking_no, shipping_company_code는 사용 불가 standby : 배송대기 shipping : 배송중 shipped : 배송완료
status_additional_info 최대글자수 : [30자]	주문상태 추가정보
order_id Required	주문번호
shipping_code Required	배송번호
tracking_no 최대글자수 : [30자]	송장번호 tracking_no 사용시 shipping_company_code를 함께 사용해야 하며, 송장번호 수정시 status는 사용 불가
shipping_company_code	배송업체 코드 해당 주문의 송장번호와 함께 배송사를 변경할 수 있다. shipping_company_code tracking_no 사용시 shipping_company_code를 함께 사용해야 하며, 송장번호 수정시 status는 사용 불가

Definition Copy

Request example: Copy

Response example:

Community

Boards

Endpoints

GET /api/v2/admin/boards

Boards properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
board_no	게시판 번호
board_type	게시판 분류 1 : 운영 2 : 일반 3 : 자료실 4 : 기타 5 : 상품 6 : 갤러리 7 : 1:1상담 11 : 한줄메모
board_name	게시판 이름
use_additional_board	게시판 추가여부 T : 추가게시판 F : 기본게시판
use_board	게시판 사용여부 T : 사용함 F : 사용안함
use_display	표시여부 T : 표시함 F : 표시안함
display_order	정렬 순서

List all boards

GET

해당 API는 한국어, 일본어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	게시판 읽기권한 (mall.read_community)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

Definition Copy

Request example: Copy

Response example:

Boards articles

게시물(Boards articles)은 게시판의 게시물에 대한 정보를 의미합니다.

Endpoints

GET /api/v2/admin/boards/{board_no}/articles
POST /api/v2/admin/boards/{board_no}/articles
PUT /api/v2/admin/boards/{board_no}/articles/{article_no}
DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}

Boards articles properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
article_no	게시물 번호
parent_article_no	부모 게시물 번호
board_no Required	게시판 번호
product_no	상품번호
category_no	분류 번호
board_category_no	게시판 카테고리 번호
reply_sequence	답변 게시물 순서
reply_depth	답변 차수
created_date 날짜 timezone	생성일
writer	작성자명
writer_email 이메일	작성자 이메일
member_id	회원아이디
title	제목
content	내용
client_ip IP	작성자 IP
nick_name	별명
rating 최소: [1]~최대: [5]	평점
sales_channel 최대글자수 : [20자]	매체사
reply_mail	1:1 게시판 문의내용에 대한 답변 메일 여부 Y : 사용함 N : 사용안함
display	게시 여부 T : 게시함 F : 게시안함
secret	비밀글 여부 T : 사용함 F : 사용안함
notice	공지 여부 T : 사용함 F : 사용안함
fixed	고정글 여부 T : 사용함 F : 사용안함
deleted	삭제 구분 T : 삭제 F : 비삭제
input_channel	게시물 작성 경로 P : PC M : 모바일
order_id	주문번호
attach_file_urls	첨부 파일 상세
hit	조회수
reply	1:1 게시판 문의내용에 대한 답변여부 T : 사용함 F : 사용안함
reply_user_id	처리중 또는 답변완료 한 운영자 아이디
reply_status	답변 처리 상태 N : 답변전 P : 처리중 C : 처리완료
naverpay_review_id	네이버페이 리뷰 아이디
display_time	노출시간 사용여부
display_time_start_hour	노출시간 시작 시각
display_time_end_hour	노출시간 종료 시각
attached_file_detail	첨부 파일 상세
attached_file_urls	첨부 파일 상세

List all boards articles

GET

해당 API는 한국어, 일본어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	게시판 읽기권한 (mall.read_community)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
board_no Required	게시판 번호
board_category_no	게시판 카테고리 번호
start_date 날짜 timezone	작성일 시작일자
end_date 날짜 timezone	작성일 종료일자
input_channel	쇼핑몰 구분 P : PC M : 모바일
search	검색 영역 subject : 제목 content : 내용 writer_name : 작성자 product : 상품명 member_id : 회원 아이디
keyword	검색어
reply_status	답변상태 N : 답변 전 P : 처리중 C : 답변 완료
comment	댓글여부 T : 있음 F : 없음
attached_file	첨부파일 여부 T : 있음 F : 없음
article_type	게시물 유형 ,(콤마)로 여러 건을 검색할 수 있다. all : 전체 normal : 일반글 notice : 공지글 fixed : 고정글
product_no	상품번호
has_product	상품정보 포함 여부 T : 있음 F : 없음
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치

Definition Copy

Request example: Copy

Response example:

Create boards articles

POST

해당 API는 한국어, 일본어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	게시판 쓰기권한 (mall.write_community)
호출건수 제한	40
1회당 요청건수 제한	10

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
board_no Required	게시판 번호
writer Required 최대글자수 : [100자]	작성자명
title Required 최대글자수 : [256자]	제목
content

Attribute	Description
shop_no	멀티쇼핑몰 번호
display_no	자동진열 번호
use_main	메인분류 여부 T: 메인분류 F: 상품분류
category_no	분류 번호
display_group	상세 상품분류
display_count 최소: [1]~최대: [200]	자동진열 최대 상품 수
use_reservation	예약진열 사용여부 T: 사용함 F: 사용안함
start_date timezone	예약 시작일
use_hashtag	해시태그 사용여부 T: 사용함 F: 사용안함
hash_tags	해시태그
display_sort	정렬순서 AOD: 주문 수 높은 순서대로 AOA: 주문 수 낮은 순서대로 AVD: 조회 수 높은 순서대로 AVA: 조회 수 낮은 순서대로 ARD: 주문율 높은 순서대로 ARA: 주문율 낮은 순서대로 ACD: 클릭 가치 높은 순서대로 AND: 신규 등록된 순서대로 APD: 판매가 높은 순서대로 APA: 판매가 낮은 순서대로 RD : 최근 등록상품이 위로 RA : 최근 등록상품이 아래로 UD : 최근 수정상품이 위로 UA : 최근 수정상품이 아래로 NA : 상품명 가나다순 ND : 상품명 가나다역순 PD : 판매가 높은 상품이 위로 PA : 판매가 높은 상품이 아래로 SD : 판매량 높은 상품이 위로 SA : 판매량 높은 상품이 아래로 CD : 조회수가 높은 상품이 위로 CA : 조회수가 높은 상품이 아래로 LD : 좋아요수가 높은 상품이 위로 LA : 좋아요수가 높은 상품이 아래로
timetable 배열 최대사이즈: [24]	업데이트 시간
period	데이터 집계 기간 1: 1일 3: 3일 7: 1주(7일) 30: 30일
except_categories	제외 분류

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
use_main Required	메인분류 여부 T: 메인분류 F: 상품분류
category_no Required	분류 번호
display_group Required	상세 상품분류
display_count Required 최소: [1]~최대: [200]	자동진열 최대 상품 수
use_reservation Required	예약진열 사용여부 T: 사용함 F: 사용안함
start_date timezone	예약 시작일
use_hashtag Required	해시태그 사용여부 T: 사용함 F: 사용안함
hash_tags	해시태그
display_sort	정렬순서 정렬 조건(RD, RA, UD, UA, NA, ND, PD, PA, SD, SA, AD, AA, LD, LA)은 use_hashtag가 "T"일 경우에만 사용 가능 AOD: 주문 수 높은 순서대로 AOA: 주문 수 낮은 순서대로 AVD: 조회 수 높은 순서대로 AVA: 조회 수 낮은 순서대로 ARD: 주문율 높은 순서대로 ARA: 주문율 낮은 순서대로 ACD: 클릭 가치 높은 순서대로 AND: 신규 등록된 순서대로 APD: 판매가 높은 순서대로 APA: 판매가 낮은 순서대로 RD : 최근 등록상품이 위로 RA : 최근 등록상품이 아래로 UD : 최근 수정상품이 위로 UA : 최근 수정상품이 아래로 NA : 상품명 가나다순 ND : 상품명 가나다역순 PD : 판매가 높은 상품이 위로 PA : 판매가 높은 상품이 아래로 SD : 판매량 높은 상품이 위로 SA : 판매량 높은 상품이 아래로 CD : 조회수가 높은 상품이 위로 CA : 조회수가 높은 상품이 아래로 LD : 좋아요수가 높은 상품이 위로 LA : 좋아요수가 높은 상품이 아래로
timetable 배열 최대사이즈: [24]	업데이트 시간
period	데이터 집계 기간 1: 1일 3: 3일 7: 1주(7일) 30: 30일
except_categories	제외 분류

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
display_no Required	자동진열 번호
display_count 최소: [1]~최대: [200]	자동진열 최대 상품 수
use_reservation	예약진열 사용여부 T: 사용함 F: 사용안함
start_date timezone	예약 시작일
use_hashtag	해시태그 사용여부 T: 사용함 F: 사용안함
hash_tags	해시태그
display_sort	정렬순서 정렬 조건(RD, RA, UD, UA, NA, ND, PD, PA, SD, SA, AD, AA, LD, LA)은 use_hashtag가 "T"일 경우에만 사용 가능 AOD: 주문 수 높은 순서대로 AOA: 주문 수 낮은 순서대로 AVD: 조회 수 높은 순서대로 AVA: 조회 수 낮은 순서대로 ARD: 주문율 높은 순서대로 ARA: 주문율 낮은 순서대로 ACD: 클릭 가치 높은 순서대로 AND: 신규 등록된 순서대로 APD: 판매가 높은 순서대로 APA: 판매가 낮은 순서대로 RD : 최근 등록상품이 위로 RA : 최근 등록상품이 아래로 UD : 최근 수정상품이 위로 UA : 최근 수정상품이 아래로 NA : 상품명 가나다순 ND : 상품명 가나다역순 PD : 판매가 높은 상품이 위로 PA : 판매가 높은 상품이 아래로 SD : 판매량 높은 상품이 위로 SA : 판매량 높은 상품이 아래로 CD : 조회수가 높은 상품이 위로 CA : 조회수가 높은 상품이 아래로 LD : 좋아요수가 높은 상품이 위로 LA : 좋아요수가 높은 상품이 아래로
timetable 배열 최대사이즈: [24]	업데이트 시간
period	데이터 집계 기간 1: 1일 3: 3일 7: 1주(7일) 30: 30일
except_categories	제외 분류

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
category_no	분류 번호 상품분류의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품분류 번호는 중복되지 않음.
category_depth 최소: [1]~최대: [4]	분류 Depth 해당 상품분류가 하위 몇 차 상품분류에 있는 카테고리인지 표시함. 1~4차까지 상품분류가 존재한다.
parent_category_no	부모 분류 번호 해당 상품분류가 2차(중분류), 3차(소분류), 4차(세분류)일 경우 상위에 있는 상품분류의 번호를 표시함. parent_category_no = 1일 경우 해당 분류는 대분류를 의미한다.
category_name 최대글자수 : [50자]	분류명 해당 상품분류의 이름을 나타낸다.
display_type	쇼핑몰 표시설정 해당 상품분류가 PC 쇼핑몰이나 모바일 쇼핑몰, 둘 다에 노출되는지 표시. A : PC + 모바일 P : PC M : 모바일 F : 모두 사용안함
full_category_name	분류 전체 이름 해당 상품분류가 속해있는 상위 상품분류의 이름을 모두 표시.
full_category_no	분류 전체 번호 해당 상품분류가 속해있는 상위 상품분류의 번호를 모두 표시.
root_category_no	최상위 분류 번호 해당 상품분류가 속해있는 최상위 상품분류의 분류 번호 표시.
use_main	메인분류 표시상태 해당 상품분류가 쇼핑몰 메인에 표시되는지 여부. 메인분류에 표시하는 경우 중/소/상세 분류도 대분류처럼 최상위에 표시된다. T : 표시함 F : 표시안함
use_display	표시상태 해당 상품분류의 표시 여부. 표시안함 일 경우 해당 상품분류에 접근할 수 없다. 해당 설정은 멀티쇼핑몰별로 설정할 수 없으며 모든 쇼핑몰에 적용된다. T : 표시함 F : 표시안함
display_order	진열 순서 상품분류를 쇼핑몰 운영자가 배치한 순서.
soldout_product_display	품절상품진열 품절 상품을 상품 분류의 맨 앞 또는 맨 뒤에 진열할 것인지 여부 상품의 품절 여부는 List all products를 통해 sold_out 파라메터로 알 수 있다. B : 품절상품 맨 뒤로 N : 품절상품 상관없음
sub_category_product_display	하위분류 상품진열 현재 상품 분류 하위 분류에 진열된 상품들까지 포함하여 진열할 것인지 여부 T : 진열함 F : 진열안함
hashtag_product_display	쇼핑 큐레이션 해시태그 상품진열 해시태그 상품 진열 기능을 사용할 것인지 여부 ※ 해당 기능은 쇼핑 큐레이션 서비스를 사용하는 경우에만 사용 가능하다. T : 진열함 F : 진열안함
hash_tags	쇼핑 큐레이션 해시태그 해당 상품분류의 해시태그 목록 ※ 해당 기능은 쇼핑 큐레이션 서비스를 사용하는 경우에만 사용 가능하다.
product_display_scope	상품분류 진열영역 구분 상품 분류에 상품을 동일하게 정렬할 것인지, 영역별로 정렬할 것인지 설정 "전체"로 설정된 경우 다음 항목을 통해 정렬 설정 가능하다. product_display_type product_display_key product_display_sort product_display_period "영역별"로 설정된 경우 다음 항목을 통해 영역별로 정렬 설정이 가능하다. normal_product_display_type normal_product_display_key normal_product_display_sort normal_product_display_period recommend_product_display_type recommend_product_display_key recommend_product_display_sort recommend_product_display_period new_product_display_type new_product_display_key new_product_display_sort new_product_display_period A : 전체 G : 영역별
product_display_type	상품분류 진열방법 상품분류 정렬 영역 설정이 "전체"일 경우 해당 상품 분류의 진열 방법 A : 자동정렬 U : 사용자 지정 M : 자동정렬 + 사용자 지정
product_display_key	상품분류 진열방법 키 상품분류 정렬 영역 설정이 "전체"이고, 상품분류 진열방법이 "자동정렬" 또는 "자동정렬 + 사용자지정"일 경우 해당 상품 분류를 어떤 기준으로 정렬할 것인지 설정 A : 최근 추가된 상품 R : 최근 등록상품 U : 최근 수정상품 N : 상품명 가나다순 P : 판매가 높은 상품 S : 판매량 높은 상품 C : 조회수가 높은 상품 L : 좋아요수가 높은 상품
product_display_sort	상품분류 진열방법 순서 상품분류 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정 D: 내림차순 A : 오름차순
product_display_period	진열순서에 대한 기간 진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간 W : 전체기간 1D : 1일 3D : 3일 7D : 7일 15D : 15일 1M : 1개월 3M : 3개월 6M : 6개월
normal_product_display_type	상품분류 진열방법 상품분류 정렬 영역 설정이 "영역별"일 경우 일반 상품 영역의 진열 방법 A : 자동정렬 U : 사용자 지정 M : 자동정렬 + 사용자 지정
normal_product_display_key	상품분류 진열방법 키 상품분류 정렬 영역 설정이 "영역별"일 경우 일반 상품 영역을 어떤 기준으로 정렬할 것인지 설정 A : 최근 추가된 상품 R : 최근 등록상품 U : 최근 수정상품 N : 상품명 가나다순 P : 판매가 높은 상품 S : 판매량 높은 상품 C : 조회수가 높은 상품 L : 좋아요수가 높은 상품
normal_product_display_sort	상품분류 진열방법 순서 일반 상품 영역의 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정 D: 내림차순 A : 오름차순
normal_product_display_period	진열순서에 대한 기간 일반 상품 영역의 진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간 W : 전체기간 1D : 1일 3D : 3일 7D : 7일 15D : 15일 1M : 1개월 3M : 3개월 6M : 6개월
recommend_product_display_type	상품분류 진열방법 상품분류 정렬 영역 설정이 "영역별"일 경우 추천 상품 영역의 진열 방법 A : 자동정렬 U : 사용자 지정 M : 자동정렬 + 사용자 지정
recommend_product_display_key	상품분류 진열방법 키 상품분류 정렬 영역 설정이 "영역별"일 경우 추천 상품 영역을 어떤 기준으로 정렬할 것인지 설정 A : 최근 추가된 상품 R : 최근 등록상품 U : 최근 수정상품 N : 상품명 가나다순 P : 판매가 높은 상품 S : 판매량 높은 상품 C : 조회수가 높은 상품 L : 좋아요수가 높은 상품
recommend_product_display_sort	상품분류 진열방법 순서 추천 상품 영역의 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정 D: 내림차순 A : 오름차순
recommend_product_display_period	진열순서에 대한 기간 추천 상품 영역의 진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간 W : 전체기간 1D : 1일 3D : 3일 7D : 7일 15D : 15일 1M : 1개월 3M : 3개월 6M : 6개월
new_product_display_type	상품분류 진열방법 상품분류 정렬 영역 설정이 "영역별"일 경우 신상품 영역의 진열 방법 A : 자동정렬 U : 사용자 지정 M : 자동정렬 + 사용자 지정
new_product_display_key	상품분류 진열방법 키 상품분류 정렬 영역 설정이 "영역별"일 경우 신상품 영역을 어떤 기준으로 정렬할 것인지 설정 A : 최근 추가된 상품 R : 최근 등록상품 U : 최근 수정상품 N : 상품명 가나다순 P : 판매가 높은 상품 S : 판매량 높은 상품 C : 조회수가 높은 상품 L : 좋아요수가 높은 상품
new_product_display_sort	상품분류 진열방법 순서 신상품 영역의 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정 D: 내림차순 A : 오름차순
new_product_display_period	진열순서에 대한 기간 신상품 영역의 진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 기준이 되는 기간 W : 전체기간 1D : 1일 3D : 3일 7D : 7일 15D : 15일 1M : 1개월 3M : 3개월 6M : 6개월
access_authority	접근권한 F : 모두 이용 가능 T : 회원만 이용가능 G : 특정회원등급만 이용 가능 A : 특정 운영자만 이용 가능

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
category_depth 최소: [1]~최대: [4]	분류 Depth 조회하고자 하는 상품분류의 차수 검색
category_no	분류 번호 조회하고자 하는 상품분류의 번호
parent_category_no	부모 분류 번호 조회하고자 하는 상품분류의 부모 상품분류 번호 검색 대분류만 검색하고자 할 경우 parent_category_no =1 로 검색한다.
category_name	분류명 검색어를 분류명에 포함하고 있는 상품분류 검색(대소문자 구분 없음)

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
module_code	모듈 코드 각 메인분류에 지정된 모듈 코드
display_group	메인분류 번호
group_name	메인분류 명 메인분류 생성 당시 지정한 분류명
soldout_sort_type	품절상품진열 품절상품을 진열할 위치 B : 품절상품 맨 뒤로 N : 품절상품 상관없음

Category

Product

Collection

Supply

Personal

Order

Community

Customer

Notification

Store

Promotion

Design

Application

Salesreport

Privacy

Mileage

Shipping

non-print

API Index

Introduction

Cafe24 API

Request/Response Format

Method

Admin API Intro

Admin API

API Status Code

How to use GET API

1. 검색조건을 추가하기

2. 파라메터에서 여러조건 검색하기

3. 멀티쇼핑몰 정보 조회

4. 상세 조회와 단건 조회

5. Pagination

6. Field 파라메터

7. Embed 파라메터

API Limit

Versioning

Authentication

Get Authentication Code

Get Access Token

Get Access Token using refresh token

Category

Autodisplay

Autodisplay properties

List all autodisplay

GET

기본스펙

요청사양

Create an autodisplay

POST

기본스펙

요청사양

Update an autodisplay

PUT

기본스펙

요청사양

Delete an autodisplay

DELETE

기본스펙

요청사양

Categories

Categories properties

List all categories

GET

기본스펙

요청사양

Count all categories

GET

기본스펙

요청사양

Get a category

GET

기본스펙

요청사양

Create a category

POST

기본스펙

요청사양

Update a category

PUT

기본스펙