닫기
  • Store

  • Product

  • Order

  • Customer

  • Community

  • Design

  • Promotion

  • Application

  • Category

  • Collection

  • Supply

  • Shipping

  • Salesreport

  • Personal

  • Privacy

  • Mileage

  • Notification

  • Translation

  • Analytics

    non-print

    API Index

    Introduction

    Cafe24 API

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

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

    API Diagram

    리소스 관계를 다이어그램으로 제공하여, 전체적인 카페24 API 체계를 확인할 수 있습니다.

    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": "error code",
          "message": "error 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는 해당 리소스의 정보를 대부분 조회할 수 있으며 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 문서를 참고하여 확인합니다.
    409 동일 리소스에 동일 내용을 업데이트할 경우 수정할 데이터를 요청해주세요.
    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
    
    예) 상품 수정일 범위를 지정하여 상품 조회
    GET https://{mallid}.cafe24api.com/api/v2/products?updated_start_date=2018-01-03T14:01:26+09:00&updated_end_date=2018-02-03T14:01:26+09:00

    2. 콤마로 여러 건을 검색

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

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

    콤마로 여러 건을 검색
    예) 특정 상품번호를 지정하여 상품 조회
    GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13
    
    예) 특정 상품번호와 상품코드를 지정하여 상품 조회
    GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13&product_code=P000000X,P000000W

    3. 멀티쇼핑몰 정보 조회

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

    멀티쇼핑몰 번호를 명시하지 않을 경우, 기본 쇼핑몰의 정보를 조회합니다.

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

    4. 상세 조회와 단건 조회

    리소스의 ID를 명시하여 상세 조회를 할 수 있습니다.

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

    상세 조회와 단건 조회
    예) 특정 상품번호를 지정하여 상품 상세 조회
    GET https://{mallid}.cafe24api.com/api/v2/admin/products/128
    
    
    예) 특정 상품번호를 지정하여 상품 단건 조회
    GET https://{mallid}.cafe24api.com/api/v2/admin/products?product_no=128

    5. Pagination

    조회 결과가 많을 경우, 정해진 'limit' 기본 값만큼 결과가 조회됩니다.

    'limit' 파라메터를 이용하여 조회 건수를 확장할 수 있으며, API마다 정의된 최대 값만큼만 확장할 수 있습니다.

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

    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. 특정 항목 조회

    특정한 값들만 조회하고 싶을 때는 'fields' 파라메터를 사용하여 조회할 수 있습니다.

    특정 항목 조회
    예) 상품명과 상품번호 항목만 조회
    GET https://{mallid}.cafe24api.com/api/v2/admin/products?fields=product_name,product_no

    7. 하위 리소스 조회

    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 2023-12-01 (latest) 이전 버전과 호환되지 않은 변경사항에 대해 날짜로 버전을 제공합니다.

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

    앱 버전은 아래 경로를 통해 확인 및 변경이 가능합니다.

    • 만약 앱이 1초에 2회씩 API를 호출한다면 API 호출을 별다른 제약 없이 계속 사용할 수 있습니다.

    버전의 만료 기간은 최신 버전 릴리즈가 출시된 시점부터 최대 1년입니다.

    해당 버전이 만료된 이후에는 만료되지 않은 버전 중 가장 오래된 버전으로 동작합니다.

    예시 코드 (요청)

    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": "2021-03-01T14:00:00.000",
        "refresh_token": "JeTJ7XpnFC0P..........",
        "refresh_token_expires_at": "2021-03-15T12:00:00.000",
        "client_id": "BrIfqEKoPxeE..........",
        "mall_id": "yourmall",
        "user_id": "test",
        "scopes": [
            "mall.read_order",
            "mall.read_product",
            "mall.read_store",
            "...etc...",
        ],
        "issued_at": "2021-03-01T12:00:00.000"
    }

    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": "21EZes0dGSfN..........",
        "expires_at": "2021-03-01T15:50:00.000",
        "refresh_token": "xLlhWztQHBik............",
        "refresh_token_expires_at": "2021-03-15T13:50:00.000",
        "client_id": "BrIfqEKoPxeE..........",
        "mall_id": "yourmall",
        "user_id": "test",
        "scopes": [
            "mall.read_order",
            "mall.read_product",
            "mall.read_store",
            "...etc...",
        ],
        "issued_at": "2021-03-01T13:50:00.000"
    }

    Store

    Activitylogs

    활동로그(Activitylog)는 쇼핑몰 관리자가 쇼핑몰 어드민에서 진행한 운영 활동을 기록한 내역입니다.
    활동로그 리소스를 사용하면 쇼핑몰의 활동로그를 생성하거나 조회할 수 있습니다.

    Activitylogs properties

    Attribute Description
    process_no

    업무처리 넘버

    mode

    모드

    P : PC 어드민
    M : 모바일 어드민
    S : (구)스마트모드

    type

    구분

    content

    업무내용

    process_date

    처리일시

    manager_id

    형식 : [a-z0-9]
    글자수 최소: [4자]~최대: [16자]

    처리자

    manager_type

    처리자 타입

    Retrieve a list of action logs

    GET

    활동로그를 목록으로 조회할 수 있습니다.
    운영 활동을 한 사람이 누구인지, 어떤 메뉴에서 언제 진행했는지 확인할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    manager_type

    처리자 타입

    P : 대표운영자
    A : 부운영자
    S : 공급사

    manager_id

    형식 : [a-z0-9]
    글자수 최소: [4자]~최대: [16자]

    처리자

    mode

    모드

    P : PC 어드민
    M : 모바일 어드민
    S : (구)스마트모드

    type

    구분

    content

    최대글자수 : [500자]

    업무내용

    start_date
    Required

    날짜

    검색 시작일

    end_date
    Required

    날짜

    검색 종료일

    offset

    최대값: [8000]

    조회결과 시작위치

    DEFAULT 0

    limit

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

    조회결과 최대건수

    DEFAULT 10

    Retrieve an action log

    GET

    활동로그를 상세 조회할 수 있습니다.
    운영 활동을 한 사람이 누구인지, 어떤 메뉴에서 언제 진행했는지 확인할 수 있으며, content를 통해 진행한 내역을 상세하게 확인할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    process_no
    Required

    업무처리 넘버

    Request Copy
    Response Copy

    Automessages arguments

    자동메시지 변수(Automessages arguments)는 자동메시지 발신 시 사용할 수 있는 변수를 확인하는 리소스입니다.

    Automessages arguments properties

    Attribute Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    name

    변수명

    description

    변수 설명

    sample

    변수 예제

    string_length

    메시지 표시 최대 글자수

    글자수 : 설정된 글자수 만큼 표시
    가변 : 글자수 제한 없이 모두 표시

    send_case

    사용 가능 발송 상황

    Retrieve the list of available variables for automated messages

    GET

    자동메시지 발송 설정내역을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve the list of available variables for automated messages
    Request Copy
    Response Copy

    Automessages setting

    자동메시지 설정(Automessages setting)은 메시지 자동 발송 시 사용 중인 발송 수단을 확인 및 어떤 발송 수단으로 우선발송할 지 조회, 변경하는 리소스입니다.

    Automessages setting properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    use_sms

    SMS 사용 여부

    T: 사용함
    F: 사용안함

    use_kakaoalimtalk

    카카오알림톡 사용 여부

    T: 사용함
    F: 사용안함

    use_push

    PUSH 사용 여부

    T: 사용함
    F: 사용안함

    send_method

    자동 발송 메시지 발송 방법

    S: SMS
    K: 카카오알림톡(발송 실패 시
    SMS로 대체 발송)

    send_method_push

    푸시 수신 대상에게 푸시 우선 발송 여부

    T : 우선 발송함
    F : 우선 발송 안함

    Retrieve the automated message settings

    GET

    자동메시지 발송 설정내역을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve the automated message settings
    Request Copy
    Response Copy

    Update an automated message

    PUT

    자동메시지 발송 설정내역을 변경할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    send_method
    Required

    자동 발송 메시지 발송 방법

    S: SMS
    K: 카카오알림톡(발송 실패 시
    SMS로 대체 발송)

    send_method_push

    푸시 수신 대상에게 푸시 우선 발송 여부

    T : 우선 발송함
    F : 우선 발송 안함

    Update an automated message
    Request Copy
    Response Copy

    Coupons setting

    쿠폰 설정(Coupons setting)은 쇼핑몰에서 사용할 쿠폰의 기본적인 설정을 입력할 수 있습니다.
    쿠폰의 할인, 적립 기능의 사용여부와 제한조건, 진열 등 다양한 측면의 설정이 가능합니다.

    Coupons setting properties

    Attribute Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    use_coupon

    쿠폰사용

    T:사용함
    F:사용안함

    available_issue_type

    쿠폰 사용 제한

    A:주문서+상품별 쿠폰 사용
    O:주문서 쿠폰만 사용
    P:상품별 쿠폰만 사용

    allow_using_coupons_with_points

    적립금 동시사용

    T:사용함
    F:사용안함

    allow_using_coupons_with_discounts

    할인 동시사용

    A:쿠폰+회원등급 할인 동시 사용
    C:쿠폰만 사용
    G:회원등급 할인만 사용

    allow_using_product_and_order_coupons

    상품/주문서 동시사용

    T:사용함
    F:사용안함

    recover_coupon_setting

    쿠폰 복원 설정

    max_coupon_count

    쿠폰 사용 개수 제한

    use_additional_coupon

    추가 사용 쿠폰

    T:사용함
    F:사용안함

    additional_coupon_no

    추가 사용 쿠폰 번호

    show_coupon_to_non_members

    비회원 노출설정

    T:노출함
    F:노출안함

    show_group_coupon_to_non_members

    회원등급할인이 지정된 쿠폰 포함

    T : 포함
    F : 미포함

    show_issued_coupon

    발급된 쿠폰 표시 여부

    T:노출함
    F:노출안함

    sorting_type

    정렬 기준

    A:쿠폰 시작일자
    B:쿠폰 종료일자
    C:쿠폰 발급일자
    D:할인/적립금액
    E:할인/적립율

    download_image_type

    기본 쿠폰 다운로드 이미지

    1:TYPE1
    2:TYPE2
    3:TYPE3
    4:TYPE4
    5:TYPE5

    background_image_type

    기본 쿠폰 배경 이미지

    1:TYPE1
    2:TYPE2
    3:TYPE3
    4:TYPE4
    5:TYPE5

    Retrieve coupon settings

    GET

    쿠폰 사용 여부나 쿠폰과 할인 동시 사용 여부 등 설정 정보를 조회합니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve coupon settings
    Request Copy
    Response Copy

    Update coupon settings

    PUT

    쿠폰 설정 정보를 수정합니다.
    쿠폰 사용여부, 쿠폰 사용 제한, 쿠폰 사용 개수 제한 등의 정보를 변경할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    use_coupon

    쿠폰사용

    T:사용함
    F:사용안함

    available_issue_type

    쿠폰 사용 제한

    A:주문서+상품별 쿠폰 사용
    O:주문서 쿠폰만 사용
    P:상품별 쿠폰만 사용

    allow_using_coupons_with_points

    적립금 동시사용

    T:사용함
    F:사용안함

    allow_using_coupons_with_discounts

    할인 동시사용

    A:쿠폰+회원등급 할인 동시 사용
    C:쿠폰만 사용
    G:회원등급 할인만 사용

    allow_using_product_and_order_coupons

    상품/주문서 동시사용

    T:사용함
    F:사용안함

    recover_coupon_setting

    쿠폰 복원 설정

    restore_viewpoint
    쿠폰 복원 시점
    A: 취소/교환/반품 접수
    B: 취소/교환/반품 완료

    cancel_before_pay
    입금전취소
    T:자동 복원함
    F:자동 복원 안함
    M:쿠폰복원 여부를 확인함

    cancel_after_pay
    입금후 취소
    T:자동 복원함
    F:자동 복원 안함
    M:쿠폰복원 여부를 확인함

    return
    반품
    T:자동 복원함
    F:자동 복원 안함
    M:쿠폰복원 여부를 확인함

    exchange
    교환
    T:자동 복원함
    F:자동 복원 안함
    M:쿠폰복원 여부를 확인함

    part
    부분 취소/반품/교환
    F:쿠폰 복원 안함
    M:쿠폰복원 여부를 확인함

    max_coupon_count

    쿠폰 사용 개수 제한

    product_per_product
    상품당 상품쿠폰 사용 개수 제한

    order_per_order
    1회 주문당 주문서 쿠폰 개수 제한

    product_and_order_per_order
    주문건당 (주문서+상품쿠폰) 쿠폰 개수 제한

    product_per_order
    1회 주문당 상품쿠폰 쿠폰 개수 제한

    product_and_order_per_day
    일간 (주문서+상품쿠폰) 쿠폰 개수 제한

    use_additional_coupon

    추가 사용 쿠폰

    T:사용함
    F:사용안함

    additional_coupon_no

    배열 최대사이즈: [5]

    추가 사용 쿠폰 번호

    coupon_no
    쿠폰번호

    show_coupon_to_non_members

    비회원 노출설정

    T:노출함
    F:노출안함

    show_group_coupon_to_non_members

    회원등급할인이 지정된 쿠폰 포함

    T : 포함
    F : 미포함

    show_issued_coupon

    발급된 쿠폰 표시 여부

    T:노출함
    F:노출안함

    sorting_type

    정렬 기준

    A:쿠폰 시작일자
    B:쿠폰 종료일자
    C:쿠폰 발급일자
    D:할인/적립금액
    E:할인/적립율

    download_image_type

    기본 쿠폰 다운로드 이미지

    1:TYPE1
    2:TYPE2
    3:TYPE3
    4:TYPE4
    5:TYPE5

    background_image_type

    기본 쿠폰 배경 이미지

    1:TYPE1
    2:TYPE2
    3:TYPE3
    4:TYPE4
    5:TYPE5

    Request Copy
    Response Copy

    Currency

    환율 정보(Currency)는 쇼핑몰의 화폐 정보, 환율 정보 등을 확인할 수 있는 리소스입니다.

    Currency properties

    Attribute Description
    exchange_rate

    결제 화폐 환율 정보

    standard_currency_code

    기준 화폐 코드

    해당 쇼핑몰의 기본쇼핑몰에서 사용하는 화폐 코드. 기준 화폐란 일반적으로 쇼핑몰 운영자가 속한 국가에서 통용되는 화폐를 의미한다.

    standard_currency_symbol

    기준 화폐 심볼

    해당 쇼핑몰의 기본쇼핑몰에서 사용하는 화폐의 화폐 기호. 기준 화폐란 일반적으로 쇼핑몰 운영자가 속한 국가에서 통용되는 화폐를 의미한다.

    shop_currency_code

    결제 화폐 코드

    shop_currency_symbol

    결제 화폐 심볼

    shop_currency_format

    결제 화폐 표시 방식

    Retrieve currency settings

    GET

    쇼핑몰에서 사용하는 화폐의 정보와 환율 정보를 조회합니다.

    기본스펙

    Property Description
    SCOPE 상점 읽기권한 (mall.read_store)
    호출건수 제한 40
    Retrieve currency settings
    Request Copy
    Response Copy

    Dashboard

    대시보드(Dashboard)는 쇼핑몰의 주문 현황과 매출 현황 등 쇼핑몰 운영에 필요한 정보를 간략하게 요약해놓은 정보입니다.

    Dashboard properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    daily_sales_stats

    일일 현황 정보

    일 단위의 매출 현황 정보

    weekly_sales_stats

    주간 매출 현황

    주간 단위의 매출 현황 정보

    monthly_sales_stats

    월간 매출 현황

    월간 단위의 매출 현황 정보

    sold_out_products_count

    품절된 상품 수

    품절된 상품의 수. 재고관리기능과 품절기능이 활성화 되어있을 경우 집계에 포함됨.

    new_members_count

    신규회원 수

    신규가입한 회원의 숫자

    board_list

    게시판 목록

    해당 몰의 게시판의 리스트

    Retrieve a dashboard

    GET

    대시보드 정보를 조회합니다.
    매출 현황 정보등을 확인할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    Retrieve a dashboard
    Request Copy
    Response Copy

    Financials paymentgateway

    Financials paymentgateway(PG 정보)는 PG사별 계약정보를 제공합니다.

    Financials paymentgateway properties

    Attribute Description
    partner_id

    PG사 발급 가맹점 ID

    payment_gateway_name

    PG 이름

    inicis : 이니시스
    kcp : KCP
    allat : 올앳
    ksnet : KSNET
    dacom : 토스페이먼츠
    allthegate : 올더게이트
    settlebank : 세틀뱅크
    smartro : 스마트로
    kicc : 한국정보통신
    mobilians : 모빌리언스
    danal : 다날

    contract_date

    PG 계약일

    setting_date

    PG 세팅일

    bank_code

    정산입금 은행코드

    은행 코드 조회하기

    bank_account_no

    정산입금 계좌정보

    status

    금융제휴여부

    T:제휴함
    F: 제휴안함

    bank_account_name

    정산입금 예금주명

    payment_method_information

    결제수단별 정산 정보

    ※ payment_method_information 하위 요소에 대한 값 정의

    1) payment_method_information > period(정산 기간)

    D : 일별
    W : 주별
    M : 월별

    Retrieve a list of Payment Gateway contract details

    GET

    PG사별 계약정보를 목록으로 조회할 수 있습니다.
    PG계약일, 결제수단별 정산 정보 등을 확인할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    payment_gateway_name

    PG 이름

    partner_id

    PG사 발급 가맹점 ID

    Request Copy
    Response Copy

    Financials store

    Financials store(상점의 거래정보)는 상점의 PG사별 거래정보를 제공합니다.

    Financials store properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    first_payment_date

    최초 결제일

    payment_gateway_name

    PG 이름

    Retrieve the transaction information of a store

    GET

    상점의 결제수단별 거래정보를 조회할 수 있습니다.

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

    기본스펙

    Property Description
    SCOPE 상점 읽기권한 (mall.read_store)
    호출건수 제한 1

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    payment_method
    Required

    결제수단 코드

    card : 신용카드
    tcash : 계좌이체
    icash : 가상계좌
    cell : 휴대폰
    deferpay : 후불
    cvs : 편의점
    point : 선불금
    etc : 기타

    Retrieve the transaction information of a store
    Request Copy
    Response Copy

    Images setting

    상품 이미지 사이즈 설정 값을 조회하거나 수정할 수 있습니다.

    Images setting properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    product_image_size

    상품 이미지 사이즈 설정값

    Retrieve product image size settings

    GET

    상품 이미지 사이즈 설정 값을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve product image size settings
    Request Copy
    Response Copy

    Update product image size settings

    PUT

    상품 이미지 사이즈 설정 값을 수정할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    product_image_size
    Required

    상품 이미지 사이즈 설정값

    detail_image_width
    상세 이미지 가로

    detail_image_height
    상세이미지 세로

    list_image_width
    목록 이미지 가로

    list_image_height
    목록 이미지 세로

    tiny_image_width
    작은 목록 이미지 가로

    tiny_image_height
    작은 목록 이미지 세로

    zoom_image_width
    확대 이미지 가로

    zoom_image_height
    확대 이미지 세로

    small_image_width
    축소 이미지 가로

    small_image_height
    축소 이미지 세로

    Request Copy
    Response Copy

    Kakaoalimtalk profile

    상점의 카카오채널 프로필키 등록여부를 확인할 수 있는 리소스입니다.

    Kakaoalimtalk profile properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    kakao_senderkey

    카카오 채널 발신 프로필 키

    Retrieve a Kakao Channel sender profile key

    GET

    카카오채널 발신 프로필키(senderkey)를 조회할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve a Kakao Channel sender profile key
    Request Copy
    Response Copy

    Kakaoalimtalk setting

    카카오알림톡 서비스(Kakaoalimtalk setting) 사용 여부를 조회하고 설정을 변경하는 리소스입니다.

    Kakaoalimtalk setting properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    use_kakaoalimtalk

    카카오알림톡 사용 여부

    T: 사용함
    F: 사용안함

    Retrieve the Kakao Info-Talk settings

    GET

    카카오알림톡 서비스 발송설정 내역을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve the Kakao Info-Talk settings
    Request Copy
    Response Copy

    Update the Kakao Info-Talk settings

    PUT

    카카오알림톡 서비스 발송 설정내역을 변경할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    use_kakaoalimtalk

    카카오알림톡 사용 여부

    T: 사용함
    F: 사용안함

    Update the Kakao Info-Talk settings
    Request Copy
    Response Copy

    Kakaopay setting

    쇼핑몰의 카카오페이 설정을 조회하거나 수정할 수 있습니다.

    Kakaopay setting properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    shop_key

    입점시 부여 받는 판매점의 고유 식별자

    pixel_code

    연동사(ECP/독립몰)에서 이미 사용중인 카카오 광고 픽셀 ID

    use_kakaopay

    카카오페이 구매 사용여부

    T : 사용함
    F : 사용안함

    product_detail_button_size

    쇼핑몰 상세상품 페이지 버튼 사이즈

    basket_button_size

    쇼핑몰 장바구니 페이지 버튼 사이즈

    use_dark_mode

    쇼핑몰 다크모드 적용여부

    T : 활성화
    F : 비활성화

    button_authorization_key

    입점시 부여 받는 판매점의 버튼 인증

    thirdparty_agree

    제3자 제공 동의 여부

    T : 동의함
    F : 동의안함

    thirdparty_agree_date

    제3자 제공 동의 날짜

    Retrieve settings for KakaoPay orders

    GET

    쇼핑몰의 카카오페이 설정을 조회합니다.
    카카오페이 구매 사용여부, 제3자 제공 동의 여부 등의 정보를 확인할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve settings for KakaoPay orders
    Request Copy
    Response Copy

    Update settings for KakaoPay orders

    PUT

    쇼핑몰의 카카오페이 설정을 수정합니다.
    카카오페이 구매 사용여부, 쇼핑몰 다크모드 적용여부 등의 정보를 수정할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    shop_key

    입점시 부여 받는 판매점의 고유 식별자

    pixel_code

    연동사(ECP/독립몰)에서 이미 사용중인 카카오 광고 픽셀 ID

    use_kakaopay

    카카오페이 구매 사용여부

    T : 사용함
    F : 사용안함

    product_detail_button_size

    쇼핑몰 상세상품 페이지 버튼 사이즈

    pc
    pc

    mobile
    mobile

    basket_button_size

    쇼핑몰 장바구니 페이지 버튼 사이즈

    pc
    pc

    mobile
    mobile

    use_dark_mode

    쇼핑몰 다크모드 적용여부

    T : 활성화
    F : 비활성화

    button_authorization_key

    입점시 부여 받는 판매점의 버튼 인증

    thirdparty_agree

    제3자 제공 동의 여부

    T : 동의함
    F : 동의안함

    thirdparty_agree_date

    날짜

    제3자 제공 동의 날짜

    Update settings for KakaoPay orders
    Request Copy
    Response Copy

    메뉴(Menus)는 쇼핑몰의 메뉴 모드에 관한 기능입니다.
    쇼핑몰의 메뉴 모드와 경로 등을 조회할 수 있습니다.
    쇼핑몰의 메뉴 모드로는 프로모드, 스마트모드, 모바일 어드민이 있습니다.

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    mode

    메뉴 모드

    new_pro: PC 어드민
    mobile_admin : 모바일 어드민

    menu_no

    메뉴 번호

    name

    메뉴명

    path

    메뉴 경로

    contains_app_url

    앱 URL 포함 여부

    T : 포함
    F : 미포함

    Retrieve menus

    GET

    쇼핑몰의 메뉴 모드와 경로 등을 목록으로 조회할 수 있습니다.
    메뉴 모드, 메뉴 번호, 앱 URL 포함 여부 등을 확인할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    mode

    메뉴 모드

    new_pro: PC 어드민
    mobile_admin : 모바일 어드민

    DEFAULT new_pro

    menu_no

    메뉴 번호

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

    contains_app_url

    앱 URL 포함 여부

    T : 포함
    F : 미포함

    Mobile setting

    모바일 설정(Mobile setting)은 쇼핑몰의 모바일 쇼핑몰 설정에 관한 리소스입니다.
    모바일 쇼핑몰 사용 여부와 접속 주소 자동연결의 사용/사용안함 여부를 조회할 수 있습니다.

    Mobile setting properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    use_mobile_page

    모바일 쇼핑몰 사용설정

    T : 사용함
    F : 사용안함

    use_mobile_domain_redirection

    모바일 접속 주소 자동연결 설정

    T : 사용함
    F : 사용안함

    Retrieve mobile settings

    GET

    쇼핑몰의 모바일 설정을 조회할 수 있습니다.

    기본스펙

    Property Description
    SCOPE 상점 읽기권한 (mall.read_store)
    호출건수 제한 10

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve mobile settings
    Request Copy
    Response Copy

    네이버페이 설정(Naverpay Setting)은 쇼핑몰의 네이버페이 공통인증키를 조회하거나 수정할 수 있는 기능입니다.

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    authentication_key

    네이버 공통 인증키

    naverpay_version

    네이버페이 연동버전

    shop_id

    페이센터 ID

    is_button_show

    네이버페이 구매 버튼 노출

    is_used_order

    네이버 주문연동

    is_used_review

    네이버 구매평연동

    is_show_review

    네이버 구매평노출

    is_order_page

    네이버페이 구매 버튼 클릭 시 페이지 이동

    certi_key

    네이버 가맹점 인증키

    image_key

    네이버 버튼 인증키

    naver_button_pc_product

    네이버 버튼 디자인 : PC 상품상세페이지

    naver_button_pc_basket

    네이버 버튼 디자인 : PC 장바구니페이지

    naver_button_mobile_product

    네이버 버튼 디자인 : Mobile 상품상세페이지

    naver_button_mobile_basket

    네이버 버튼 디자인 : Mobile 장바구니페이지

    Retrieve Naver Pay settings

    GET

    쇼핑몰의 네이버페이 공통인증키를 조회합니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve Naver Pay settings
    Request Copy
    Response Copy

    Create Naver Pay settings

    POST

    네이버페이 가맹 시 네이버에서 발급한 공통인증키를 쇼핑몰 어드민에 등록할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    authentication_key

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

    네이버 공통 인증키

    naverpay_version

    네이버페이 연동버전

    DEFAULT 2.1

    shop_id
    Required

    페이센터 ID

    is_button_show

    네이버페이 구매 버튼 노출

    DEFAULT T

    is_used_order

    네이버 주문연동

    DEFAULT T

    is_used_review

    네이버 구매평연동

    DEFAULT T

    is_show_review

    네이버 구매평노출

    DEFAULT T

    is_order_page

    네이버페이 구매 버튼 클릭 시 페이지 이동

    DEFAULT N

    certi_key
    Required

    네이버 가맹점 인증키

    image_key
    Required

    네이버 버튼 인증키

    naver_button_pc_product

    네이버 버튼 디자인 : PC 상품상세페이지

    DEFAULT A|1|2

    naver_button_pc_basket

    네이버 버튼 디자인 : PC 장바구니페이지

    DEFAULT A|1|1

    naver_button_mobile_product

    네이버 버튼 디자인 : Mobile 상품상세페이지

    DEFAULT MA|1|2

    naver_button_mobile_basket

    네이버 버튼 디자인 : Mobile 장바구니페이지

    DEFAULT MA|1|1

    Create Naver Pay settings
    Request Copy
    Response Copy

    Update Naver Pay settings

    PUT

    쇼핑몰의 네이버페이 공통인증키를 수정합니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    authentication_key

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

    네이버 공통 인증키

    Update Naver Pay settings
    Request Copy
    Response Copy

    Orders setting

    취소/반품시 자동 수량 복구 및 할인/적립 금액 등 주문 설정에 대해 조회, 수정 할 수 있는 기능입니다.

    Orders setting properties

    Attribute Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    claim_request

    구매자 취소/교환/반품 신청 사용설정

    T : 사용함
    F : 사용안함

    claim_request_type

    구매자 취소/교환/반품 신청 시 표시항목 설정

    claim_request 항목이 T일 때만 확인이 가능하다.

    S : 기본신청 항목 표시
    D : 상세신청 항목 표시

    claim_request_button_exposure

    구매자 취소/교환/반품 신청버튼 노출 범위 설정

    cancel_N10 : 취소신청 상품준비중
    cancel_N20 : 취소신청 배송준비중
    cancel_N22 : 취소신청 배송보류
    cancel_N21 : 취소신청 배송대기
    exchange_N00 : 교환신청 입금전
    exchange_N10 : 교환신청 상품준비중
    exchange_N20 : 교환신청 배송준비중
    exchange_N22 : 교환신청 배송보류
    exchange_N21 : 교환신청 배송대기
    exchange_N30 : 교환신청 배송중
    exchange_N40 : 교환신청 배송완료
    return_N30 : 반품신청 배송중
    return_N40 : 반품신청 배송완료

    claim_request_button_date_type

    구매자 취소/교환/반품 신청버튼 노출 기준일

    order_date : 주문 완료일 기준
    shipend_date : 배송완료일 기준

    claim_request_button_period

    구매자 취소/교환/반품 신청버튼 노출 기간

    stock_recover

    취소/반품 시 자동 수량복구

    T : 기본 설정
    F : 개별 설정

    stock_recover_base

    취소/반품 시 자동 수량복구 - 기본설정

    T : 자동 복구함
    F : 자동 복구 안함
    M : 수량복구 여부를 확인함

    stock_recover_individual

    취소/반품 시 자동 수량복구 - 개별설정

    claim_request_auto_accept

    구매자 취소/반품 신청 건 자동 접수 설정

    T : 사용함
    F : 사용안함

    refund_benefit_setting

    취소/교환/반품 접수 시 할인/적립 금액 설정

    refund_processing_setting

    취소/교환/반품 접수 시 환불 접수 처리 설정

    S : 동시에 처리함
    D : 분리하여 처리함

    use_product_prepare_status

    상품준비중 주문상태 사용여부

    T : 사용함
    F : 사용안함

    use_purchase_confirmation_button

    구매확정 버튼 사용여부

    T : 사용함
    F : 사용안함

    purchase_confirmation_button_set_date

    구매확정 버튼 적용 날짜

    use_purchase_confirmation_auto_check

    구매확정 자동체크 사용여부

    T : 사용함
    F : 사용안함

    purchase_confirmation_auto_check_day

    구매확정 자동체크 기준일

    purchase_confirmation_auto_check_set_date

    구매확정 자동체크 적용 날짜

    use_additional_fields

    추가항목 사용 여부

    T : 사용함
    F : 사용안함

    customer_pays_return_shipping

    배송 후 교환/반품 신청 시 구매자부담 배송비 결제 사용 여부

    T : 사용함
    F : 사용안함

    refund_bank_account_required

    취소/교환/반품 시 환불계좌정보 등록 필수 여부

    T : 필수
    F : 선택

    Retrieve Order Settings

    GET

    취소/반품시 자동 수량 복구 및 할인/적립 금액 등 주문 설정에 대해 조회합니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve Order Settings
    Request Copy
    Response Copy

    Update Order settings

    PUT

    취소/교환/반품 접수 시의 할인/적립 금액 설정을 변경할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    refund_benefit_setting

    취소/교환/반품 접수 시 할인/적립 금액 설정

    F: 전체 금액 기준으로 표시
    T: 선택 품목 기준으로 표시
    U: 할인금액 자동계산(설정한 이후 접수된 주문부터 적용)

    use_product_prepare_status

    상품준비중 주문상태 사용여부

    T : 사용함
    F : 사용안함

    use_purchase_confirmation_button

    구매확정 버튼 사용여부

    T : 사용함
    F : 사용안함

    purchase_confirmation_button_set_date

    날짜

    구매확정 버튼 적용 날짜

    use_purchase_confirmation_auto_check

    구매확정 자동체크 사용여부

    T : 사용함
    F : 사용안함

    purchase_confirmation_auto_check_day

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

    구매확정 자동체크 기준일

    purchase_confirmation_auto_check_set_date

    날짜

    구매확정 자동체크 적용 날짜

    Update Order settings
    Request Copy
    Response Copy

    Paymentgateway



    PG(Paymentgateway)를 통해 PG앱의 조회, 등록, 수정, 삭제가 가능합니다.

    Paymentgateway properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    partner_id

    PG사 발급 가맹점 ID

    client_id

    앱 클라이언트 ID

    additional_information

    추가 정보

    membership_fee_type

    가입비 분류

    PRE : 선불
    PAD : 후불
    FREE : 무료

    service_limit_type

    서비스 제한

    A : 회원/비회원 제한 없음
    M : 회원만 제공

    Create a Payment Gateway

    POST

    쇼핑몰에 새로운 PG를 등록할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    partner_id
    Required

    최대글자수 : [50자]

    PG사 발급 가맹점 ID

    additional_information

    배열 최대사이즈: [5]

    추가 정보

    key
    추가항목 키

    value
    추가항목 값

    membership_fee_type

    최대글자수 : [4자]

    가입비 분류

    PRE : 선불
    PAD : 후불
    FREE : 무료

    service_limit_type

    최대글자수 : [1자]

    서비스 제한

    A : 회원/비회원 제한 없음
    M : 회원만 제공

    DEFAULT A

    Request Copy
    Response Copy

    Update a Payment Gateway

    PUT

    쇼핑몰에 등록된 PG를 수정할 수 있습니다.
    PG사 발급 사맹점 ID, 가입비 여부 등을 수정할 수 있습니다.
    수정을 위해서는 PG앱의 클라이언트 아이디가 필수입니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    client_id
    Required

    최대글자수 : [50자]

    앱 클라이언트 ID

    partner_id

    최대글자수 : [50자]

    PG사 발급 가맹점 ID

    additional_information

    배열 최대사이즈: [5]

    추가 정보

    key
    추가항목 키

    value
    추가항목 값

    membership_fee_type

    최대글자수 : [4자]

    가입비 분류

    PRE : 선불
    PAD : 후불
    FREE : 무료

    service_limit_type

    최대글자수 : [1자]

    서비스 제한

    A : 회원/비회원 제한 없음
    M : 회원만 제공

    DEFAULT A

    Request Copy
    Response Copy

    Delete a Payment Gateway

    DELETE

    쇼핑몰에 등록된 PG를 삭제할 수 있습니다.
    삭제를 위해서는 PG앱의 클라이언트 아이디가 필수입니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    client_id
    Required

    최대글자수 : [50자]

    앱 클라이언트 ID

    Delete a Payment Gateway
    Request Copy
    Response Copy

    Paymentgateway paymentmethods

    PG의 결제수단(Paymentgateway paymentmethods)은 쇼핑몰에 등록된 PG의 결제수단에 대한 기능입니다.
    특정 PG에서 제공하고 있는 결제수단의 등록, 조회, 수정, 삭제가 가능합니다.

    Paymentgateway paymentmethods properties

    Attribute Description
    client_id

    앱 클라이언트 ID

    payment_method_code

    결제수단 코드

    payment_method

    결제수단

    card : 신용카드
    tcash : 계좌이체
    icash : 가상계좌
    cell : 휴대폰
    cvs : 편의점
    deferpay : 후불결제
    etc : 기타

    payment_method_name

    결제수단명

    payment_method_url

    결제수단 이미지 경로

    available_shop_no

    이용가능한 멀티쇼핑몰 번호

    Retrieve a list of Payment Gateway methods

    GET

    앱으로 설치한 쇼핑몰의 PG에 대해서 지원하는 결제수단을 조회할 수 있습니다.
    결제수단 코드, 결제수단, 결제수단명 등을 조회할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    client_id
    Required

    최대글자수 : [50자]

    앱 클라이언트 ID

    Request Copy
    Response Copy

    Create a Payment Gateway method

    POST

    앱으로 설치한 쇼핑몰의 PG에 대해서 결제수단을 등록할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    client_id
    Required

    최대글자수 : [50자]

    앱 클라이언트 ID

    payment_method_code
    Required

    최대글자수 : [50자]

    결제수단 코드

    payment_method
    Required

    결제수단

    card : 신용카드
    tcash : 계좌이체
    icash : 가상계좌
    cell : 휴대폰
    cvs : 편의점
    deferpay : 후불결제
    etc : 기타

    payment_method_name
    Required

    최대글자수 : [50자]

    결제수단명

    payment_method_url
    Required

    최대글자수 : [200자]

    결제수단 이미지 경로

    지원 확장자 : 'png', 'jpg', 'jpeg'

    available_shop_no

    이용가능한 멀티쇼핑몰 번호

    Create a Payment Gateway method
    Request Copy
    Response Copy

    Update a payment method of a Payment Gateway

    PUT

    앱으로 설치한 쇼핑몰의 PG에 대해서 특정 결제수단을 수정할 수 있습니다.
    결제수단, 결제수단명 등을 수정할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    client_id
    Required

    최대글자수 : [50자]

    앱 클라이언트 ID

    payment_method_code
    Required

    최대글자수 : [50자]

    결제수단 코드

    payment_method

    결제수단

    card : 신용카드
    tcash : 계좌이체
    icash : 가상계좌
    cell : 휴대폰
    cvs : 편의점
    deferpay : 후불결제
    etc : 기타

    payment_method_name

    최대글자수 : [50자]

    결제수단명

    payment_method_url

    최대글자수 : [200자]

    결제수단 이미지 경로

    지원 확장자 : 'png', 'jpg', 'jpeg'

    available_shop_no

    이용가능한 멀티쇼핑몰 번호

    Update a payment method of a Payment Gateway
    Request Copy
    Response Copy

    Delete a payment method of a Payment Gateway

    DELETE

    앱으로 설치한 쇼핑몰의 PG에 대해서 특정 결제수단을 삭제할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    client_id
    Required

    최대글자수 : [50자]

    앱 클라이언트 ID

    payment_method_code
    Required

    최대글자수 : [50자]

    결제수단 코드

    Delete a payment method of a Payment Gateway
    Request Copy
    Response Copy

    Paymentmethods



    쇼핑몰에 설정된 결제수단을 조회할 수 있습니다.

    Paymentmethods properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    code

    결제수단 코드

    Retrieve a list of payment methods

    GET

    쇼핑몰에 설정된 결제수단 목록을 조회합니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve a list of payment methods
    Request Copy
    Response Copy

    Paymentmethods paymentproviders



    쇼핑몰에 설정된 결제수단의 정보를 조회하거나 결제수단의 노출여부를 수정할 수 있습니다.

    Paymentmethods paymentproviders properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    name

    PG 이름

    display

    결제수단 노출여부

    T : 노출함
    F : 노출안함

    Retrieve a list of providers by payment method

    GET

    쇼핑몰에 설정된 결제수단의 정보를 조회합니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    code
    Required

    결제수단 코드

    name

    PG 이름

    display

    결제수단 노출여부

    T : 노출함
    F : 노출안함

    Retrieve a list of providers by payment method
    Request Copy
    Response Copy

    Update the display status of a payment method

    PUT

    쇼핑몰에 설정된 결제수단의 노출여부를 수정합니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    code
    Required

    결제수단 코드

    name
    Required

    PG 이름

    display
    Required

    결제수단 노출여부

    T : 노출함
    F : 노출안함

    Update the display status of a payment method
    Request Copy
    Response Copy

    Points setting

    적립금 설정(Points setting)은 적립금 사용에 필요한 설정값을 관리하기 위한 기능입니다.

    Points setting properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    point_issuance_standard

    적립금 지급 기준

    C: 배송완료 후
    P: 구매확정 후

    payment_period

    적립금 지급 시점

    적립금 지급 기준이 C: 배송완료 후 일때 1/3/7/14/20을 입력할 수 있습니다.
    적립금 지급 기준이 P: 구매확정 후 일때 0/1/3/7/14/20을 입력할 수 있습니다.

    name

    적립금 명칭

    format

    적립금 표시 방식

    round_unit

    적립금 절사 단위

    F : 절사안함
    0.01 : 0.01단위
    0.1 : 0.1단위
    1 : 1단위
    10 : 10단위
    100 : 100단위
    1000 : 1000단위

    round_type

    적립금 절사 방식

    A : 내림
    B : 반올림
    C : 올림

    display_type

    적립금 항목 노출 설정

    P : 정율
    W : 정액
    WP : 정액/정율
    PW : 정율/정액

    unusable_points_change_type

    미가용 적립금 변환 기준 설정

    M: 최초 상품 배송완료일/구매확정일 기준으로 적립
    T: 마지막 상품 배송완료일/구매확정일 기준으로 적립

    Retrieve points settings

    GET

    명칭, 지급 시점, 단위 등의 적립금 설정 값을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve points settings
    Request Copy
    Response Copy

    Update points settings

    PUT

    적립금 설정 값을 수정할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    point_issuance_standard

    적립금 지급 기준

    C: 배송완료 후
    P: 구매확정 후

    payment_period

    적립금 지급 시점

    적립금 지급 기준이 C: 배송완료 후 일때 1/3/7/14/20을 입력할 수 있습니다.
    적립금 지급 기준이 P: 구매확정 후 일때 0/1/3/7/14/20을 입력할 수 있습니다.

    name

    적립금 명칭

    format

    적립금 표시 방식

    round_unit

    적립금 절사 단위

    화폐단위가 "KRW" "JPY" "TWD" "VND"일때 "적립금 절사 단위"를 F/1/10/100/1000을 입력할 수 있습니다.
    화폐단위가 "KRW" "JPY" "TWD" "VND"가 아닐때 "적립금 절사 단위"를 F/0.01/0.1/1/10을 입력할 수 있습니다.

    round_type

    적립금 절사 방식

    A : 내림
    B : 반올림
    C : 올림

    display_type

    적립금 항목 노출 설정

    P : 정율
    W : 정액
    WP : 정액/정율
    PW : 정율/정액

    unusable_points_change_type

    미가용 적립금 변환 기준 설정

    M: 최초 상품 배송완료일/구매확정일 기준으로 적립
    T: 마지막 상품 배송완료일/구매확정일 기준으로 적립

    Update points settings
    Request Copy
    Response Copy

    Products setting

    상품의 설정(Products setting)은 상품의 판매가 등의 설정값에 대한 기능입니다.

    Products setting properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    calculate_price_based_on

    판매가 계산 기준

    S : 공급가 대비 마진율
    A : 판매가 대비 마진율
    P : 기본몰 판매가
    B : 상품가

    price_rounding_unit

    판매가 계산 절사 단위

    F : 절사안함
    -2 : 0.01단위
    -1 : 0.1단위
    0 : 1단위
    1 : 10단위
    2 : 100단위
    3 : 1000단위

    price_rounding_rule

    판매가 계산 절사 방법

    L : 내림
    U : 반올림
    C : 올림

    Retrieve product settings

    GET

    상품의 판매가에 대한 설정값을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve product settings
    Request Copy
    Response Copy

    Redirects

    특정 URL로 접속 했을때, 설정한 URL로 리다이렉트할 수 있는 리소스입니다.

    Redirects properties

    Attribute Description
    shop_no

    최소값: [1]
    최대값: [2147483647]

    멀티쇼핑몰 번호

    id

    최대값: [2147483647]

    리다이렉트 아이디

    path

    리다이렉트 경로

    target

    대상 위치

    Retrieve a list of redirects

    GET

    등록된 Redirect URL을 조회할 수 있습니다.

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

    기본스펙

    Property Description
    SCOPE 상점 읽기권한 (mall.read_store)
    호출건수 제한 10

    요청사양

    Parameter Description
    shop_no

    최소값: [1]
    최대값: [2147483647]

    멀티쇼핑몰 번호

    DEFAULT 1

    id

    최소값: [1]
    최대값: [2147483647]

    리다이렉트 아이디

    path

    리다이렉트 경로

    target

    대상 위치

    Retrieve a list of redirects
    Request Copy
    Response Copy

    Create a redirect

    POST

    Redirect URL을 등록할 수 있습니다.
    샵별 최대 1000개 등록이 가능합니다.

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

    기본스펙

    Property Description
    SCOPE 상점 쓰기권한 (mall.write_store)
    호출건수 제한 10
    1회당 요청건수 제한 1

    요청사양

    Parameter Description
    shop_no

    최소값: [1]
    최대값: [2147483647]

    멀티쇼핑몰 번호

    DEFAULT 1

    path
    Required

    리다이렉트 경로

    target
    Required

    대상 위치

    Create a redirect
    Request Copy
    Response Copy

    Update a redirect

    PUT

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

    기본스펙

    Property Description
    SCOPE 상점 쓰기권한 (mall.write_store)
    호출건수 제한 10
    1회당 요청건수 제한 1

    요청사양

    Parameter Description
    shop_no

    최소값: [1]
    최대값: [2147483647]

    멀티쇼핑몰 번호

    DEFAULT 1

    id
    Required

    최소값: [1]
    최대값: [2147483647]

    리다이렉트 아이디

    path

    리다이렉트 경로

    target

    대상 위치

    Update a redirect
    Request Copy
    Response Copy

    Delete a redirect

    DELETE

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

    기본스펙

    Property Description
    SCOPE 상점 쓰기권한 (mall.write_store)
    호출건수 제한 10

    요청사양

    Parameter Description
    shop_no

    최소값: [1]
    최대값: [2147483647]

    멀티쇼핑몰 번호

    DEFAULT 1

    id
    Required

    최소값: [1]
    최대값: [2147483647]

    리다이렉트 아이디

    Delete a redirect
    Request Copy
    Response Copy

    Seo setting

    SEO 설정(Seo setting)은 검색결과 상위에 쇼핑몰이 노출되고 방문자가 증가하도록 하는 검색엔진 최적화(SEO) 작업입니다.

    Seo setting properties

    Attribute Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    common_page_title

    공통페이지 title 태그

    common_page_meta_description

    공통페이지 description 태그

    favicon

    URL

    파비콘

    use_google_search_console

    구글 서치 콘솔 사용여부

    T : 사용함
    F : 사용안함

    google_search_console

    구글 서치 콘솔

    use_naver_search_advisor

    네이버 서치 어드바이저 사용여부

    T : 사용함
    F : 사용안함

    naver_search_advisor

    네이버 서치 어드바이저

    sns_share_image

    URL

    SNS 공유 이미지

    use_twitter_card

    트위터 카드 사용여부

    T : 사용함
    F : 사용안함

    robots_text

    검색로봇 접근 제어(PC)

    mobile_robots_text

    검색로봇 접근 제어(모바일)

    use_missing_page_redirect

    없는 페이지 연결 리다이렉션 여부(PC)

    T : 사용함
    F : 사용안함

    missing_page_redirect_url

    없는 페이지 연결 리다이렉션 연결 경로(PC)

    mobile_use_missing_page_redirect

    없는 페이지 연결 리다이렉션 여부(모바일)

    T : 사용함
    F : 사용안함

    mobile_missing_page_redirect_url

    없는 페이지 연결 리다이렉션 연결 경로(모바일)

    use_sitemap_auto_update

    사이트맵 사용여부

    T : 사용함
    F : 사용안함

    use_rss

    RSS 피드 사용여부

    T : 사용함
    F : 사용안함

    display_group

    메인분류 명

    header_tag

    Head HTML(PC)

    footer_tag

    Body HTML(PC)

    mobile_header_tag

    Head HTML(모바일)

    mobile_footer_tag

    Body HTML(모바일)

    Retrieve SEO settings

    GET

    쇼핑몰의 검색엔진 최적화(SEO) 설정을 조회합니다.
    메타 태그, 파비콘, 검색로봇 접근 제어 등을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve SEO settings
    Request Copy
    Response Copy

    Update store SEO settings

    PUT

    쇼핑몰의 검색엔진 최적화(SEO) 설정을 수정합니다.
    메타 태그, 파비콘, 검색로봇 접근 제어 등을 설정할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    common_page_title

    공통페이지 title 태그

    common_page_meta_description

    공통페이지 description 태그

    favicon

    URL

    파비콘

    use_google_search_console

    구글 서치 콘솔 사용여부

    T : 사용함
    F : 사용안함

    google_search_console

    구글 서치 콘솔

    use_naver_search_advisor

    네이버 서치 어드바이저 사용여부

    T : 사용함
    F : 사용안함

    naver_search_advisor

    네이버 서치 어드바이저

    sns_share_image

    URL

    SNS 공유 이미지

    use_twitter_card

    트위터 카드 사용여부

    T : 사용함
    F : 사용안함

    robots_text

    검색로봇 접근 제어(PC)

    mobile_robots_text

    검색로봇 접근 제어(모바일)

    use_missing_page_redirect

    없는 페이지 연결 리다이렉션 여부(PC)

    T : 사용함
    F : 사용안함

    missing_page_redirect_url

    없는 페이지 연결 리다이렉션 연결 경로(PC)

    mobile_use_missing_page_redirect

    없는 페이지 연결 리다이렉션 여부(모바일)

    T : 사용함
    F : 사용안함

    mobile_missing_page_redirect_url

    없는 페이지 연결 리다이렉션 연결 경로(모바일)

    use_sitemap_auto_update

    사이트맵 사용여부

    T : 사용함
    F : 사용안함

    use_rss

    RSS 피드 사용여부

    T : 사용함
    F : 사용안함

    display_group

    메인분류 명

    header_tag

    Head HTML(PC)

    footer_tag

    Body HTML(PC)

    mobile_header_tag

    Head HTML(모바일)

    mobile_footer_tag

    Body HTML(모바일)

    Update store SEO settings
    Request Copy
    Response Copy

    Shippingmanager

    배송 관리자(Shippingmanager)는 배송 관리자 활성화 정보 관련 기능입니다.
    배송 관리자의 사용 정보를 조회할 수 있습니다.

    Shippingmanager properties

    Attribute Description
    use

    배송 관리자 활성화 정보

    Retrieve activation information for Shipping Manager

    GET

    배송 관리자의 사용 정보를 조회할 수 있습니다.

    기본스펙

    Property Description
    SCOPE 상점 읽기권한 (mall.read_store)
    호출건수 제한 40
    Retrieve activation information for Shipping Manager
    Request Copy
    Response Copy

    Shops

    멀티쇼핑몰(Shops)은 한개의 몰아이디에서 두개 이상의 쇼핑몰을 운영하고 있는 경우 생성한 멀티 쇼핑몰의 정보입니다.
    멀티쇼핑몰은 최대 15개까지 생성이 가능하며, 각각 다른 언어와 화폐로 생성할 수 있어 다국어 쇼핑몰을 운영하기 용이합니다.

    Shops properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    default

    기본샵 여부

    기본샵 여부 구분

    T : 기본샵
    F : 기본샵 아님

    shop_name

    최대글자수 : [255자]

    쇼핑몰명

    해당 멀티쇼핑몰의 쇼핑몰 이름

    business_country_code

    사업자 거점 국가 코드

    business_country_code

    language_code

    언어 코드

    멀티쇼핑몰의 기본 언어 코드

    ko_KR : 국문
    en_US : 영문
    zh_CN : 중문(간체)
    zh_TW : 중문(번체)
    ja_JP : 일문
    vi_VN : 베트남어

    language_name

    최대글자수 : [20자]

    기본 언어명

    멀티쇼핑몰의 기본 언어명

    currency_code

    형식 : [A-Z]

    결제 화폐 코드

    멀티쇼핑몰의 결제 화폐 코드

    South Korean Won (KRW)
    United States Dollar (USD)
    Japanese Yen (JPY)
    Chinese Yuan (CNY)
    Taiwan Dollar (TWD)
    Euro (EUR)
    Brazilian Real (BRL)
    Vietnamese Dong (VND)

    currency_name

    결제 화폐명

    멀티쇼핑몰의 결제 화폐명

    reference_currency_code

    형식 : [A-Z]

    참조 화폐 코드

    멀티쇼핑몰의 참조 화폐 코드

    South Korean Won (KRW)
    United States Dollar (USD)
    Japanese Yen (JPY)
    Chinese Yuan (CNY)

    reference_currency_name

    참조 화폐명

    멀티쇼핑몰의 참조 화폐명

    pc_skin_no

    PC 쇼핑몰 대표 디자인 번호

    멀티쇼핑몰의 PC 쇼핑몰 대표 디자인 번호. 현재 쇼핑몰에서 사용하고 있는 디자인 번호를 나타낸다.

    mobile_skin_no

    모바일 쇼핑몰 대표 디자인 번호

    모바일 쇼핑몰 대표 디자인 번호. 현재 쇼핑몰에서 사용하고 있는 디자인 번호를 나타낸다.

    base_domain

    최대글자수 : [63자]

    기본제공 도메인

    기본제공하는 도메인

    primary_domain

    최대글자수 : [63자]

    대표도메인

    멀티쇼핑몰 대표 도메인

    slave_domain

    연결 도메인

    쇼핑몰에 연결된 도메인

    active

    활성화 여부

    멀티쇼핑몰 활성화 여부

    T : 활성화
    F : 비활성화

    timezone

    표준시간대(타임존)

    timezone_name

    표준시간대 정보

    date_format

    표준시간대 날짜 표시형식

    년/월/일 : YYYY-MM-DD
    월/일/년 : MM-DD-YYYY
    일/월/년 : DD-MM-YYYY

    time_format

    표준시간대 시간 표시형식

    시/분/초 표시 : hh:mm:ss
    시/분 표시 : hh:mm

    use_reference_currency

    참조화폐 사용여부

    Retrieve a list of shops

    GET

    쇼핑몰에 등록된 멀티쇼핑몰의 정보를 목록으로 조회할 수 있습니다.
    쇼핑몰명, 기본샵 여부, 기본 언어명 등을 조회할 수 있습니다.

    기본스펙

    Property Description
    SCOPE 상점 읽기권한 (mall.read_store)
    호출건수 제한 40
    Request Copy
    Response Copy

    Retrieve a shop

    GET

    쇼핑몰에 등록된 멀티쇼핑몰의 정보를 조회할 수 있습니다.
    쇼핑몰명, 언어, 결제 화폐정보 등을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no
    Required

    멀티쇼핑몰 번호

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

    DEFAULT 1

    Request Copy
    Response Copy

    Sms setting

    SMS 설정(Sms setting)은 쇼핑몰의 SMS 설정에 관한 기능입니다.
    SMS API를 사용하기 위해서는 먼저 쇼핑몰에서 SMS 발송 서비스를 사용하고 있는지 확인이 필요합니다.

    Sms setting properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    use_sms

    SMS 사용 여부

    T: 사용함
    F: 사용안함

    exclude_unsubscriber

    수신거부자 제외 발송 여부

    T : 제외
    F : 포함

    default_sender

    기본 발신번호

    unsubscribe_phone

    무료 수신거부 전화번호

    send_method

    SMS 발송방법

    S: 단문 분할발송
    L: 장문발송(3건 차감)

    Retrieve SMS settings

    GET

    쇼핑몰의 SMS 설정을 조회할 수 있습니다.
    **해당 API는 한국어 쇼핑몰에서만 사용 가능합니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    Request Copy
    Response Copy

    Socials apple

    애플아이디 로그인(Socials apple)은 쇼핑몰 이용 고객의 애플아이디 로그인에 관한 기능입니다.
    애플아이디 로그인 설정을 사용하기 위해서는 먼저 애플의 개발자 계정에서 Sign in with Apple 앱 설정을 완료하여야 합니다.

    Socials apple properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    use_apple_login

    애플 로그인 사용

    T : 사용함
    F : 사용안함

    client_id

    client id

    team_id

    Team ID

    key_id

    Key ID

    auth_key_file_name

    Auth Key 파일명

    use_certification

    애플 로그인 본인인증

    T : 사용함
    F : 사용안함

    Apple login sync details

    GET

    쇼핑몰 이용 고객의 애플 로그인 연동정보를 조회합니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Apple login sync details
    Request Copy
    Response Copy

    Apple login sync settings

    PUT

    쇼핑몰 이용 고객의 애플 로그인 연동정보를 수정합니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    use_apple_login

    애플 로그인 사용

    T : 사용함
    F : 사용안함

    client_id

    최대글자수 : [300자]

    Client ID

    애플 개발자 센터의 Service ID 생성 시 설정한 Identifier

    team_id

    최대글자수 : [300자]

    Team ID

    애플 개발자 센터의 App ID Prefix

    key_id

    최대글자수 : [300자]

    Key ID

    애플 개발자 센터의 Key ID

    auth_key_file_name

    최대글자수 : [30자]

    Auth Key 파일명

    App ID의 Key파일로 .p8파일만 가능

    auth_key_file_contents

    최대글자수 : [300자]

    Auth Key 파일 내용

    .p8파일을 텍스트 파일로 열어 줄바꿈 없이 값을 작성

    use_certification

    애플 로그인 본인인증

    T : 사용함
    F : 사용안함

    Apple login sync settings
    Request Copy
    Response Copy

    Socials kakaosync

    카카오싱크 SNS(Socials kakaosync)는 쇼핑몰의 카카오싱크에 대한 설정을 조회하거나 설정할 수 있는 기능입니다.

    Socials kakaosync properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    use_kakaosync

    카카오싱크 사용여부

    T : 사용함
    F : 사용안함

    rest_api_key

    REST API 키

    javascript_key

    JavaScript 키

    auto_login

    자동 로그인 사용

    카카오 웹브라우저로 쇼핑몰 이용시 카카오 아이디로 로그인 기능 사용 여부

    T : 사용함
    F : 사용안함

    thirdparty_agree

    제3자 제공 동의 여부

    T : 동의함
    F : 동의안함

    thirdparty_agree_date

    제3자 제공 동의 날짜

    use_signup_result_page

    쇼핑몰 가입 후 이동 페이지

    T : 가입 완료 페이지로 이동
    F : 가입 완료 페이지 없이 즉시 가입

    Kakao Sync details

    GET

    쇼핑몰의 카카오싱크에 대한 설정을 조회할 수 있습니다.
    카카오싱크 사용여부, 자동 로그인 사용여부 등을 조회할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Kakao Sync details
    Request Copy
    Response Copy

    Kakao Sync updates

    PUT

    카카오 웹브라우져에 대한 자동 로그인 기능의 사용여부를 수정할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    rest_api_key
    Required

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

    REST API 키

    javascript_key
    Required

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

    JavaScript 키

    auto_login

    자동 로그인 사용

    카카오 웹브라우저로 쇼핑몰 이용시 카카오 아이디로 로그인 기능 사용 여부

    T : 사용함
    F : 사용안함

    DEFAULT F

    use_signup_result_page

    쇼핑몰 가입 후 이동 페이지

    T : 가입 완료 페이지로 이동
    F : 가입 완료 페이지 없이 즉시 가입

    DEFAULT F

    Kakao Sync updates
    Request Copy
    Response Copy

    Socials naverlogin

    네이버 로그인 설정정보를 조회하고 설정정보를 변경하는 리소스입니다.

    Socials naverlogin properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    use_naverlogin

    네이버 로그인 사용여부

    client_id

    클라이언트 아이디

    client_secret

    클라이언트 시크릿 키

    GET

    쇼핑몰에 네이버 로그인 설정여부를 조회할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    Naver login details
    Request Copy
    Response Copy

    Update Naver login settings

    PUT

    쇼핑몰에 설정된 네이버 로그인 정보를 수정할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    use_naverlogin
    Required

    네이버 로그인 사용여부

    T:사용함
    F:사용안함

    client_id

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

    클라이언트 아이디

    client_secret

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

    클라이언트 시크릿 키

    Update Naver login settings
    Request Copy
    Response Copy

    Store



    상점(Store)은 쇼핑몰의 쇼핑몰명, 관리자 정보, 사업자 등록번호와 고객센터 전화번호 등 쇼핑몰의 기본적인 정보를 확인할 수 있는 기능입니다.

    Store properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    shop_name

    쇼핑몰명

    해당 상점의 쇼핑몰명([쇼핑몰 설정 > 기본 설정 > '쇼핑몰 정보 > 내 쇼핑몰 정보'])

    mall_id

    상점 아이디

    쇼핑몰 아이디. 대표운영자의 아이디이자, 쇼핑몰 기본 제공 도메인(mallid.cafe24.com)에 사용한다.

    base_domain

    기본제공 도메인

    쇼핑몰 생성시 자동으로 생성되는 기본제공 도메인 정보. 해당 도메인을 통해 쇼핑몰에 접근할 수 있다.

    primary_domain

    대표도메인

    쇼핑몰에 연결한 대표도메인. 대표도메인을 연결하였을 경우에만 노출된다.

    company_registration_no

    사업자등록번호

    사업장이 위치한 국가에서 발급한 쇼핑몰의 사업자 등록 번호.

    company_name

    상호명

    사업자 등록시 등록한 상호명 또는 법인명.

    president_name

    대표자명

    사업자 등록시 등록한 대표자명.

    company_condition

    업태

    사업자 등록시 등록한 업태.

    company_line

    종목

    사업자 등록시 등록한 종목.

    country

    사업장 국가

    사업장이 있는 국가명.

    country_code

    국가코드

    zipcode

    우편번호

    사업장의 우편번호

    address1

    기본 주소

    사업장 주소(시/군/도)

    address2

    상세 주소

    사업장 주소(상세 주소)

    phone

    전화번호

    fax

    팩스번호

    email

    이메일

    운영자가 자동메일을 수신할 경우 수신할 메일 주소

    notification_only_email

    발신전용 이메일

    고객과 운영자에게 자동메일 발송시 보내는 사람 메일주소

    mall_url

    쇼핑몰 주소

    mail_order_sales_registration

    통신 판매업 신고

    통신판매업 신고가 되었는지 신고 여부

    T : 신고함
    F : 신고안함

    mail_order_sales_registration_number

    통신판매신고 번호

    missing_report_reason_type

    통신판매업 미신고 사유

    통신판매업 신고를 하지 않았을 경우 해당 사유.

    missing_report_reason

    통신판매업 미신고 사유 상세 내용

    통신판매업 미신고 사유가 "기타"일 경우 상세 사유.

    about_us_contents

    회사소개

    쇼핑몰에 대한 간략한 소개 표시. 쇼핑몰의 회사 소개 화면에 표시된다.

    company_map_url

    회사약도

    쇼핑몰에 대한 간략한 약도 표시. 쇼핑몰의 회사 소개 화면에 표시된다.

    customer_service_phone

    고객센터 상담/주문 전화

    쇼핑몰 화면에 표시되는 고객센터 상담 전화

    customer_service_email

    고객센터 상담/주문 이메일

    쇼핑몰 화면에 표시되는 고객센터 상담 이메일 주소.

    customer_service_fax

    고객센터 팩스 번호

    쇼핑몰 화면에 표시되는 고객센터 팩스 번호.

    customer_service_sms

    고객센터 SMS 수신번호

    쇼핑몰 화면에 표시되는 고객센터 SMS 수신 번호.

    customer_service_hours

    고객센터 운영시간

    쇼핑몰 화면에 표시되는 고객센터 운영시간.

    privacy_officer_name

    개인정보보호 책임자명

    쇼핑몰 화면에 표시되는 개인정보보호 책임자 이름.

    privacy_officer_position

    개인정보보호 책임자 지위

    privacy_officer_department

    개인정보보호 책임자 부서

    privacy_officer_phone

    개인정보보호 책임자 연락처

    쇼핑몰 화면에 표시되는 개인정보보호 책임자의 전화번호.

    privacy_officer_email

    개인정보보호 책임자 이메일

    쇼핑몰 화면에 표시되는 개인정보보호 책임자의 이메일 주소.

    contact_us_mobile

    서비스 문의안내 모바일 표시여부

    서비스 문의 안내를 모바일에 노출시킬 것인지 여부.

    T : 표시함
    F : 표시안함

    contact_us_contents

    서비스 문의안내 내용

    상품상세 페이지에 노출시키는 서비스 문의 안내 내용.

    sales_product_categories

    판매 상품 카테고리

    회원가입 및 쇼핑몰 생성 직후 입력하는 판매 상품 카테고리의 정보를 조회할 수 있습니다.

    (2023년 4월 이후 가입한 몰에 한하여 조회할 수 있습니다.)

    Undecided : 아직 결정하지 못했어요.
    Apparel : 패션의류
    FashionAccessories : 패션잡화
    LuxuryGoods : 수입명품
    BrandApparel : 브랜드의류
    BrandAccessories : 브랜드잡화
    Food_Beverage : 식품
    Lifestyle_HealthCare : 생활/건강
    Furniture_HomeDecor : 가구/인테리어
    Beauty_PersonalCare : 화장품/미용
    Maternity_BabyProducts : 출산/육아
    Digital_HomeAppliances : 디지털/가전
    CarAccessories : 자동차
    Rentals : 렌탈 서비스
    Sports_Leisure : 스포츠/레저
    CD_DVD : 음반/DVD
    Books : 도서
    Travels_Services : 여가/생활편의
    Used_Refurbished_Exhibition : 중고/리퍼/전시
    Others : 기타/서비스

    Retrieve store details

    GET

    쇼핑몰의 정보를 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    Retrieve store details
    Request Copy
    Response Copy

    Store accounts



    상점 계좌(Store accounts)는 쇼핑몰의 무통장입금 정보에 대한 기능입니다.

    Store accounts properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    bank_account_id

    무통장 입금 은행 ID

    bank_name

    은행명

    bank_code

    최대글자수 : [50자]

    은행코드

    bank_code

    bank_account_no

    계좌번호

    bank_account_holder

    예금주

    use_account

    사용여부

    T : 사용함
    F : 사용안함

    Retrieve a list of store bank accounts

    GET

    상점의 무통장입금 계좌정보를 목록으로 조회할 수 있습니다.
    은행명, 은행코드, 계좌번호 등을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    Retrieve a list of store bank accounts
    Request Copy
    Response Copy

    Subscription shipments setting

    정기배송 설정(Subscription shipments setting)은 정기결제를 통해 이루어지는 정기배송에 대한 기능입니다.
    정기배송 설정을 통해 쇼핑몰의 정기배송 상품을 설정하거나 정기배송 상품을 조회할 수 있습니다.
    정기배송 기능을 사용하기 위해서는 먼저 정기배송 서비스가 신청되어 있어야 합니다.
    정기배송 서비스의 신청은 어드민에서 가능합니다.

    Subscription shipments setting properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    subscription_no

    정기배송 상품설정 번호

    subscription_shipments_name

    정기배송 상품설정 명

    product_binding_type

    정기배송 상품 설정

    A : 전체상품
    P : 개별상품
    C : 상품분류

    one_time_purchase

    1회구매 제공여부

    T : 제공함
    F : 제공안함

    product_list

    적용 상품

    category_list

    적용 분류

    use_discount

    정기배송 할인 사용여부

    T : 사용함
    F : 사용안함

    discount_value_unit

    할인 기준

    P : 할인율
    W : 할인 금액

    discount_values

    할인 값

    related_purchase_quantity

    구매수량 관계 여부

    T : 구매수량에 따라
    F : 구매수량에 관계없이

    subscription_shipments_cycle_type

    배송주기 제공여부

    T : 사용함
    F : 사용안함

    subscription_shipments_cycle

    배송주기

    1W : 1주
    2W : 2주
    3W : 3주
    4W : 4주
    1M : 1개월
    2M : 2개월
    3M : 3개월
    4M : 4개월
    5M : 5개월
    6M : 6개월
    1Y : 1년

    use_order_price_condition

    혜택제공금액기준 사용여부

    T : 사용함
    F : 사용안함

    order_price_greater_than

    혜택제공금액기준 제공 기준금액

    include_regional_shipping_rate

    지역별배송비 포함여부

    T : 포함
    F : 미포함

    shipments_start_date

    최소값: [1]
    최대값: [30]

    배송시작일 설정

    Retrieve a list of subscription products

    GET

    설정된 정기배송 상품에 대한 정보를 목록으로 조회할 수 있습니다.
    정기배송 상품설정 번호, 설정 명, 설정값 등을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    subscription_no

    정기배송 상품설정 번호

    Request Copy
    Response Copy

    Create a subscription payment rule

    POST

    정기배송 상품을 설정할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    subscription_shipments_name
    Required

    최대글자수 : [255자]

    정기배송 상품설정 명

    product_binding_type
    Required

    정기배송 상품 설정

    A : 전체상품
    P : 개별상품
    C : 상품분류

    one_time_purchase

    1회구매 제공여부

    T : 제공함
    F : 제공안함

    DEFAULT T

    product_list

    배열 최대사이즈: [10000]

    적용 상품

    category_list

    배열 최대사이즈: [1000]

    적용 분류

    use_discount
    Required

    정기배송 할인 사용여부

    T : 사용함
    F : 사용안함

    discount_value_unit

    할인 기준

    P : 할인율
    W : 할인 금액

    discount_values

    배열 최대사이즈: [40]

    할인 값

    discount_value_unit이 P일 경우 최대값 : 100
    discount_value_unit이 W일 경우 최대값 : 99999999999999

    related_purchase_quantity

    구매수량 관계 여부

    T : 구매수량에 따라
    F : 구매수량에 관계없이

    subscription_shipments_cycle_type
    Required

    배송주기 제공여부

    T : 사용함
    F : 사용안함

    subscription_shipments_cycle
    Required

    배송주기

    1W : 1주
    2W : 2주
    3W : 3주
    4W : 4주
    1M : 1개월
    2M : 2개월
    3M : 3개월
    4M : 4개월
    5M : 5개월
    6M : 6개월
    1Y : 1년

    use_order_price_condition
    Required

    혜택제공금액기준 사용여부

    T : 사용함
    F : 사용안함

    order_price_greater_than

    최대값: [99999999999999]

    혜택제공금액기준 제공 기준금액

    include_regional_shipping_rate

    지역별배송비 포함여부

    T : 포함
    F : 미포함

    shipments_start_date

    최소값: [1]
    최대값: [30]

    배송시작일 설정

    DEFAULT 3

    Create a subscription payment rule
    Request Copy
    Response Copy

    Update subscription products

    PUT

    설정된 정기배송 상품의 정기배송 설정을 수정할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    subscription_no
    Required

    정기배송 상품설정 번호

    subscription_shipments_name

    최대글자수 : [255자]

    정기배송 상품설정 명

    product_binding_type

    정기배송 상품 설정

    A : 전체상품
    P : 개별상품
    C : 상품분류

    one_time_purchase

    1회구매 제공여부

    T : 제공함
    F : 제공안함

    product_list

    배열 최대사이즈: [10000]

    적용 상품

    category_list

    배열 최대사이즈: [1000]

    적용 분류

    use_discount

    정기배송 할인 사용여부

    T : 사용함
    F : 사용안함

    discount_value_unit

    할인 기준

    P : 할인율
    W : 할인 금액

    discount_values

    배열 최대사이즈: [40]

    할인 값

    related_purchase_quantity

    구매수량 관계 여부

    T : 구매수량에 따라
    F : 구매수량에 관계없이

    subscription_shipments_cycle_type

    배송주기 제공여부

    T : 사용함
    F : 사용안함

    subscription_shipments_cycle

    배송주기

    1W : 1주
    2W : 2주
    3W : 3주
    4W : 4주
    1M : 1개월
    2M : 2개월
    3M : 3개월
    4M : 4개월
    5M : 5개월
    6M : 6개월
    1Y : 1년

    use_order_price_condition

    혜택제공금액기준 사용여부

    T : 사용함
    F : 사용안함

    order_price_greater_than

    최대값: [99999999999999]

    혜택제공금액기준 제공 기준금액

    include_regional_shipping_rate

    지역별배송비 포함여부

    T : 포함
    F : 미포함

    shipments_start_date

    최소값: [1]
    최대값: [30]

    배송시작일 설정

    Update subscription products
    Request Copy
    Response Copy

    Delete subscription products

    DELETE

    설정된 정기배송 상품의 정기배송 설정을 해제할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    subscription_no
    Required

    정기배송 상품설정 번호

    Delete subscription products
    Request Copy
    Response Copy

    Taxmanager

    세금 관리자(MSA)의 활성화 정보 관련 기능입니다.

    Taxmanager properties

    Attribute Description
    use

    세금 관리자 활성화 정보

    Retrieve activation information for Tax Manager

    GET

    세금 관리자의 사용 정보를 조회할 수 있습니다.

    기본스펙

    Property Description
    SCOPE 상점 읽기권한 (mall.read_store)
    호출건수 제한 40
    Retrieve activation information for Tax Manager
    Request Copy
    Response Copy

    Users

    운영자(Users)는 쇼핑몰의 대표관리자와 더불어 쇼핑몰을 운영할 수 있는 운영자와 관련된 기능입니다.
    부운영자는 대표관리자가 부여한 권한 내에서 쇼핑몰을 운영할 수 있습니다.
    쇼핑몰에 등록된 운영자를 목록으로 조회하거나 특정 운영자를 조회할 수 있습니다.

    Users properties

    Attribute Description
    user_id

    운영자 아이디

    운영자 혹은 부운영자의 아이디

    user_name

    운영자 명

    운영자 혹은 부운영자의 이름

    phone

    전화번호

    전화번호

    운영자 혹은 부운영자의 전화번호

    email

    이메일

    이메일

    운영자 혹은 부운영자의 이메일 주소

    ip_restriction_type

    IP 접근제한

    IP 접근제한의 사용여부

    A : 사용함
    F : 사용안함

    admin_type

    운영자 구분

    대표운영자인지 부운영자인지의 구분

    P : 대표운영자
    A : 부운영자

    last_login_date

    최근 접속일시

    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    nick_name

    운영자 별명

    운영자의 별명

    nick_name_icon_type

    별명 아이콘 타입

    별명 아이콘 등록. 직접 등록이나 샘플 등록이 가능함.

    D : 직접 아이콘 등록
    S : 샘플 아이콘 등록

    nick_name_icon_url

    별명 아이콘 URL

    board_exposure_setting

    게시판 노출 설정

    memo

    메모

    available

    사용여부

    T : 사용함
    F : 사용안함

    multishop_access_authority

    멀티쇼핑몰 접근 권한

    T : 허용함
    F : 허용안함

    menu_access_authority

    메뉴 접근 권한

    detail_authority_setting

    상세 권한 설정

    ip_access_restriction

    IP 접근 제한

    access_permission

    접속 허용 권한

    T : 접속 허용시간 설정과 상관없이 항상 관리자 페이지 접속을 허용함
    F : 사용안함

    Retrieve a list of admin users

    GET

    쇼핑몰에 등록된 운영자를 목록으로 조회할 수 있습니다.
    운영자 아이디, 운영자명, 이메일, 전화번호 등을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    search_type

    검색 타입

    member_Id : 회원 아이디
    name : 이름

    keyword

    검색어

    admin_type

    운영자 구분

    P : 대표운영자
    A : 부운영자

    Retrieve admin user details

    GET

    쇼핑몰에 등록된 특정 운영자를 조회할 수 있습니다.
    운영자 이름, 전화번호, 이메일 등을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    user_id

    운영자 아이디

    운영자 혹은 부운영자의 아이디

    Request Copy
    Response Copy

    Product

    Bundleproducts



    세트상품(Bunldeproducts)은 여러 개의 상품을 묶어서 판매하는 상품을 의미합니다.
    세트 상품은 상품을 각각 주문하는 것보다 더 싸게 구입할 수 있도록 추가 할인을 설정할 수 있습니다.
    세트상품 주문시에는 하나의 상품처럼 주문을 관리할 수 있습니다.
    세트상품 리소스에서는 세트상품만 조회하거나, 세트상품 등록/수정/삭제를 진행할 수 있습니다.

    Bundleproducts properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    product_no

    상품번호

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

    product_code

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

    상품코드

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

    bundle_product_components

    세트상품의 구성상품 정보

    custom_product_code

    최대글자수 : [40자]

    자체상품 코드

    사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.

    product_name

    최대글자수 : [250자]

    상품명

    상품의 이름. 상품명은 상품을 구분하는 가장 기초적인 정보이며 검색 정보가 된다. HTML을 사용하여 입력이 가능하다.

    eng_product_name

    최대글자수 : [250자]

    영문 상품명

    상품의 영문 이름. 해외 배송 등에 사용 가능함.

    supply_product_name

    최대글자수 : [250자]

    공급사 상품명

    공급사에서 등록한 상품의 이름. 공급사에서 상품의 구분을 위해 임의로 입력할 수 있으며 상품명에는 영향을 미치지 않는다.

    internal_product_name

    최대글자수 : [50자]

    상품명(관리용)

    model_name

    최대글자수 : [100자]

    모델명

    상품의 모델명.

    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

    상품 검색어

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

    price_content

    최대글자수 : [20자]

    판매가 대체문구

    상품의 가격 대신 표시되는 문구. 품절이나 상품이 일시적으로 판매 불가할 때 사용.

    buy_limit_by_product

    구매제한 개별 설정여부

    T : 사용함
    F : 사용안함

    buy_limit_type

    구매제한

    해당 상품을 구매할 수 있는 회원 정보 표시.

    N : 회원만 구매하며
    구매버튼 감추기
    M : 회원만 구매하며
    구매버튼 보이기
    F : 구매제한 안함
    O : 지정된 회원만 구매하며 구매버튼 감추기
    D : 지정된 회원만 구매하며 구매버튼 보이기

    buy_group_list

    구매가능 회원 등급

    buy_member_id_list

    구매가능 회원아이디

    repurchase_restriction

    재구매 제한

    T : 재구매 불가
    F : 제한안함

    single_purchase_restriction

    단독구매 제한

    T : 단독구매 불가
    F : 제한안함

    points_by_product

    적립금 개별설정 사용여부

    F : 기본설정 사용
    T : 개별설정

    points_setting_by_payment

    결제방식별 적립금 설정 여부

    B : 기본 적립금설정 사용
    C : 결제방식에 따른 적립

    points_amount

    적립금 설정 정보

    except_member_points

    회원등급 추가 적립 제외

    T : 회원등급 추가 적립 제외 설정함
    F : 회원등급 추가 적립 제외 설정안함

    adult_certification

    성인인증

    성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함.

    T : 사용함
    F : 사용안함

    detail_image

    상세이미지

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

    list_image

    목록이미지

    상품 분류 화면, 메인 화면, 상품 검색 화면에 표시되는 상품의 목록 이미지.

    tiny_image

    작은목록이미지

    최근 본 상품 영역에 표시되는 상품의 목록 이미지.

    small_image

    축소이미지

    상품 상세 화면 하단에 표시되는 상품 목록 이미지.

    use_naverpay

    네이버페이 사용여부

    T : 사용함
    F : 사용안함

    naverpay_type

    네이버페이 판매타입

    C : 네이버페이 + 쇼핑몰 동시판매 상품
    O : 네이버페이 전용상품

    icon_show_period

    아이콘 노출 기간

    상품에 설정한 아이콘이 노출되는 기간.

    icon

    배열 최대사이즈: [5]

    아이콘

    상품에 표시되는 아이콘. 상품 판매를 강조하기 위한 목적으로 사용이 가능함.

    hscode

    HS코드

    해외 배송시 관세 부과를 위해 사용하는 HS코드. 국제 배송시 통관을 위해 반드시 정확한 번호를 입력해야 함.

    ※ HS코드 : 세계무역기구(WTO) 및 세계관세기구(WCO)가 무역통계 및 관세분류의 목적상 수출입 상품을 숫자 코드로 분류화 한 것으로, 수입 시 세금부과와 수출품의 통제 및 통계를 위한 분류법

    product_weight

    상품 중량

    상품의 전체 중량(kg). 배송을 위해 상품 자체의 무게와 박스 무게, 포장무게를 모두 포함한 중량 기재가 필요하다.

    product_material

    상품소재

    상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)

    created_date

    생성일

    상품이 생성된 일시.

    updated_date

    수정일

    상품이 수정된 일시.

    english_product_material

    영문 상품 소재

    상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.

    cloth_fabric

    옷감

    상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음.

    woven : 직물(woven)
    knit : 편물(knit)

    list_icon

    추천 / 품절 / 신상품 아이콘 노출 여부

    추천, 품절, 신상품 아이콘을 목록에서 표시하는지 여부

    ※ 품절 아이콘

    ● 상품이 품절 상태임을 알려주는 아이콘
    ● 재고관리 및 품절 기능을 사용하는 상품에 대해 재고가 없을 경우 표시

    ※ 추천, 신상품 아이콘

    ● 상품분류나 메인화면의 추천상품, 신상품 영역에 진열된 상품인 경우, 설정에 따라 해당 아이콘을 표시함

    ※ 아이콘 노출 여부 설정위치 : [쇼핑몰 설정 > 상품 설정 > '상품 정책 설정 > 상품 관련 설정 > 상품 아이콘 설정']

    sold_out

    품절여부

    T : 품절
    F : 품절아님

    discountprice

    상품 할인판매가 리소스

    decorationimages

    꾸미기 이미지 리소스

    benefits

    혜택 리소스

    additionalimages

    배열 최대사이즈: [20]

    추가 이미지 리소스

    exposure_limit_type

    표시제한 범위

    A : 모두에게 표시
    M : 회원에게만 표시

    exposure_group_list

    표시대상 회원 등급

    bundle_product_sales

    세트할인 정보

    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을 사용하여 입력이 가능하다.

    country_hscode

    국가별 HS 코드

    해외 배송시 관세 부과를 위해 사용하는 HS코드. 국제 배송시 통관을 위해 반드시 정확한 번호를 입력해야 함.

    국가별로 HS 코드의 표준이 다르기 때문에 해당 국가에 맞는 코드 입력이 필요함.

    simple_description

    상품 간략 설명

    상품에 대한 간략한 정보. 상품 진열 화면에서 노출 가능한 설명. HTML을 사용하여 입력이 가능하다.
    [쇼핑몰 설정 > 상품 설정 > '상품 보기 설정 > 상품 정보 표시 설정']에서 노출되도록 설정 가능하다.

    shipping_calculation

    배송 계산 유형

    A : 자동 계산
    M : 수동 계산

    shipping_fee_by_product

    개별배송여부

    상품에 배송비를 개별적으로 부과할 것인지 공통 배송비를 부과할 것인지에 대한 설정.
    개별 배송비를 사용하지 않을 경우 공통 배송비를 사용함.
    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    T : 사용함
    F : 사용안함

    shipping_method

    배송방법

    (개별배송비를 사용할 경우) 배송 수단 및 방법
    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    01 : 택배
    02 : 빠른등기
    03 : 일반등기
    04 : 직접배송
    05 : 퀵배송
    06 : 기타
    07 : 화물배송
    08 : 매장직접수령
    09 : 배송필요 없음

    prepaid_shipping_fee

    배송비 선결제 설정

    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    C : 착불
    P : 선결제
    B : 선결제/착불

    shipping_period

    배송기간

    (개별배송비를 사용할 경우) 상품 배송시 평균적으로 소요되는 배송 기간.
    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    shipping_scope

    배송정보

    국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시.
    [쇼핑몰 설정 > 배송 설정 > '배송 정책 설정 > 배송비 설정 > 개별배송비 설정'] 에서 상품별 개별 배송료 설정이 사용안함인 경우 설정 불가.
    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    A : 국내배송
    C : 해외배송
    B : 국내/해외배송

    shipping_area

    최대글자수 : [255자]

    배송지역

    (개별배송비를 사용할 경우) 상품을 배송할 수 있는 지역.
    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    shipping_fee_type

    배송비 타입

    (개별배송비를 사용할 경우) 상품의 배송비 타입.
    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    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 : 배송비

    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    clearance_category_eng

    해외통관용 상품구분 영문명

    해외 통관시 통관용 상품 구분 정보로 사용하는 정보. 국문명 입력시 입력한 구분명이 자동으로 번역된 항목.

    번역된 영문명이 해외송장 상품명에 포함되어 전송됨.

    clearance_category_kor

    해외통관용 상품구분 국문명

    해외 통관시 통관용 상품 구분 정보로 사용하는 정보. 자동으로 영문으로 번역되어 해외송장 상품명 정보에 포함하여 전송.

    clearance_category_code

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

    해외통관코드

    additional_information

    추가항목

    [쇼핑몰 설정 > 상품 설정 > '상품 보기 설정 > 상품 정보 표시 설정']에서 추가한 추가항목.

    기본적인 상품 정보 외에 추가로 표시항 항목이 있을 때 추가하여 사용함.

    image_upload_type

    이미지 업로드 타입

    이미지 업로드시 이미지 업로드 타입.
    "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드
    "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드

    ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음

    A : 대표이미지등록
    B : 개별이미지등록
    C : 웹FTP 등록

    main

    메인진열

    상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.

    relational_product

    배열 최대사이즈: [200]

    관련상품

    해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.

    memos

    메모 리소스

    hits

    상품 조회수 리소스

    seo

    상품 Seo 리소스

    tags

    상품 태그 리소스

    Retrieve a list of bundles

    GET

    세트상품을 목록을 통해 조회할 수 있습니다.
    상품코드, 자체상품 코드, 상품명 등을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    discountprice
    embed

    상품 할인판매가 리소스

    decorationimages
    embed

    꾸미기 이미지 리소스

    benefits
    embed

    혜택 리소스

    additionalimages
    embed

    추가 이미지 리소스

    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no

    상품번호

    조회하고자 하는 상품의 번호

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

    display

    진열상태

    T : 진열함
    F : 진열안함

    selling

    판매상태

    T : 판매함
    F : 판매안함

    product_code

    상품코드

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

    product_tag

    상품 검색어

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

    custom_product_code

    자체상품 코드

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

    product_name

    상품명

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

    eng_product_name

    영문 상품명

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

    supply_product_name

    공급사 상품명

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

    internal_product_name

    상품명(관리용)

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

    model_name

    모델명

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

    price_min

    상품 판매가 검색 최소값

    price_max

    상품 판매가 검색 최대값

    created_start_date

    상품 등록일 검색 시작일

    created_end_date

    상품 등록일 검색 종료일

    updated_start_date

    상품 수정일 검색 시작일

    updated_end_date

    상품 수정일 검색 종료일

    category

    분류 번호

    category_unapplied

    미적용 분류 검색

    T: 미적용 분류 검색

    include_sub_category

    하위분류 포함 검색

    T: 포함

    product_weight

    상품 중량

    additional_information_key

    추가항목 검색조건 키

    additional_information_value

    추가항목 검색조건 값

    sort

    정렬 순서 값

    created_date : 등록일
    updated_date : 수정일
    product_name : 상품명

    order

    정렬 순서

    asc : 순차정렬
    desc : 역순 정렬

    offset

    최대값: [8000]

    조회결과 시작위치

    조회결과 시작위치

    DEFAULT 0

    limit

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

    조회결과 최대건수

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

    DEFAULT 10

    Retrieve a bundle

    GET

    특정 세트상품을 상세조회할 수 있습니다.
    세트할인 정보와 같은 상세 정보를 추가로 확인할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

    조회하고자 하는 상품의 번호

    discountprice
    embed

    상품 할인판매가 리소스

    decorationimages
    embed

    꾸미기 이미지 리소스

    benefits
    embed

    혜택 리소스

    memos
    embed

    메모 리소스

    hits
    embed

    상품 조회수 리소스

    seo
    embed

    상품 Seo 리소스

    tags
    embed

    상품 태그 리소스

    additionalimages
    embed

    추가 이미지 리소스

    Request Copy
    Response Copy

    Create a bundle

    POST

    세트상품을 생성할 수 있습니다.
    구성상품을 묶은 가격에 대해 추가로 세트상품 할인을 적용할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_name
    Required

    최대글자수 : [250자]

    상품명

    bundle_product_components
    Required

    세트상품의 구성상품 정보

    product_no
    Required
    세트상품의 구성상품 번호

    purchase_quantity
    Required
    세트상품 구매개수

    bundle_product_sales
    Required

    세트할인 정보

    discount_value
    Required
    세트상품 할인가

    discount_type
    Required
    세트상품 할인타입
    P : 퍼센트
    V : 정액

    discount_round_unit
    세트상품 할인 절사 단위
    F : 절사안함
    -2 : 0.01단위
    -1 : 0.1단위
    0 : 1단위
    1 : 10단위
    2 : 100단위
    3 : 1000단위

    discount_round_type
    세트상품 할인 절사 방식
    F : 내림
    R : 반올림
    C : 올림

    display

    진열상태

    T : 진열함
    F : 진열안함

    DEFAULT F

    add_category_no

    추가 분류 번호

    분류 번호를 사용하여 진열을 원하는 카테고리에 상품 등록

    category_no
    Required
    분류 번호

    recommend
    추천상품 분류 등록 여부
    T : 추천상품 등록
    F : 추천상품 등록안함
    DEFAULT F

    new
    신상품 분류 등록 여부
    T : 신상품 등록
    F : 신상품 등록안함
    DEFAULT F

    custom_product_code

    최대글자수 : [40자]

    자체상품 코드

    사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.

    eng_product_name

    최대글자수 : [250자]

    영문 상품명

    supply_product_name

    최대글자수 : [250자]

    공급사 상품명

    internal_product_name

    최대글자수 : [50자]

    상품명(관리용)

    model_name

    최대글자수 : [100자]

    모델명

    use_naverpay

    네이버페이 사용여부

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    T : 사용함
    F : 사용안함

    naverpay_type

    네이버페이 판매타입

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    C : 네이버페이 + 쇼핑몰 동시판매 상품
    O : 네이버페이 전용상품

    product_weight

    최소: [0]~최대: [999999.99]

    상품 중량

    description

    상품상세설명

    mobile_description

    모바일 상품 상세설명

    입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.

    summary_description

    최대글자수 : [255자]

    상품요약설명

    simple_description

    상품 간략 설명

    product_tag

    배열 최대사이즈: [50]

    상품 검색어

    payment_info

    상품결제안내

    shipping_info

    상품배송안내

    exchange_info

    교환/반품안내

    service_info

    서비스문의/안내

    icon

    배열 최대사이즈: [5]

    아이콘

    hscode

    최대글자수 : [20자]

    HS코드

    배송정보(shipping_scope)가 C(해외배송)일 경우 필수 입력
    shipping_calculation이 A(자동계산)일 경우 필수 입력 아님

    shipping_scope

    배송정보

    국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시.
    [쇼핑몰 설정 > 배송 설정 > '배송 정책 설정 > 배송비 설정 > 개별배송비 설정'] 에서 상품별 개별 배송료 설정이 사용안함인 경우 설정 불가.

    ※ 쇼핑몰이 EC Global 쇼핑몰일 경우 "C"를 필수로 입력해야한다.

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    A : 국내배송
    C : 해외배송
    B : 국내/해외배송

    DEFAULT A

    shipping_method

    배송방법

    01 : 택배
    02 : 빠른등기
    03 : 일반등기
    04 : 직접배송
    05 : 퀵배송
    06 : 기타
    07 : 화물배송
    08 : 매장직접수령
    09 : 배송필요 없음

    DEFAULT 01

    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 : 상품 수량에 비례하여 배송료 부과

    DEFAULT T

    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 : 배송비

    prepaid_shipping_fee

    배송비 선결제 설정

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    C : 착불
    P : 선결제
    B : 선결제/착불

    DEFAULT B

    clearance_category_code

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

    해외통관코드

    배송정보(shipping_scope)가 C(해외배송)일 경우 필수 입력
    shipping_calculation이 A(자동계산)일 경우 필수 입력 아님
    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 : 구매제한 안함
    O : 지정된 회원만 구매하며 구매버튼 감추기
    D : 지정된 회원만 구매하며 구매버튼 보이기

    DEFAULT F

    buy_group_list

    구매가능 회원 등급

    buy_member_id_list

    구매가능 회원아이디

    repurchase_restriction

    재구매 제한

    T : 재구매 불가
    F : 제한안함

    DEFAULT F

    single_purchase_restriction

    단독구매 제한

    T : 단독구매 불가
    F : 제한안함

    DEFAULT F

    points_by_product

    적립금 개별설정 사용여부

    F : 기본설정 사용
    T : 개별설정

    DEFAULT F

    points_setting_by_payment

    결제방식별 적립금 설정 여부

    B : 기본 적립금설정 사용
    C : 결제방식에 따른 적립

    points_amount

    적립금 설정 정보

    except_member_points

    회원등급 추가 적립 제외

    T : 회원등급 추가 적립 제외 설정함
    F : 회원등급 추가 적립 제외 설정안함

    DEFAULT F

    main

    메인진열

    상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.

    relational_product

    배열 최대사이즈: [200]

    관련상품

    해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.

    product_no
    Required
    상품번호

    interrelated
    Required
    관련상품 상호등록 여부
    T : 상호등록
    F : 일방등록

    product_material

    상품소재

    상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)

    english_product_material

    영문 상품 소재

    상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.

    cloth_fabric

    옷감

    상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음.

    woven : 직물(woven)
    knit : 편물(knit)

    additional_image

    추가이미지

    상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다.

    추가이미지는 최대 20개까지 등록 가능하다.

    adult_certification

    성인인증

    성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함.

    [쇼핑몰 설정 > 고객 설정 > '회원 정책 설정 > 회원 관련 설정 > 회원가입 및 본인인증 설정'] 에서 성인인증 사용 시 구매차단 설정이 사용함이어야 성인인증이 적용된다.

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    T : 사용함
    F : 사용안함

    DEFAULT F

    exposure_limit_type

    표시제한 범위

    A : 모두에게 표시
    M : 회원에게만 표시

    DEFAULT A

    exposure_group_list

    표시대상 회원 등급

    Request Copy
    Response Copy

    Update a bundle

    PUT

    특정 세트상품의 정보를 수정할 수 있습니다.
    상품명, 세트상품의 구성상품 정보, 세트할인 정보 등을 수정할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    product_name

    최대글자수 : [250자]

    상품명

    bundle_product_components

    세트상품의 구성상품 정보

    product_no
    Required
    세트상품의 구성상품 번호

    purchase_quantity
    Required
    세트상품 구매개수

    bundle_product_sales

    세트할인 정보

    discount_value
    Required
    세트상품 할인가

    discount_type
    Required
    세트상품 할인타입
    P : 퍼센트
    V : 정액

    discount_round_unit
    세트상품 할인 절사 단위
    F : 절사안함
    -2 : 0.01단위
    -1 : 0.1단위
    0 : 1단위
    1 : 10단위
    2 : 100단위
    3 : 1000단위

    discount_round_type
    세트상품 할인 절사 방식
    F : 내림
    R : 반올림
    C : 올림

    display

    진열상태

    상품을 쇼핑몰에 진열할지 여부 변경.

    T : 진열함
    F : 진열안함

    product_condition

    상품 상태

    N : 신상품
    B : 반품상품
    R : 재고상품
    U : 중고상품
    E : 전시상품
    F : 리퍼상품
    S : 스크래치 상품

    product_used_month

    최대값: [2147483647]

    중고상품 사용 개월

    상품 상태(product_condition)가 중고 상품일 경우 중고 상품의 사용 개월 수

    add_category_no

    추가 분류 번호

    상품분류 번호를 입력하여 해당 상품에 특정 상품분류를 추가 등록

    category_no
    Required
    분류 번호

    recommend
    추천상품 분류 등록 여부
    T : 추천상품 등록
    F : 추천상품 등록안함
    DEFAULT F

    new
    신상품 분류 등록 여부
    T : 신상품 등록
    F : 신상품 등록안함
    DEFAULT F

    delete_category_no

    삭제 분류 번호

    상품분류 번호를 입력하여 해당 상품에 특정 상품분류 삭제

    custom_product_code

    최대글자수 : [40자]

    자체상품 코드

    사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.

    eng_product_name

    최대글자수 : [250자]

    영문 상품명

    supply_product_name

    최대글자수 : [250자]

    공급사 상품명

    internal_product_name

    최대글자수 : [50자]

    상품명(관리용)

    model_name

    최대글자수 : [100자]

    모델명

    use_naverpay

    네이버페이 사용여부

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    T : 사용함
    F : 사용안함

    naverpay_type

    네이버페이 판매타입

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    C : 네이버페이 + 쇼핑몰 동시판매 상품
    O : 네이버페이 전용상품

    product_weight

    최소: [0]~최대: [999999.99]

    상품 중량

    description

    상품상세설명

    mobile_description

    모바일 상품 상세설명

    입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.

    summary_description

    최대글자수 : [255자]

    상품요약설명

    simple_description

    상품 간략 설명

    product_tag

    배열 최대사이즈: [50]

    상품 검색어

    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)가 C(해외배송)일 경우 필수 입력
    shipping_calculation이 A(자동계산)일 경우 필수 입력 아님

    shipping_scope

    배송정보

    국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. [쇼핑몰 설정 > 배송 설정 > '배송 정책 설정 > 배송비 설정 > 개별배송비 설정'] 에서 상품별 개별배송료 설정이 사용안함인 경우 설정 불가.

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    A : 국내배송
    C : 해외배송
    B : 국내/해외배송

    prepaid_shipping_fee

    배송비 선결제 설정

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    C : 착불
    P : 선결제
    B : 선결제/착불

    shipping_method

    배송방법

    01 : 택배
    02 : 빠른등기
    03 : 일반등기
    04 : 직접배송
    05 : 퀵배송
    06 : 기타
    07 : 화물배송
    08 : 매장직접수령
    09 : 배송필요 없음

    shipping_fee_by_product

    개별배송여부

    T : 개별배송
    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

    배송비 금액

    개별배송비를 사용할 경우 상품의 개별 배송비.

    shipping_fee_type이 R, N일 경우 배열 안에 shipping_fee를 정의하여 배송비를 설정할 수 있다.

    shipping_fee_type이 M, D, W, C일 경우 배열 안에 다음과 같이 정의하여 배송비 구간을 설정할 수 있다.
    shipping_rates_min : 배송비 구간 시작 기준
    shipping_rates_max : 배송비 구간 종료 기준
    shipping_fee : 배송비

    clearance_category_code

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

    해외통관코드

    배송정보(shipping_scope)가 C(해외배송)일 경우 필수 입력
    shipping_calculation이 A(자동계산)일 경우 필수 입력 아님
    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 : 구매제한 안함
    O : 지정된 회원만 구매하며 구매버튼 감추기
    D : 지정된 회원만 구매하며 구매버튼 보이기

    buy_group_list

    구매가능 회원 등급

    buy_member_id_list

    구매가능 회원아이디

    repurchase_restriction

    재구매 제한

    T : 재구매 불가
    F : 제한안함

    single_purchase_restriction

    단독구매 제한

    T : 단독구매 불가
    F : 제한안함

    points_by_product

    적립금 개별설정 사용여부

    F : 기본설정 사용
    T : 개별설정

    points_setting_by_payment

    결제방식별 적립금 설정 여부

    B : 기본 적립금설정 사용
    C : 결제방식에 따른 적립

    points_amount

    적립금 설정 정보

    except_member_points

    회원등급 추가 적립 제외

    T : 회원등급 추가 적립 제외 설정함
    F : 회원등급 추가 적립 제외 설정안함

    main

    메인진열

    상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.

    relational_product

    배열 최대사이즈: [200]

    관련상품

    해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.

    product_no
    상품번호

    interrelated
    Required
    관련상품 상호등록 여부
    T : 상호등록
    F : 일방등록

    product_material

    상품소재

    상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)

    english_product_material

    영문 상품 소재

    상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.

    cloth_fabric

    옷감

    상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음.

    woven : 직물(woven)
    knit : 편물(knit)

    additional_image

    추가이미지

    상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다.

    추가이미지는 최대 20개까지 등록 가능하다.

    adult_certification

    성인인증

    성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함.

    [쇼핑몰 설정 > 고객 설정 > '회원 정책 설정 > 회원 관련 설정 > 회원가입 및 본인인증 설정'] 에서 성인인증 사용 시 구매차단 설정이 사용함이어야 성인인증이 적용된다.

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    T : 사용함
    F : 사용안함

    exposure_limit_type

    표시제한 범위

    A : 모두에게 표시
    M : 회원에게만 표시

    exposure_group_list

    표시대상 회원 등급

    Delete a bundle

    DELETE

    특정 세트상품을 삭제할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Delete a bundle
    Request Copy
    Response Copy

    Categories products



    카테고리 상품(Categories products)은 카테고리의 상품의 표시 순서, 고정 여부, 진열 영역 등을 조회, 수정할 수 있는 관계형 리소스입니다.

    Categories products properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    product_no

    상품번호

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

    sequence_no

    표시 순서

    auto_sort

    자동 정렬 여부

    sold_out

    품절여부

    fixed_sort

    고정 여부

    not_for_sale

    판매안함 여부

    display_group

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

    상세 상품분류

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

    DEFAULT 1

    sequence

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

    진열 순서

    Retrieve a list of products by category

    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 : 신상품

    limit

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

    조회결과 최대건수

    DEFAULT 50000

    Retrieve a count of products by category

    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 : 신상품

    Retrieve a count of products by category
    Request Copy
    Response Copy

    Add products to a category

    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

    상품번호

    Request Copy
    Response Copy

    Update a product in product category

    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 : 진열순위 고정 사용안함

    Update a product in product category
    Request Copy
    Response Copy

    Delete a product by category

    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

    Delete a product by category
    Request Copy
    Response Copy

    Mains products



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

    Mains products properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    product_no

    상품번호

    product_name

    상품명

    fixed_sort

    고정 여부

    Retrieve a list of products in main category

    GET

    특정 메인분류에 배정된 상품을 목록으로 조회할 수 있습니다.
    상품번호, 상품명, 고정 여부 등을 조회할 수 있습니다.
    상품은 동시에 여러 메인분류에 배정될 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    display_group
    Required

    메인분류 번호

    Retrieve a count of products in main category

    GET

    특정 메인분류에 배정된 상품의 수를 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    display_group
    Required

    메인분류 번호

    Retrieve a count of products in main category
    Request Copy
    Response Copy

    Set main category products

    POST

    특정 메인분류에 상품을 배정할 수 있습니다.
    상품은 동시에 여러 카테고리에 배정될 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    display_group
    Required

    메인분류 번호

    product_no
    Required

    상품번호

    Request Copy
    Response Copy

    Update fixed sorting of products in main category

    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

    진열순위 고정 상품번호

    진열순위를 고정하고자 하는 상품번호를 지정

    Update fixed sorting of products in main category
    Request Copy
    Response Copy

    Delete a product in main category

    DELETE

    특정 메인분류에 배정된 상품을 삭제할 수 있습니다.
    해당 상품은 메인분류에서만 삭제될 뿐이고 실제로 상품 자체가 삭제되는것은 아닙니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    display_group
    Required

    메인분류 번호

    product_no
    Required

    상품번호

    Delete a product in main category
    Request Copy
    Response Copy

    Products



    상품(Products)은 쇼핑몰에서 거래되는 제품의 기본 단위입니다.
    컬러, 사이즈 같은 옵션이 있을 경우 각각의 옵션이 상품 하위의 품목으로 생성될 수 있습니다.
    상품은 상품명, 공급가, 판매가, 재고정보 등의 정보를 포함하고 있습니다.
    상품은 품목, 상품 메모, SEO 등 여러 하위 리소스들을 갖고 있습니다.

    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

    배열 최대사이즈: [50]

    상품 검색어

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

    margin_rate

    최소: [-999.99]~최대: [999.99]

    마진률

    상품의 원가에 더하여 판매가 계산을 위한 마진율. Api에서는 해당 값은 참고용으로만 사용된다.
    tax_calculation이 A(자동계산)일 경우 null로 반환됨.

    tax_calculation

    세금 계산 유형

    A : 자동 계산
    M : 수동 계산

    tax_type

    과세 구분

    해당 상품의 과세 정보.

    해당 상품의 부가세 포함 유형.
    과세상품 = 세금이 부과된 상품.
    면세상품 = 세금이 면제되는 상품. 가공되지 않은 농/수/축산물, 연탄, 도서류, 보험, 여성용품 등의 상품이 이에 해당하며, 과세사업자로 등록해야 함
    영세상품 = 부가세가 0%로 적용되는 수출용 외화 획득 상품

    tax_calculation이 A(자동계산)이면서, C(영세상품) 일 경우 'A(과세상품)'으로 반환.

    A : 과세상품
    B : 면세 상품
    C : 영세상품

    tax_rate

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

    과세율

    price_content

    최대글자수 : [20자]

    판매가 대체문구

    상품의 가격 대신 표시되는 문구. 품절이나 상품이 일시적으로 판매 불가할 때 사용.

    buy_limit_by_product

    구매제한 개별 설정여부

    T : 사용함
    F : 사용안함

    buy_limit_type

    구매제한

    해당 상품을 구매할 수 있는 회원 정보 표시.

    N : 회원만 구매하며
    구매버튼 감추기
    M : 회원만 구매하며
    구매버튼 보이기
    F : 구매제한 안함
    O : 지정된 회원만 구매하며 구매버튼 감추기
    D : 지정된 회원만 구매하며 구매버튼 보이기

    buy_group_list

    구매가능 회원 등급

    buy_member_id_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

    축소이미지

    상품 상세 화면 하단에 표시되는 상품 목록 이미지.

    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

    생성일

    상품이 생성된 일시.

    updated_date

    수정일

    상품이 수정된 일시.

    english_product_material

    영문 상품 소재

    상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.

    cloth_fabric

    옷감

    상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음.

    woven : 직물(woven)
    knit : 편물(knit)

    list_icon

    추천 / 품절 / 신상품 아이콘 노출 여부

    추천, 품절, 신상품 아이콘을 목록에서 표시하는지 여부

    ※ 품절 아이콘

    ● 상품이 품절 상태임을 알려주는 아이콘
    ● 재고관리 및 품절 기능을 사용하는 상품에 대해 재고가 없을 경우 표시

    ※ 추천, 신상품 아이콘

    ● 상품분류나 메인화면의 추천상품, 신상품 영역에 진열된 상품인 경우, 설정에 따라 해당 아이콘을 표시함

    ※ 아이콘 노출 여부 설정위치 : [쇼핑몰 설정 > 상품 설정 > '상품 정책 설정 > 상품 관련 설정 > 상품 아이콘 설정']

    approve_status

    승인요청 결과

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

    classification_code

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

    자체분류 코드

    자체분류를 등록하면 자동으로 생성되는 코드로 상품에 특정 자체분류를 지정할 때 사용.

    미입력시 기본자체분류(C000000A) 사용

    sold_out

    품절여부

    T : 품절
    F : 품절아님

    additional_price

    판매가 추가금액

    discountprice

    상품 할인판매가 리소스

    decorationimages

    꾸미기 이미지 리소스

    benefits

    혜택 리소스

    options

    상품 옵션 리소스


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

    variants

    품목 리소스


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

    clearance_category_eng

    해외통관용 상품구분 영문명

    해외 통관시 통관용 상품 구분 정보로 사용하는 정보. 국문명 입력시 입력한 구분명이 자동으로 번역된 항목.

    번역된 영문명이 해외송장 상품명에 포함되어 전송됨.

    clearance_category_kor

    해외통관용 상품구분 국문명

    해외 통관시 통관용 상품 구분 정보로 사용하는 정보. 자동으로 영문으로 번역되어 해외송장 상품명 정보에 포함하여 전송.

    clearance_category_code

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

    해외통관코드

    clearance_category_code

    additionalimages

    추가 이미지 리소스

    exposure_limit_type

    표시제한 범위

    A : 모두에게 표시
    M : 회원에게만 표시

    exposure_group_list

    표시대상 회원 등급

    set_product_type

    세트상품 타입

    C : 일반세트
    S : 분리세트

    use_kakaopay

    카카오페이 사용여부

    T : 사용함
    F : 사용안함

    shipping_fee_by_product

    개별배송여부

    상품에 배송비를 개별적으로 부과할 것인지 공통 배송비를 부과할 것인지에 대한 설정.
    개별 배송비를 사용하지 않을 경우 공통 배송비를 사용함.
    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    T : 사용함
    F : 사용안함

    shipping_fee_type

    배송비 타입

    (개별배송비를 사용할 경우) 상품의 배송비 타입.
    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    T : 배송비 무료
    R : 고정배송비 사용
    M : 구매 금액에 따른 부과
    D : 구매 금액별 차등 배송료 사용
    W : 상품 무게별 차등 배송료 사용
    C : 상품 수량별 차등 배송료 사용
    N : 상품 수량에 비례하여 배송료 부과

    main

    메인진열

    상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.

    channeldiscountprices

    상품 할인판매가 리소스

    market_sync

    마켓 연동 여부

    T : 사용함
    F : 사용안함

    memos

    메모 리소스


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

    hits

    상품 조회수 리소스


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

    seo

    상품 Seo 리소스


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

    category

    분류 번호

    해당 상품이 진열되어있는 상품 분류.

    project_no

    기획전 번호

    description

    상품상세설명

    상품에 보다 상세한 정보가 포함되어있는 설명. HTML을 사용하여 입력이 가능하다.

    mobile_description

    모바일 상품 상세설명

    입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.

    separated_mobile_description

    모바일 별도 등록

    T : 직접등록
    F : 상품 상세설명 동일

    translated_description

    상품상세설명 번역정보

    payment_info

    상품결제안내

    상품의 결제 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.

    shipping_info

    상품배송안내

    상품의 배송 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.

    exchange_info

    교환/반품안내

    상품의 교환/반품 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.

    service_info

    서비스문의/안내

    제품의 사후 고객 서비스 방법 대한 안내 문구. HTML을 사용하여 입력이 가능하다.

    product_tax_type_text

    부가세 표시 문구

    [쇼핑몰 설정 > 상품 설정 > '상품 보기 설정 > 상품 정보 표시 설정 > 추가설정 > 판매가 부가세 표시문구']에서 설정한 문구 표시
    tax_calculation이 A(자동계산)일 경우 null로 반환됨.

    country_hscode

    국가별 HS 코드

    해외 배송시 관세 부과를 위해 사용하는 HS코드. 국제 배송시 통관을 위해 반드시 정확한 번호를 입력해야 함.

    국가별로 HS 코드의 표준이 다르기 때문에 해당 국가에 맞는 코드 입력이 필요함.

    simple_description

    상품 간략 설명

    상품에 대한 간략한 정보. 상품 진열 화면에서 노출 가능한 설명. HTML을 사용하여 입력이 가능하다.
    [쇼핑몰 설정 > 상품 설정 > '상품 보기 설정 > 상품 정보 표시 설정']에서 노출되도록 설정 가능하다.

    tags

    상품 태그 리소스


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

    has_option

    옵션 사용여부

    해당 상품이 옵션을 갖고 있는지에 대한 여부. 옵션을 갖고 있는 상품은 사이즈나 색상과 같은 다양한 선택지를 제공한다.

    T : 옵션사용함
    F : 옵션 사용안함

    option_type

    옵션 구성방식

    옵션을 사용할 경우, 옵션의 유형 표시

    ● 조합 일체선택형 : 하나의 셀렉스박스(버튼 이나 라디오버튼)에 모든 옵션이 조합되어 표시됨
    ● 조합 분리선택형 : 옵션을 각각의 셀렉스박스(버튼 이나 라디오버튼)로 선택할 수 있으며 옵션명을 기준으로 옵션값을 조합할 수 있음
    ● 상품 연동형 : 옵션표시방식은 조합형과 유사하지만 필수옵션과 선택옵션을 선택할 수 있음. 옵션의 조합을 제한 없이 생성할 수 있음.
    ● 독립 선택형 : 독립적인 조건 여러개를 각각 선택할 수 있는 옵션으로 옵션 값이 조합되지 않고 각각의 품목으로 생성됨.

    C : 조합 일체선택형
    S : 조합 분리선택형
    E : 상품 연동형
    F : 독립 선택형

    shipping_calculation

    배송 계산 유형

    A : 자동 계산
    M : 수동 계산

    shipping_method

    배송방법

    (개별배송비를 사용할 경우) 배송 수단 및 방법
    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    01 : 택배
    02 : 빠른등기
    03 : 일반등기
    04 : 직접배송
    05 : 퀵배송
    06 : 기타
    07 : 화물배송
    08 : 매장직접수령
    09 : 배송필요 없음

    prepaid_shipping_fee

    배송비 선결제 설정

    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    C : 착불
    P : 선결제
    B : 선결제/착불

    shipping_period

    배송기간

    (개별배송비를 사용할 경우) 상품 배송시 평균적으로 소요되는 배송 기간.
    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    shipping_scope

    배송정보

    국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. [쇼핑몰 설정 > 배송 설정 > '배송 정책 설정 > 배송비 설정 > 개별배송비 설정'] 에서 상품별 개별배송료 설정이 사용안함인 경우 설정 불가.
    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    A : 국내배송
    C : 해외배송
    B : 국내/해외배송

    shipping_area

    최대글자수 : [255자]

    배송지역

    (개별배송비를 사용할 경우) 상품을 배송할 수 있는 지역.
    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    shipping_rates

    구간별 배송비

    개별배송비를 사용할 경우 상품의 개별 배송비.

    shipping_fee_type이 R, N일 경우 배열 안에 shipping_fee를 정의하여 배송비를 설정할 수 있다.

    shipping_fee_type이 M, D, W, C일 경우 배열 안에 다음과 같이 정의하여 배송비 구간을 설정할 수 있다.
    shipping_rates_min : 배송비 구간 시작 기준
    shipping_rates_max : 배송비 구간 종료 기준
    shipping_fee : 배송비

    shipping_calculation이 A(자동계산)일 경우 null로 반환.

    origin_place_code

    원산지 코드

    상품의 원산지 코드.

    additional_information

    추가항목

    [쇼핑몰 설정 > 상품 설정 > '상품 보기 설정 > 상품 정보 표시 설정']에서 추가한 추가항목.

    기본적인 상품 정보 외에 추가로 표시항 항목이 있을 때 추가하여 사용함.

    image_upload_type

    이미지 업로드 타입

    이미지 업로드시 이미지 업로드 타입.
    "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드
    "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드

    ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음

    A : 대표이미지등록
    B : 개별이미지등록
    C : 웹FTP 등록

    relational_product

    배열 최대사이즈: [200]

    관련상품

    해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.

    select_one_by_option

    옵션별로 한 개씩 선택 (독립형 옵션)

    독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함.

    T : 사용함
    F : 사용안함

    translated_additional_description

    상품 추가설명 번역정보

    additional_image

    배열 최대사이즈: [20]

    추가이미지

    상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다.

    특정 상품 상세 조회 API에서만 확인 가능하다.

    Retrieve a list of products

    GET

    쇼핑몰에 생성되어 있는 상품을 목록으로 조회할 수 있습니다.
    상품코드, 상품명, 판매가 등을 조회할 수 있습니다.
    상품이 5,000개가 넘을 경우에는 offset 으로는 조회할 수 없으므로 since_product_no 파라메터를 활용해주시면 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    channeldiscountprices
    embed

    상품 할인판매가 리소스

    discountprice
    embed

    상품 할인판매가 리소스

    decorationimages
    embed

    꾸미기 이미지 리소스

    benefits
    embed

    혜택 리소스

    options
    embed

    상품 옵션 리소스

    variants
    embed

    품목 리소스

    상품당 품목정보를 100개까지 조회할 수 있음.
    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    additionalimages
    embed

    추가 이미지 리소스

    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

    상품 등록일 검색 시작일

    상품 등록일이 해당 날짜 이후인 상품 검색.

    등록일 검색 종료일과 같이 사용해야함.

    검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.

    created_end_date

    상품 등록일 검색 종료일

    상품 등록일이 해당 날짜 이전인 상품 검색.

    등록일 검색 시작일과 같이 사용해야함.

    검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.

    updated_start_date

    상품 수정일 검색 시작일

    상품 수정일이 해당 날짜 이후인 상품 검색.

    수정일 검색 종료일과 같이 사용해야함.

    검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.

    updated_end_date

    상품 수정일 검색 종료일

    상품 수정일이 해당 날짜 이전인 상품 검색.

    수정일 검색 시작일과 같이 사용해야함.

    검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.

    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

    product_bundle

    세트상품 여부

    T : 사용함
    F : 사용안함

    option_type

    옵션 구성방식

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

    C : 조합 일체선택형
    S : 조합 분리선택형
    E : 상품 연동형
    F : 독립 선택형

    market_sync

    마켓 연동 여부

    T : 사용함
    F : 사용안함

    sort

    정렬 순서 값

    created_date : 등록일
    updated_date : 수정일
    product_name : 상품명

    order

    정렬 순서

    asc : 순차정렬
    desc : 역순 정렬

    offset

    최대값: [5000]

    조회결과 시작위치

    조회결과 시작위치

    DEFAULT 0

    limit

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

    조회결과 최대건수

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

    DEFAULT 10

    Retrieve a count of 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

    상품 등록일 검색 시작일

    상품 등록일이 해당 날짜 이후인 상품 검색.

    등록일 검색 종료일과 같이 사용해야함.

    검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.

    created_end_date

    상품 등록일 검색 종료일

    상품 등록일이 해당 날짜 이전인 상품 검색.

    등록일 검색 시작일과 같이 사용해야함.

    검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.

    updated_start_date

    상품 수정일 검색 시작일

    상품 수정일이 해당 날짜 이후인 상품 검색.

    수정일 검색 종료일과 같이 사용해야함.

    검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.

    updated_end_date

    상품 수정일 검색 종료일

    상품 수정일이 해당 날짜 이전인 상품 검색.

    수정일 검색 시작일과 같이 사용해야함.

    검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.

    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

    product_bundle

    세트상품 여부

    T : 사용함
    F : 사용안함

    option_type

    옵션 구성방식

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

    C : 조합 일체선택형
    S : 조합 분리선택형
    E : 상품 연동형
    F : 독립 선택형

    market_sync

    마켓 연동 여부

    T : 사용함
    F : 사용안함

    Retrieve a count of products
    Request Copy
    Response Copy

    Retrieve a product resource

    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

    상품 할인판매가 리소스

    decorationimages
    embed

    꾸미기 이미지 리소스

    benefits
    embed

    혜택 리소스

    additionalimages
    embed

    추가 이미지 리소스

    Request Copy
    Response Copy

    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
    추천상품 분류 등록 여부
    T : 추천상품 등록
    F : 추천상품 등록안함
    DEFAULT F

    new
    신상품 분류 등록 여부
    T : 신상품 등록
    F : 신상품 등록안함
    DEFAULT 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]

    상품가(세금 제외)

    상품설정조회 상품설정조회 Docs 바로가기 에서
    "판매가 계산 기준(calculate_price_based_on)"이 "B(상품가)"일 경우 "price" 대신 필수 입력 필요.

    price

    최소: [0]~최대: [2147483647]

    상품 판매가

    필수 입력

    단, 상품설정조회 상품설정조회 Docs 바로가기 에서
    "판매가 계산 기준(calculate_price_based_on)"이 "B(상품가)"일 경우 "price_excludig_tax"를 사용해야함.

    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

    상품 간략 설명

    translated_description

    상품상세설명 번역정보

    product_tag

    배열 최대사이즈: [50]

    상품 검색어

    payment_info

    상품결제안내

    shipping_info

    상품배송안내

    exchange_info

    교환/반품안내

    service_info

    서비스문의/안내

    icon

    배열 최대사이즈: [5]

    아이콘

    hscode

    최대글자수 : [20자]

    HS코드

    배송정보(shipping_scope)가 C(해외배송)일 경우 필수 입력
    shipping_calculation이 A(자동계산)일 경우 필수 입력 아님

    country_hscode

    배열 최대사이즈: [29]

    국가별 HS 코드

    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)가 C(해외배송)일 경우 필수 입력
    shipping_calculation이 A(자동계산)일 경우 필수 입력 아님
    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 : 구매제한 안함
    O : 지정된 회원만 구매하며 구매버튼 감추기
    D : 지정된 회원만 구매하며 구매버튼 보이기

    DEFAULT F

    buy_group_list

    구매가능 회원 등급

    buy_member_id_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을 입력

    DEFAULT 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

    원산지 번호

    원산지 번호를 Retrieve a list of origins 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 : 영세상품

    tax_rate

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

    과세율

    additional_image

    추가이미지

    상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다.

    추가이미지는 최대 20개까지 등록 가능하다.

    adult_certification

    성인인증

    성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함.

    [쇼핑몰 설정 > 고객 설정 > '회원 정책 설정 > 회원 관련 설정 > 회원가입 및 본인인증 설정'] 에서 성인인증 사용 시 구매차단 설정이 사용함이어야 성인인증이 적용된다.

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    T : 사용함
    F : 사용안함

    DEFAULT F

    exposure_limit_type

    표시제한 범위

    A : 모두에게 표시
    M : 회원에게만 표시

    DEFAULT A

    exposure_group_list

    표시대상 회원 등급

    use_kakaopay

    카카오페이 사용여부

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    T : 사용함
    F : 사용안함

    Request Copy
    Response Copy

    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
    추천상품 분류 등록 여부
    T : 추천상품 등록
    F : 추천상품 등록안함
    DEFAULT F

    new
    신상품 분류 등록 여부
    T : 신상품 등록
    F : 신상품 등록안함
    DEFAULT 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]

    상품 판매가

    tax_calculation이 A(자동계산)일 경우,
    상품설정조회(GET:/products/setting)의 "판매가 계산 기준(calculate_price_based_on)" 값과 상관없이
    price로만 입력해야 한다.

    retail_price

    최소: [0]~최대: [2147483647]

    상품 소비자가

    supply_price

    최소: [0]~최대: [2147483647]

    상품 공급가

    상품의 원가. 공급가에 마진율을 더하여 판매가를 계산할 수 있음. API에서는 공급가는 참조 목적으로만 사용한다.

    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

    모바일 상품 상세설명

    입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.

    translated_description

    상품상세설명 번역정보

    translated_additional_description

    상품 추가설명 번역정보

    summary_description

    최대글자수 : [255자]

    상품요약설명

    simple_description

    상품 간략 설명

    product_tag

    배열 최대사이즈: [50]

    상품 검색어

    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)가 C(해외배송)일 경우 필수 입력
    shipping_calculation이 A(자동계산)일 경우 필수 입력 아님

    country_hscode

    배열 최대사이즈: [29]

    국가별 HS 코드

    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)가 C(해외배송)일 경우 필수 입력
    shipping_calculation이 A(자동계산)일 경우 필수 입력 아님
    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 : 구매제한 안함
    O : 지정된 회원만 구매하며 구매버튼 감추기
    D : 지정된 회원만 구매하며 구매버튼 보이기

    buy_group_list

    구매가능 회원 등급

    buy_member_id_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_rate

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

    과세율

    additional_image

    추가이미지

    상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다.

    추가이미지는 최대 20개까지 등록 가능하다.

    adult_certification

    성인인증

    성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함.

    [쇼핑몰 설정 > 고객 설정 > '회원 정책 설정 > 회원 관련 설정 > 회원가입 및 본인인증 설정'] 에서 성인인증 사용 시 구매차단 설정이 사용함이어야 성인인증이 적용된다.

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    T : 사용함
    F : 사용안함

    exposure_limit_type

    표시제한 범위

    A : 모두에게 표시
    M : 회원에게만 표시

    exposure_group_list

    표시대상 회원 등급

    use_kakaopay

    카카오페이 사용여부

    EC 베트남, 필리핀 버전에서는 사용할 수 없음.

    T : 사용함
    F : 사용안함

    Delete a product

    DELETE

    쇼핑몰에 생성되어 있는 상품을 삭제할 수 있습니다.
    상품 삭제 시에는 상품 하위에 옵션(품목)도 함께 삭제됩니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Delete a product
    Request Copy
    Response Copy

    Products additionalimages



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

    Products additionalimages properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    additional_image

    추가이미지

    product_no

    상품번호

    Create an additional product image

    POST

    해당 상품의 추가 이미지를 등록할 수 있습니다.
    추가 이미지 업로드시 Base64로 인코드하여 업로드할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

    additional_image
    Required

    추가이미지

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

    Request Copy
    Response Copy

    Update an additional product image

    PUT

    해당 상품의 추가 이미지를 수정할 수 있습니다.
    추가 이미지 업로드시 Base64로 인코드하여 업로드할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

    additional_image
    Required

    추가이미지

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

    Request Copy
    Response Copy

    Delete an additional product image

    DELETE

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

    Delete an additional product image
    Request Copy
    Response Copy

    Products approve



    상품 승인(Products approve)은 공급사가 업로드한 상품을 검토 후 승인하는 기능입니다.
    해당 기능은 일부 쇼핑몰에만 적용된 상태로, 공급사 상품 승인 기능을 사용중인 몰에서만 사용할 수 있습니다.

    Products approve properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    status
    Required

    상태

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

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

    product_no
    Required

    상품번호

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

    Retrieve a product approval status

    GET

    해당 상품의 승인 상태를 확인할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Retrieve a product approval status
    Request Copy
    Response Copy

    Create a product approval request

    POST

    해당 상품에 대한 승인 신청을 할 수 있습니다.
    승인신청한 상품은 승인요청(신규상품) 상태로 승인 요청됩니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

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

    user_id
    Required

    공급사 운영자 아이디

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

    Create a product approval request
    Request Copy
    Response Copy

    Update a product approval status

    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 : 검수진행중 상태값

    Update a product approval status
    Request Copy
    Response Copy

    Products decorationimages



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

    Products decorationimages properties

    Attribute Description
    code

    꾸미기 이미지 코드

    path

    꾸미기 이미지 URL

    shop_no

    멀티쇼핑몰 번호

    use_show_date

    표시기간 사용 여부

    T : 사용함
    F : 사용안함

    show_start_date

    표시기간 시작 일자

    show_end_date

    표시기간 종료 일자

    image_list

    꾸미기 이미지 리스트

    수평위치(image_horizontal_position)
    L : 왼쪽
    C : 가운데
    R : 오른쪽

    수직위치(image_vertical_position)
    T : 상단
    C : 중단
    B : 하단

    Retrieve a list of decoration images

    GET

    쇼핑몰에 등록되어있는 꾸미기 이미지를 목록으로 조회합니다.

    기본스펙

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

    Retrieve a list of product decoration images

    GET

    특정 상품에 등록되어 있는 꾸미기 이미지를 목록으로 조회합니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Request Copy
    Response Copy

    Set decoration images for 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

    날짜

    표시기간 시작 일자

    show_end_date

    날짜

    표시기간 종료 일자

    image_list
    Required

    꾸미기 이미지 리스트

    수평위치(image_horizontal_position)
    L : 왼쪽
    C : 가운데
    R : 오른쪽

    수직위치(image_vertical_position)
    T : 상단
    C : 중단
    B : 하단

    code
    꾸미기 이미지 코드

    path
    꾸미기 이미지 경로

    image_horizontal_position
    꾸미기 이미지 수평값

    image_vertical_position
    꾸미기 이미지 수직값

    Request Copy
    Response Copy

    Update product decoration images

    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

    날짜

    표시기간 시작 일자

    show_end_date

    날짜

    표시기간 종료 일자

    image_list
    Required

    꾸미기 이미지 리스트

    수평위치(image_horizontal_position)
    L : 왼쪽
    C : 가운데
    R : 오른쪽

    수직위치(image_vertical_position)
    T : 상단
    C : 중단
    B : 하단

    code
    꾸미기 이미지 코드

    path
    꾸미기 이미지 경로

    image_horizontal_position
    꾸미기 이미지 수평값

    image_vertical_position
    꾸미기 이미지 수직값

    Remove a product decoration image

    DELETE

    상품에 등록된 꾸미기 이미지를 삭제합니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    code
    Required

    꾸미기 이미지 코드

    product_no
    Required

    상품번호

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

    Remove a product decoration image
    Request Copy
    Response Copy

    Products discountprice



    상품 할인가(Discountprice)는 상품의 할인가격을 표시하는 리소스입니다. 혜택(Benefits)이 적용된 상품의 경우 상품의 할인가를 조회할 수 있습니다.
    상품 할인가는 하위 리소스로서 상품(Products) 하위에서만 사용가능하며, 상품 목록 조회시 Embed 파라메터로 호출가능합니다.

    Products discountprice properties

    Attribute Description
    pc_discount_price

    PC 할인 판매가

    mobile_discount_price

    모바일 할인 판매가

    app_discount_price

    앱 할인 판매가

    Retrieve a product discounted price

    GET

    상품번호를 이용하여 해당 상품의 할인가를 조회합니다.
    PC 할인 판매가, 모바일 할인 판매가를 확인할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

    Retrieve a product discounted price
    Request Copy
    Response Copy

    Products hits



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

    Retrieve a count of product views

    GET

    상품번호를 이용하여 해당 상품의 조회수를 조회합니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Retrieve a count of product views
    Request Copy
    Response Copy

    Products icons



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

    Products icons properties

    Attribute Description
    code

    상품 아이콘 코드

    path

    아이콘 URL

    shop_no

    멀티쇼핑몰 번호

    use_show_date

    표시기간 사용 여부

    T : 사용함
    F : 사용안함

    show_start_date

    표시기간 시작 일자

    show_end_date

    표시기간 종료 일자

    image_list

    상품 아이콘 리스트

    Retrieve a list of icons

    GET

    상품에 등록된 모든 아이콘을 조회할 수 있습니다.
    현재 특정 상품에 어떤 아이콘들이 등록되어 있는지 확인할 수 있습니다.

    기본스펙

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

    Retrieve a list of product icons

    GET

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

    Request Copy
    Response Copy

    Set icons for a product

    POST

    상품 아이콘을 상품에 등록할 수 있습니다.
    아이콘을 상품에 등록하기 전에 우선 List all icons 를 통해 아이콘의 코드를 확인해주세요.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

    image_list
    Required

    배열 최대사이즈: [5]

    상품 아이콘 리스트

    code
    Required
    상품 아이콘 코드

    Request Copy
    Response Copy

    Update product icons

    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

    날짜

    표시기간 시작 일자

    show_end_date

    날짜

    표시기간 종료 일자

    image_list

    배열 최대사이즈: [5]

    상품 아이콘 리스트

    code
    Required
    상품 아이콘 코드

    Request Copy
    Response Copy

    Remove a product icon

    DELETE

    상품에 등록된 상품 아이콘을 삭제(등록해제) 할 수 있습니다.
    아이콘 자체는 삭제되지 않으며 상품에 등록된 상태만 해제됩니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

    code
    Required

    상품 아이콘 코드

    Remove a product icon
    Request Copy
    Response Copy

    Products images



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

    Products images properties

    Attribute Description
    path

    상세이미지

    shop_no

    멀티쇼핑몰 번호

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

    product_no

    상품번호

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

    detail_image

    상세이미지

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

    list_image

    목록이미지

    상품 분류 화면, 메인 화면, 상품 검색 화면에 표시되는 상품의 목록 이미지.

    tiny_image

    작은목록이미지

    상품 상세 화면 하단에 표시되는 상품 목록 이미지.

    small_image

    축소이미지

    최근 본 상품 영역에 표시되는 상품의 목록 이미지.

    Upload images

    POST

    이미지를 업로드할 수 있습니다.
    상품에 이미지를 등록하기 위해서는 이미지를 먼저 업로드해야 합니다.
    상품의 이미지는 Base64 코드 로 인코딩하여 업로드할 수 있습니다

    기본스펙

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

    요청사양

    Parameter Description
    image
    Required

    상세이미지

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

    Upload images
    Request Copy
    Response Copy

    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 : 개별이미지등록

    Upload product images
    Request Copy
    Response Copy

    Delete product images

    DELETE

    상품에 등록된 이미지를 삭제할 수 있습니다.
    상세이미지나 목록이미지 등의 구분 없이 상품에 등록된 모든 이미지가 삭제됩니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Delete product images
    Request Copy
    Response Copy

    Products memos



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

    Products memos properties

    Attribute Description
    memo_no

    메모 번호

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

    author_id

    최대글자수 : [20자]

    작성자 아이디

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

    created_date

    생성일

    메모를 작성한 시간.

    memo

    메모

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

    Retrieve a list of product memos

    GET

    특정 상품에 등록된 메모를 목록으로 조회할 수 있습니다.
    작성자 아이디, 생성일, 메모 내용 등을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    offset

    최대값: [8000]

    조회결과 시작위치

    DEFAULT 0

    limit

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

    조회결과 최대건수

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

    DEFAULT 10

    Request Copy
    Response Copy

    Retrieve a product memo

    GET

    특정 상품에 등록된 메모 1개를 조회할 수 있습니다.
    작성자 아이디, 생성일, 메모내용 등을 조회할 수 있습니다.
    메모를 조회하기 위해선 메모번호가 필요합니다. 메모번호는 List all products memos 를 통해 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    memo_no
    Required

    메모 번호

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

    Request Copy
    Response Copy

    Create a product memo

    POST

    특정 상품에 대한 메모를 등록할 수 있습니다.
    메모를 등록할 때에는 메모 작성자의 아이디를 입력해야 합니다.

    기본스펙

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

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    author_id
    Required

    최대글자수 : [20자]

    작성자 아이디

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

    memo
    Required

    메모

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

    Request Copy
    Response Copy

    Update a product memo

    PUT

    특정 상품에 등록된 메모를 수정할 수 있습니다.
    메모를 수정할 때에는 메모 작성자의 아이디와 메모번호를 입력해야 합니다.
    메모번호는 List all products memos 를 통해 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    memo_no
    Required

    메모 번호

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

    author_id
    Required

    최대글자수 : [20자]

    작성자 아이디

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

    memo
    Required

    메모

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

    Update a product memo
    Request Copy
    Response Copy

    Delete a product memo

    DELETE

    특정 상품에 등록된 메모를 삭제할 수 있습니다.
    메모를 삭제하기 위해선 메모번호가 필요합니다. 메모번호는 List all products memos 를 통해 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    memo_no
    Required

    메모 번호

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

    Delete a product memo
    Request Copy
    Response Copy

    Products options



    상품 옵션(Products options)은 상품이 다른 색상이나 사이즈를 갖고 있는 경우 이를 각각의 옵션으로 구현할 수 있도록 하는 기능입니다.
    옵션은 색상, 사이즈 같은 옵션명(option_name)과 색상 중 빨간색, 노란색과 같은 옵션값(option_value)으로 구성되어있습니다.
    상품에 옵션 등록시 옵션을 기반으로 품목(variants)이 생성됩니다.
    옵션은 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.
    옵션의 목록조회, 생성, 수정, 삭제가 가능합니다.

    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

    파일 첨부 옵션

    Retrieve a list of product options

    GET

    상품의 옵션을 목록으로 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Request Copy
    Response Copy

    Create product options

    POST

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

    기본스펙

    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

    option_text
    옵션값

    option_image_file
    옵션 버튼 이미지

    option_color
    컬러칩 색상

    option_display_type
    옵션 표시방식
    S : 셀렉트박스
    P : 미리보기
    B : 텍스트버튼
    R : 라디오버튼
    DEFAULT S

    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
    추가입력옵션 필수 여부
    T : 필수
    F : 선택
    DEFAULT T

    use_attached_file_option

    파일 첨부 옵션 사용여부

    T : 사용함
    F : 사용안함

    attached_file_option

    파일 첨부 옵션

    Request Copy
    Response Copy

    Update product options

    PUT

    상품의 옵션을 수정할 수 있습니다.
    옵션명과 옵션값, 추가입력 옵션과 파일첨부 옵션의 수정만 가능하며, 옵션 항목을 추가하거나 삭제할 수는 없습니다.
    또한 생성되어 있는 품목은 초기화하지 않습니다.
    옵션을 추가하거나 삭제하고 싶을 경우에는 옵션 삭제 API(Delete a products option)로 삭제하신 후, 다시 등록하시면 됩니다.

    기본스펙

    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
    옵션 표시방식
    S : 셀렉트박스
    P : 미리보기
    B : 텍스트버튼
    R : 라디오버튼
    DEFAULT S

    original_options

    수정되기전 옵션값

    option_name
    Required
    옵션명

    option_value Array

    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
    추가입력옵션 필수 여부
    T : 필수
    F : 선택
    DEFAULT T

    use_attached_file_option

    파일 첨부 옵션 사용여부

    T : 사용함
    F : 사용안함

    attached_file_option

    파일 첨부 옵션

    Delete a product option

    DELETE

    상품의 옵션을 삭제할 수 있습니다.
    옵션을 삭제하면 옵션 기능이 '사용안함' 상태가 되기 때문에 기존에 생성되어 있던 품목도 함께 삭제되므로 주의가 필요합니다.

    기본스펙

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

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    Delete a product option
    Request Copy
    Response Copy

    Products seo



    상품 SEO(Products seo)는 특정 상품의 SEO 에 대한 설정과 설정값의 조회가 가능한 기능입니다.
    SEO는 검색엔진 최적화(Search Engine Optimization)의 약자로서 본 기능을 활용하여 검색엔진에 상품이나 쇼핑몰이 더 잘 검색될 수 있도록 할 수 있습니다.
    상품 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 : 사용안함

    Retrieve a product's SEO settings

    GET

    특정 상품의 SEO 설정을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Retrieve a product's SEO settings
    Request Copy
    Response Copy

    Update product SEO settings

    PUT

    특정 상품의 SEO 설정을 수정할 수 있습니다.
    브라우저 타이틀, 메타태그, 검색엔진 노출 설정 등을 수정할 수 있습니다.

    기본스펙

    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

    검색 엔진 노출 설정

    해당 상품을 검색엔진에 노출할 것인지 설정. '노출안함'으로 설정할 경우 해당 상품이 검색엔진에 노출되지 않는다.

    Request Copy
    Response Copy

    Products tags



    상품 태그(Products tags)는 상품이 특정 단어로 검색 되어야할 경우 추가할 수 있는 검색 키워드와 관련된 기능입니다.
    상품 태그는 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.
    상품명이나 상품 상세 설명 외에 다른 단어로도 상품이 검색되길 원할 경우 검색어를 상품에 추가할 수 있습니다.

    Products tags properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    tags
    Required

    상품 태그

    product_no

    상품번호

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

    tag

    상품 태그

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

    Retrieve a count of a product's product tags

    GET

    특정 상품에 등록된 상품 태그의 수를 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Retrieve a count of a product's product tags
    Request Copy
    Response Copy

    Retrieve a list of a product's product tags

    GET

    상품에 등록된 태그를 목록으로 조회할 수 있습니다.
    상품 태그, 상품번호 등을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Request Copy
    Response Copy

    Create product tags

    POST

    특정 상품에 검색 또는 분류를 위한 상품 태그를 등록할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    tags
    Required

    배열 최대사이즈: [50]

    상품 태그

    Request Copy
    Response Copy

    Delete a product tag

    DELETE

    특정 상품에 등록된 특정 태그를 삭제할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    tag

    상품 태그

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

    Delete a product tag
    Request Copy
    Response Copy

    Products variants



    상품의 품목(Products variants)은 쇼핑몰에서 판매되는 상품의 기본 단위입니다.
    쇼핑몰은 일반적으로 고객에게 다양한 선택권을 제공하기 위해 같은 상품이지만 사이즈가 다르거나, 혹은 색상이 다른 품목들을 판매합니다.
    품목의 조회, 등록, 수정 또는 삭제를 할 수 있습니다.

    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

    상품번호

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

    Retrieve a list of product variants

    GET

    상품의 품목을 목록으로 조회할 수 있습니다.
    상품 품목 코드, 진열상태, 판매상태 등을 조회할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    inventories
    embed

    재고 리소스

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

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

    Request Copy
    Response Copy

    Retrieve a product 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 파라메터를 사용하여 조회할 수 있다.

    Request Copy
    Response Copy

    Update a product 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

    안전재고수량

    Request Copy
    Response Copy

    Update multiple product variants

    PUT

    상품의 여러 품목을 한번에 수정할 수 있습니다.
    품목의 진열상태, 판매상태, 재고 사용여부 등을 변경할 수 있습니다.

    기본스펙

    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

    안전재고수량

    Delete a product variant

    DELETE

    상품의 특정 품목을 삭제할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    variant_code
    Required

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

    상품 품목 코드

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

    Delete a product variant
    Request Copy
    Response Copy

    Products variants inventories



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

    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

    안전재고수량

    origin_code

    출고지 코드

    Retrieve inventory details of a product 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자]

    품목코드

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

    Request Copy
    Response Copy

    Update a product variant 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

    안전재고수량

    origin_code

    출고지 코드

    Request Copy
    Response Copy

    Order

    Cancellation

    취소(Cancellation)는 특정 주문을 배송 전에 취소하는 기능입니다.
    판매자가 접수한 이후부터 생성되며 취소처리중의 단계를 거쳐 취소완료까지 진행됩니다.
    취소 리소스에서는 복수의 주문을 한번에 취소하거나 취소 상태를 수정하거나 조회할 수 있습니다.
    특정 주문을 취소할 때와 달리 PG 취소까지 진행되도록 취소할 수는 없습니다.

    Cancellation 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

    사유

    refund_methods

    환불 방식

    refund_reason

    비고

    order_price_amount

    상품구매금액

    refund_amounts

    환불금액

    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

    사용된 예치금 반환액

    undone

    철회 여부

    T : 철회함
    F : 철회안함

    undone_reason_type

    철회 사유 구분

    A:고객변심
    B:배송지연
    J:배송오류
    C:배송불가지역
    L:수출/통관 불가
    D:포장불량
    E:상품 불만족
    F:상품정보상이
    K:상품불량
    G:서비스불만족
    H:품절
    I:기타

    undone_reason

    철회 사유

    expose_order_detail

    주문상세내역 노출 여부

    T : 노출함
    F : 노출안함

    exposed_undone_reason

    주문상세내역 노출 철회 사유

    items

    품주코드

    include_tax

    가격에 세금 포함

    T: 세금포함
    F: 세금제외

    tax

    세금 정보

    세금 관리자 앱을 사용 안 할 경우 null로 반환

    status

    주문상태

    canceled : 취소완료
    canceling : 취소처리중

    recover_inventory

    재고복구

    T : 복구함
    F : 복구안함

    add_memo_too

    관리자 메모에도 추가

    T : 사용함
    F : 사용안함

    Retrieve an order cancellation

    GET

    취소 완료되었거나 취소처리 진행중인 내역을 조회할 수 있습니다.
    환불 방식, 환불금액, 철회 사유 구분 등을 확인할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    claim_code
    Required

    취소번호

    Request Copy
    Response Copy

    Create multiple order cancellations

    POST

    배송 전의 여러 주문을 취소할 수 있습니다.
    해당 API를 사용하여 취소할 경우 환불완료 처리까지는 되지만 PG 취소까지는 진행되지 않으며 별도 PG 취소처리를 해주어야 합니다.
    부분취소할 경우 각 환불 금액은 자동 계산되어 환불처리 됩니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    order_id
    Required

    주문번호

    status
    Required

    주문상태

    canceled : 취소완료
    canceling : 취소처리중

    recover_inventory

    재고복구

    T : 복구함
    F : 복구안함

    DEFAULT F

    recover_coupon

    쿠폰 복원

    오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가

    T : 복구함
    F : 복구안함

    DEFAULT F

    recover_coupon_no

    복원할 쿠폰 번호

    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 : 상품 정보 상이

    kakaopay_cancel_reason_type

    카카오페이 취소사유 구분

    오픈마켓/네이버페이 주문을 취소할 경우 사용 불가

    K1 : 변심에 의한 상품 취소
    K2 : 다른 옵션이나 상품을 잘못 주문함
    K3 : 배송지연
    K4 : 상품 파손 또는 불량
    K5 : 다른 상품 오배송 또는 구성품 누락
    K6 : 상품정보와 다름
    K7 : 품절로 인한 배송 불가

    refund_method_code

    환불 방식

    (오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가)

    T : 현금
    F : 신용카드
    M : 적립금
    G : 계좌이체
    C : 휴대폰
    D : 예치금
    Z : 후불
    O : 선불금
    V : 편의점
    J : 제휴상품권
    K : 제휴포인트
    I : 기타

    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

    환불 계좌번호

    환불수단(refund_method)이 "현금(T)"일 때만 사용 가능
    오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가

    refund_bank_account_holder

    최대글자수 : [15자]

    환불계좌 예금주 명의

    items

    품주코드

    order_item_code
    Required
    품주코드

    quantity
    Required
    수량

    Request Copy
    Response Copy

    Change cancellation details in bulk

    PUT

    주문의 취소 상태를 수정할 수 있습니다.
    취소가 접수된 주문의 주문 상태를 취소 접수 이전 상태로 철회할 수 있습니다.
    주문의 취소 상태를 수정하여 취소접수를 철회하고 재고를 복구하거나 철회사유를 입력할 수 있습니다.
    택배사에 이미 수거요청이 전달되었으나 수거가 필요하지 않게 될 경우, 택배사에 직접 연락하셔서 수거요청을 취소해주셔야 합니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    order_id
    Required

    주문번호

    claim_code
    Required

    취소번호

    recover_inventory
    Required

    재고복구

    T : 복구함
    F : 복구안함

    undone
    Required

    철회 여부

    T : 철회함

    add_memo_too
    Required

    관리자 메모에도 추가

    T : 사용함
    F : 사용안함

    undone_reason_type
    Required

    철회 사유 구분

    A:고객변심
    B:배송지연
    J:배송오류
    C:배송불가지역
    L:수출/통관 불가
    D:포장불량
    E:상품 불만족
    F:상품정보상이
    K:상품불량
    G:서비스불만족
    H:품절
    I:기타

    undone_reason

    최대글자수 : [2000자]

    철회 사유

    expose_order_detail
    Required

    주문상세내역 노출 여부

    T : 노출함
    F : 노출안함

    exposed_undone_reason

    최대글자수 : [2000자]

    주문상세내역 노출 철회 사유

    Request Copy
    Response Copy

    Cancellationrequests

    취소요청(Cancellationrequests)은 주문에 대한 취소요청에 관한 기능입니다.
    취소를 요청하거나 취소요청중인 주문을 접수거부 할 수 있습니다.

    Cancellationrequests properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    order_id

    주문번호

    items

    품주 목록

    undone

    접수거부 여부

    order_item_code

    품주코드

    Create a cancellation request for multiple items

    POST

    취소를 요청할 수 있습니다.
    취소사유와 계좌환불인 경우 환불할 계좌번호를 입력할 수 있습니다.
    ,(콤마)로 여러 건을 동시에 취소요청 할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    order_id
    Required

    주문번호

    reason_type
    Required

    취소사유 구분

    A:고객변심
    B:배송지연
    G:서비스불만족
    I:기타

    reason
    Required

    최대글자수 : [2000자]

    취소사유

    refund_bank_code

    환불 은행 코드

    환불 방식(refund_method)이 현금(T)일 경우 필수

    refund_bank_code

    해당 쇼핑몰이 EC Korea 쇼핑몰일 경우 필수
    환불수단(refund_method)이 "현금(T)"일 때만 사용 가능
    오픈마켓/네이버페이 주문을 취소할 경우 사용 불가

    refund_bank_name

    최대글자수 : [250자]

    환불은행명

    refund_bank_account_no

    환불 계좌번호

    refund_bank_account_holder

    최대글자수 : [15자]

    환불계좌 예금주 명의

    items

    품주 목록

    order_item_code
    Required
    품주코드

    quantity
    Required
    수량

    Create a cancellation request for multiple items
    Request Copy
    Response Copy

    Reject a cancellation request for multiple items

    PUT

    취소가 요청된 주문의 특정 품주들에 대하여 취소요청중인 상태를 변경할 수 있습니다.
    접수거부를 할 수 있고 사유를 입력할 수 있습니다.
    ,(콤마)로 여러 건을 동시에 취소요청 할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    order_id
    Required

    주문번호

    order_item_code
    Required

    품주코드

    undone
    Required

    접수거부 여부

    T : 접수거부함

    reason_type

    사유 구분

    A:고객변심
    B:배송지연
    J:배송오류
    C:배송불가지역
    L:수출/통관 불가
    D:포장불량
    E:상품 불만족
    F:상품정보상이
    K:상품불량
    G:서비스불만족
    H:품절
    I:기타

    reason

    최대글자수 : [2000자]

    사유

    display_reject_reason

    주문상세내역 노출설정

    T : 노출함
    F : 노출안함

    DEFAULT F

    reject_reason

    최대글자수 : [2000자]

    거부 사유

    Reject a cancellation request for multiple items
    Request Copy
    Response Copy

    Cashreceipt

    현금영수증(Cashreceipts)은 현금으로 구매 후 구매자가 발급 받을 수 있는 결제 증빙입니다.
    현금영수증 리소스를 통해 현금영수증을 발급하거나 수정할 수 있고, 현재까지 발급된 현금영수증을 조회할 수 있습니다.
    현금영수증은 대한민국에만 있는 제도로, 한국 쇼핑몰에서만 사용할 수 있습니다.

    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

    pg_name

    신청결제사

    cash_bill_no

    현금영수증 일련 번호

    type

    발행 타입

    개인: personal
    사업자: business

    company_registration_no

    사업자등록번호

    cellphone

    휴대전화

    tax_amount

    과세금액

    tax_free_amount

    면세금액

    supply_price

    공급가액

    Retrieve a list of cash receipts

    GET

    현재까지 발급된 현금영수증을 조회할 수 있습니다.
    해당 API는 한국어 쇼핑몰에서만 사용 가능합니다.

    기본스펙

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

    요청사양

    Parameter Description
    start_date
    Required

    날짜

    검색 시작일

    end_date
    Required

    날짜

    검색 종료일

    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]

    조회결과 시작위치

    DEFAULT 0

    Retrieve a list of cash receipts
    Request Copy
    Response Copy

    Create a cash receipt

    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자]

    휴대전화

    Create a cash receipt
    Request Copy
    Response Copy

    Update a cash receipt

    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자]

    휴대전화

    Update a cash receipt
    Request Copy
    Response Copy

    Cashreceipt cancellation

    현금영수증 취소(Cashreceipt cancellation)는 발행된 현금영수증에 대해 신청취소 혹은 발행취소를 할 수 있는 기능입니다.

    Cashreceipt cancellation properties

    Attribute Description
    cashreceipt_no

    현금영수증 번호

    order_id

    주문번호

    status

    처리상태

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

    Update a cash receipt cancellation

    PUT

    발행된 현금영수증에 대해 신청취소 혹은 발행취소를 할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    cashreceipt_no
    Required

    최소값: [1]

    현금영수증 번호

    order_id
    Required

    주문번호

    주문번호

    type
    Required

    취소 타입

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

    Update a cash receipt cancellation
    Request Copy
    Response Copy

    Collectrequests

    수거신청 정보(Collectrequests)는 반품, 교환처리로 수거요청시 수거신청 정보를 수정할 수 있는 리소스입니다.

    Collectrequests properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    request_no

    요청 번호

    order_id

    주문번호

    order_item_code

    품주코드

    shipping_company_name

    수거 배송사명

    collect_tracking_no

    수거 송장 번호

    Update a collection request

    PUT

    채번되는 송장번호를 이용하여 수거신청 정보를 수정합니다.
    요청번호와 수거 송장 번호를 필수로 입력합니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    request_no
    Required

    요청 번호

    collect_tracking_no
    Required

    최대글자수 : [40자]

    수거 송장 번호

    Update a collection request
    Request Copy
    Response Copy

    Draftorders

    가주문(Draftorders)은 주문 예약 처리를 할 수 있는 기능입니다.
    가주문을 통해 결제 전에 주문번호, 결제금액 등의 주문 정보를 미리 확인할 수 있습니다.

    Draftorders properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    order_id

    주문 번호

    payment_amount

    가주문 가격 정보

    order_from_mobile

    모바일 구분

    T : 모바일 주문
    F : 모바일 주문 아님

    DEFAULT F

    payment_method

    최대글자수 : [10자]

    결제수단 코드

    cash : 무통장
    card : 신용카드
    cell : 휴대폰
    tcash : 계좌이체
    icash : 가상계좌
    prepaid : 선불금
    credit : 예치금
    point : 적립금
    pointfy : 통합포인트
    cvs : 편의점
    cod : 후불
    coupon : 쿠폰
    market_discount : 마켓할인
    etc : 기타

    items

    주문상품목록

    Create a draft order

    POST

    주문 예약 처리를 합니다.
    주문 예약 처리를 통해 결제 전에 주문번호,결제금액 등의 주문 정보를 미리 확인할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    member_id

    최대글자수 : [20자]

    회원아이디

    order_from_mobile

    모바일 구분

    T : 모바일 주문
    F : PC 주문

    DEFAULT F

    payment_method

    최대글자수 : [10자]

    결제수단 코드

    cash : 무통장
    card : 신용카드
    icash : 가상계좌
    tcash : 계좌이체
    cell : 휴대폰
    deferpay : 후불결제
    point : 적립금

    order_place_id

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

    주문경로

    self : PC 쇼핑몰(카페24 주문만 사용가능)
    mobile : 모바일웹(카페24 주문만 사용가능)
    mobile_d : 모바일앱(카페24 주문만 사용가능)
    PAYPALSMARTBUTTON : 페이팔 스마트 버튼

    country_code

    국가코드

    payment_gateway_name

    최대글자수 : [20자]

    PG사 명

    receiver_name
    Required

    최대글자수 : [100자]

    수령자 명

    receiver_name_en

    최대글자수 : [100자]

    수령자명 (영문)

    receiver_name_furigana

    최대글자수 : [100자]

    수령자명 (발음)

    receiver_phone
    Required

    수령자 일반 전화

    receiver_cellphone
    Required

    수령자 휴대 전화

    receiver_zipcode

    글자수 최소: [2자]~최대: [14자]

    수령자 우편번호

    receiver_address1

    수령자 기본 주소

    receiver_address2

    수령자 상세 주소

    receiver_city

    수령자 도시

    receiver_state

    수령자 주/지방

    shipping_message

    배송 메세지

    buyer_name
    Required

    최대글자수 : [100자]

    주문자 이름

    buyer_email

    이메일

    주문자 이메일

    buyer_phone

    주문자 일반 전화

    buyer_cellphone

    주문자 휴대 전화

    buyer_zipcode
    Required

    글자수 최소: [2자]~최대: [14자]

    주문자 우편번호

    buyer_address1
    Required

    최대글자수 : [250자]

    주문자 기본 주소

    buyer_address2
    Required

    주문자 상세 주소

    no_shipping_required

    배송 주소 없음

    T: 배송 주소 없음
    F: 배송 주소 있음

    DEFAULT F

    buyer_ip

    IP

    주문자 ip

    transaction_id

    최대글자수 : [100자]

    카드 거래 아이디

    bank_code

    형식 : [a-z0-9_-]

    은행코드

    bank_account_no

    최대글자수 : [30자]

    계좌번호

    bank_account_owner_name

    최대글자수 : [100자]

    예금주

    shipping_type

    배송 유형

    A : 국내
    B : 해외

    send_order_message

    신규 주문 안내 메세지 발송 여부

    T : 발송함
    F : 발송안함

    DEFAULT F

    send_payment_guide_message

    입금 안내 메세지 발송 여부

    T : 발송함
    F : 발송안함

    DEFAULT F

    send_order_email

    신규 주문 안내 메일 발송 여부

    T : 발송함
    F : 발송안함

    DEFAULT F

    clearance_information_type

    통관정보 유형

    I : 신분증 ID
    P : 여권번호
    C : 개인통관고유부호

    clearance_information

    통관정보

    self_payment_cancel

    자체 결제 취소 여부

    T: 취소가능
    F: 취소불가

    DEFAULT F

    self_payment_cancel_url

    자체 결제 취소 URL

    items

    주문상품목록

    product_no
    Required
    상품번호

    product_code
    Required
    상품코드

    option_id
    Required
    상품옵션 아이디

    quantity
    Required
    주문 수량

    product_bundle
    세트상품 여부
    T : 사용함
    F : 사용안함

    prepaid_shipping_fee
    배송비 선결제 설정
    P : 선불
    C : 착불

    product_bundle_no
    세트상품번호

    Create a draft order
    Request Copy
    Response Copy

    Exchange

    교환(Exchange)은 주문의 교환 접수 상태를 변경하는 리소스입니다.
    교환 접수를 할 수 있으며 교환이 접수된 주문의 상태를 수정할 수 있습니다.

    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

    최대글자수 : [40자]

    반품 송장 번호

    return_shipping_company_name

    반품 배송업체명

    refund_methods

    환불 방식

    refund_reason

    비고

    order_price_amount

    상품구매금액

    refund_amounts

    환불금액

    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

    사용된 예치금 반환액

    undone

    철회 여부

    T : 철회함
    F : 철회안함

    undone_reason_type

    철회 사유 구분

    A:고객변심
    B:배송지연
    J:배송오류
    C:배송불가지역
    L:수출/통관 불가
    D:포장불량
    E:상품 불만족
    F:상품정보상이
    K:상품불량
    G:서비스불만족
    H:품절
    I:기타

    undone_reason

    철회 사유

    expose_order_detail

    주문상세내역 노출 여부

    T : 노출함
    F : 노출안함

    exposed_undone_reason

    주문상세내역 노출 철회 사유

    items

    품주코드

    exchanged_items

    교환상품

    include_tax

    가격에 세금 포함

    T: 세금포함
    F: 세금제외

    tax

    세금 정보

    세금 관리자 앱을 사용 안 할 경우 null로 반환

    carrier_id

    배송사 아이디

    return_invoice_success

    반송장 처리 성공 여부

    T : 성공
    F : 실패
    N : 미집하

    return_invoice_fail_reason

    최대글자수 : [100자]

    반송장 처리 실패 사유

    status

    주문상태

    accept : 접수
    collected : 수거완료
    exchanged : 교환완료

    recover_inventory

    재고복구

    T : 복구함
    F : 복구안함

    exchanged_after_collected

    수거완료시 교환완료 여부

    T : 사용함
    F : 사용안함

    add_memo_too

    관리자 메모에도 추가

    T : 사용함
    F : 사용안함

    pickup_completed

    수거완료 여부

    T : 수거완료
    F : 수거전

    Retrieve an exchange

    GET

    교환번호를 입력하여, 교환이 접수된 주문건을 조회합니다.
    주문번호, 반품번호, 사유, 교환처리 예정일 등을 확인할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    claim_code
    Required

    교환번호

    Request Copy
    Response Copy

    Create multiple exchanges

    POST

    교환이 신청된 주문의 상태를 교환접수 혹은 교환완료로 등록할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    order_id
    Required

    주문번호

    status
    Required

    주문상태

    accepted : 교환접수
    exchanged : 교환완료

    recover_inventory

    재고복구

    T : 복구함
    F : 복구안함

    DEFAULT F

    add_memo_too

    관리자 메모에도 추가

    T : 사용함
    F : 사용안함

    DEFAULT F

    items

    품주코드

    order_item_code
    Required
    품주코드

    quantity
    Required
    수량

    exchange_variant_code
    (동일상품 다른 옵션 교환시) 교환 상품 품목 코드

    same_product
    Required

    동일상품교환 여부

    T : 동일상품교환
    F : 다른상품교환

    Create multiple exchanges
    Request Copy
    Response Copy

    Update multiple order exchanges

    PUT

    교환이 접수된 주문의 상태를 수정 할 수 있습니다.
    다건의 주문에 대해 교환접수를 철회하거나, 재고를 복구하거나, 철회사유를 입력할 수 있습니다.
    택배사에 이미 수거요청이 전달되었으나 수거가 필요하지 않게 될 경우, 택배사에 직접 연락하셔서 수거요청을 취소해주셔야 합니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    order_id
    Required

    주문번호

    claim_code
    Required

    교환번호

    status

    주문상태

    exchanged : 교환완료

    pickup_completed

    수거완료 여부

    T : 수거완료
    F : 수거전

    recover_inventory

    재고복구

    T : 복구함
    F : 복구안함

    exchanged_after_collected

    수거완료시 교환완료 여부

    T : 사용함
    F : 사용안함

    items

    품주코드

    order_item_code
    품주코드

    undone

    철회 여부

    T : 철회함

    add_memo_too

    관리자 메모에도 추가

    T : 사용함
    F : 사용안함

    undone_reason_type

    철회 사유 구분

    A:고객변심
    B:배송지연
    J:배송오류
    C:배송불가지역
    L:수출/통관 불가
    D:포장불량
    E:상품 불만족
    F:상품정보상이
    K:상품불량
    G:서비스불만족
    H:품절
    I:기타

    undone_reason

    최대글자수 : [2000자]

    철회 사유

    expose_order_detail

    주문상세내역 노출 여부

    T : 노출함
    F : 노출안함

    exposed_undone_reason

    최대글자수 : [2000자]

    주문상세내역 노출 철회 사유

    return_invoice_no

    최대글자수 : [40자]

    반품 송장 번호

    carrier_id

    배송사 아이디

    return_invoice_success

    반송장 처리 성공 여부

    T : 성공
    F : 실패
    N : 미집하

    return_invoice_fail_reason

    최대글자수 : [100자]

    반송장 처리 실패 사유

    Request Copy
    Response Copy

    Exchangerequests

    교환요청(Exchangerequests)은 주문에 대해 교환을 요청할 수 있는 기능입니다.

    Exchangerequests properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    order_id

    주문번호

    items

    품주 목록

    exchange_request_no

    교환신청번호

    undone

    접수거부 여부

    order_item_code

    품주코드

    additional_payment_gateway_cancel

    추가 PG 취소

    Bulk exchange request API

    POST

    특정 주문에 대해 교환요청 처리를 할 수 있습니다.
    ,(콤마)로 여러 건을 동시에 교환요청 할 수 있습니다.
    교환사유와 수거신청 여부를 함께 등록할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    order_id
    Required

    주문번호

    reason_type
    Required

    사유 구분

    A:고객변심
    E:상품불만족
    K:상품불량
    J:배송오류
    I:기타

    reason
    Required

    최대글자수 : [2000자]

    교환신청 사유

    request_pickup

    수거신청 여부

    T : 수거신청
    F : 직접발송

    pickup

    수거지역 상세

    name
    Required
    이름

    phone
    전화번호

    cellphone
    Required
    휴대전화

    zipcode
    Required
    우편번호

    address1
    Required
    기본 주소

    address2
    Required
    상세 주소

    tracking_no

    최대글자수 : [40자]

    반품 송장 번호

    shipping_company_name

    최대글자수 : [30자]

    반품 배송업체명

    refund_bank_code

    환불 은행 코드

    refund_bank_name

    최대글자수 : [250자]

    환불은행명

    refund_bank_account_no

    환불 계좌번호

    refund_bank_account_holder

    최대글자수 : [15자]

    환불계좌 예금주 명의

    items

    품주 목록

    order_item_code
    Required
    품주코드

    quantity
    Required
    수량

    exchange_items

    교환상품정보

    product_no
    Required
    상품번호

    variant_code
    Required
    상품 품목 코드

    quantity
    Required
    수량

    Bulk exchange request API
    Request Copy
    Response Copy

    Reject an exchange request for multiple items

    PUT

    교환이 요청된 주문의 특정 품주들에 대하여 교환요청중인 상태를 변경할 수 있습니다.
    접수거부를 할 수 있고 사유를 입력할 수 있습니다.
    ,(콤마)로 여러 건의 교환요청 건에 대해 동시에 상태 변경 할 수 있습니다.

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    order_id
    Required

    주문번호

    order_item_code
    Required

    품주코드

    undone
    Required

    접수거부 여부

    T : 접수거부함

    reason_type

    사유 구분

    A:고객변심
    B:배송지연
    J:배송오류
    C:배송불가지역
    L:수출/통관 불가
    D:포장불량
    E:상품 불만족
    F:상품정보상이
    K:상품불량
    G:서비스불만족
    H:품절
    I:기타

    reason

    최대글자수 : [2000자]

    사유

    display_reject_reason

    주문상세내역 노출설정

    T : 노출함
    F : 노출안함

    DEFAULT F

    reject_reason

    최대글자수 : [2000자]

    거부 사유

    Reject an exchange request for multiple items
    Request Copy
    Response Copy

    Fulfillments

    배송앱에서 N개의 배송사와 연동하여 배송 정보를 등록하는 기능입니다.

    Fulfillments properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    tracking_no

    송장번호

    shipping_company_code

    배송업체 코드

    status

    주문상태

    standby : 배송대기
    shipping : 배송중

    order_id

    주문번호

    shipping_code

    배송번호

    order_item_code

    품주코드

    carrier_id

    배송사 아이디

    post_express_flag

    우체국 택배연동

    Create shipping information for multiple orders via Fulfillment

    POST

    배송앱에서 여러 주문에 대해 배송 정보를 등록할 수 있습니다.

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

    기본스펙

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

    요청사양

    Parameter Description
    shop_no

    최소값: [1]

    멀티쇼핑몰 번호

    DEFAULT 1

    tracking_no
    Required

    최대글자수 : [30자]

    송장번호

    shipping_company_code
    Required

    배송업체 코드

    status
    Required

    주문상태

    standby : 배송대기
    shipping : 배송중

    order_id

    주문번호

    shipping_code

    배송번호

    order_item_code

    품주코드

    carrier_id

    배송사 아이디

    post_express_flag

    우체국 택배연동

    S : 송장 전송 완료

    Create shipping information for multiple orders via Fulfillment