商品 API 品类 API 品牌 API 运输 / 订单 API 退货 API 换货 API 促销 / 优惠券物流信息客服 / 咨询结算 CGF / CGF lite Rocket Growth

促销 / 优惠券

POST/v2/providers/marketplace_openapi/apis/api/v1/coupons2609170000

[可下载优惠券]创建

# 01

简介

[可下载优惠券]创建

# 02

详细内容

API支持的买家用户地区：韩国

创建顾客可以下载并使用的优惠券。

若想使用优惠券，商品的总订单金额必须满足卖家设置的金额，否则将无法使用。

优惠券可按固定比例/满减折扣的形式发行，同一张优惠券最多可包含 3 种形式。

（例：购买10,000韩元减1,000韩元；购买20,000韩元减3,000韩元；购买30,000韩元减3,000韩元等）

每个属性ID(vendorite)可以创建一张优惠券，创建后更新到前端至少需1小时。

（如果下午 3 点创建优惠券，则可将优惠券有效时间最早设置为当天下午 4 点。）

最初创建下载优惠券时设置的优惠券适用商品，之后无法更改。

如果要添加或删除使用优惠券的商品，则须停用之前发行的优惠券并创建新的优惠券。

最初创建优惠券时，请谨慎选择使用优惠券的商品！

路径

POST/v2/providers/marketplace_openapi/apis/api/v1/coupons

示例端点

https://api-gateway.coupang.com/v2/providers/marketplace_openapi/apis/api/v1/coupons

# 03

请求体参数

请求参数

请求体参数

Name

Type

Description

title*

string

优惠券名称

优惠券下载页面名称

contractId*

string

卖家合同ID

couponType*

string

优惠券分类

startDate*

string

优惠券开始时间

'YYYY-MM-DD HH:MM:SS'

endDate*

string

优惠券结束日期

'YYYY-MM-DD HH:MM:SS'

userId*

string

用户账户 (WING登录ID)

policies*

object[]

优惠券政策

description

policies[].description

string

优惠券详细政策

购物车中优惠券政策名称的补充说明

discount

policies[].discount

integer

优惠券折扣金额或比率 (%)

maximumDiscountPrice

policies[].maximumDiscountPrice

integer

最高折扣金额

typeOfDiscount 为RATE 时有效

为PRICE时，显示为-1

maximumPerDaily

policies[].maximumPerDaily

integer

最多发行数量 (1人/1天)

minimumPrice

policies[].minimumPrice

integer

使用优惠券的最低购买金额

为使用优惠券必须达到的订单金额

title

policies[].title

string

优惠券政策名称

该名称是在购物车中选择优惠券时显示的名称，与优惠券名称不同

typeOfDiscount

policies[].typeOfDiscount

string

优惠券政策类型

CODE	MEANING
RATE	固定比率
PRICE	满减折扣

managedCode

policies[].managedCode

string

内部管理编号

couponId

string

优惠券ID

创建优惠券商品/删除&查询优惠券时使用

vendorId

string

卖家编号

lastModifiedBy

string

优惠券创建(最终修改)账户

lastModifiedDate

string

优惠券创建(最终修改)时间

publishedDate

object

400 (确认请求参数)

string

请确认您输入的最多发行数量(maximumPerDaily)值是否正确。

请求示例application/json

{
  "title": "쿠폰 명칭",
  "contractId": "15",
  "couponType": "DOWNLOAD",
  "startDate": "2019-05-22 19:55:00",
  "endDate": "2019-06-08 11:00:00",
  "userId": "testaccout1",
  "policies": [
    {
      "title": "해당쿠폰의 정책 1 명칭",
      "typeOfDiscount": "PRICE",
      "description": "해당정책 안내 문구 작성",
      "minimumPrice": 10000,
      "discount": 1000,
      "maximumDiscountPrice": 1000,
      "maximumPerDaily": 1
    },
    {
      "title": "해당쿠폰의 정책 2 명칭",
      "typeOfDiscount": "PRICE",
      "description": "해당정책 안내 문구 작성",
      "minimumPrice": 20000,
      "discount": 2000,
      "maximumDiscountPrice": 1000,
      "maximumPerDaily": 1
    },
    {
      "title": "해당쿠폰의 정책 3 명칭",
      "typeOfDiscount": "PRICE",
      "description": "해당정책 안내 문구 작성",
      "minimumPrice": 30000,
      "discount": 3000,
      "maximumDiscountPrice": 1000,
      "maximumPerDaily": 1
    }
  ]
}

# 04

响应体

响应消息

Name

Type

Description

couponId

integer

优惠券ID

创建优惠券商品/删除&查询优惠券时使用

vendorId

string

卖家编号

couponType

string

优惠券分类

lastModifiedBy

string

优惠券创建(最终修改)账户

lastModifiedDate

string

优惠券创建(最终修改)时间

title

string

优惠券名称

优惠券下载页面名称

publishedDate

string

startDate

string

优惠券开始时间

'YYYY-MM-DD HH:MM:SS'

couponStatus

string

优惠券状态

创建时显示为“STANDBY”

policies

object

优惠券政策

description

policies.description

string

优惠券详细政策

购物车中优惠券政策名称的补充说明

discount

policies.discount

number

优惠券折扣金额或比率 (%)

maximumDiscountPrice

policies.maximumDiscountPrice

number

最高折扣金额

typeOfDiscount 为RATE 时有效

为PRICE时，显示为-1

maximumPerDaily

policies.maximumPerDaily

number

最多发行数量 (1人/1天)

minimumPrice

policies.minimumPrice

number

使用优惠券的最低购买金额

为使用优惠券必须达到的订单金额

title

policies.title

string

优惠券政策名称

该名称是在购物车中选择优惠券时显示的名称，与优惠券名称不同

typeOfDiscount

policies.typeOfDiscount

string

优惠券政策类型

CODE	MEANING
RATE	固定比率
PRICE	满减折扣

managedCode

policies.managedCode

string

内部管理编号

Response Example

{
  "couponId": 15354534,
  "vendorId": "A00013264",
  "couponType": "DOWNLOAD",
  "lastModifiedBy": "testaccout1",
  "lastModifiedDate": "2019-05-22 15:40:59",
  "title": "쿠폰 명칭",
  "publishedDate": null,
  "startDate": "2019-05-22 19:55:00",
  "couponStatus": "STANDBY",
  "couponPolicies": [
    {
      "description": "해당정책 안내 문구 작성",
      "discount": 1000,
      "maximumDiscountPrice": -1,
      "maximumPerDaily": 1,
      "minimumPrice": 10000,
      "title": "해당쿠폰의 정책 1 명칭",
      "typeOfDiscount": "PRICE",
      "manageCode": "FMS_15_A00013264_15585072594380"
    },
    {
      "description": "해당정책 안내 문구 작성",
      "discount": 2000,
      "maximumDiscountPrice": -1,
      "maximumPerDaily": 1,
      "minimumPrice": 20000,
      "title": "해당쿠폰의 정책 2 명칭",
      "typeOfDiscount": "PRICE",
      "manageCode": "FMS_15_A00013264_15585072594381"
    },
    {
      "description": "해당정책 안내 문구 작성",
      "discount": 3000,
      "maximumDiscountPrice": -1,
      "maximumPerDaily": 1,
      "minimumPrice": 30000,
      "title": "해당쿠폰의 정책 3 명칭",
      "typeOfDiscount": "PRICE",
      "manageCode": "FMS_15_A00013264_15585072594382"
    }
  ]
}

# 05

错误码

HTTP	代码	消息
400	HTTP_400	Bad Request

错误说明

HTTP	类型	错误消息	解决方案
400	400 (确认请求参数)	contractId=15* 的合同不属于 Seller=A00012345 。	请确认您输入的合同ID(contractId)值是否正确。
400	400 (确认请求参数)	请确认startAt模式。yyyy-MM-dd HH:mm:ss, 请确认促销时间段。	请确认您输入的优惠券开始日期(startDate)值是否正确。
400	400 (确认请求参数)	请确认endAt模式。yyyy-MM-dd HH:mm:ss, 请确认促销时间段。	请确认您输入的优惠券结束日期(endDate)值是否正确。
400	400 (确认请求参数)	createCouponRequest.title栏为空白。 createCouponRequest.title 为必填项。	请确认是否输入了优惠券名称(title)。
400	400 (确认请求参数)	请以10韩元为单位输入policies[0]的金额。	请确认您输入优惠券折扣金额(discount)是否是以10韩元为单位。
400	400 (确认请求参数)	policies[0].maxPerDaily须输入1～9999间的数值。	请确认您输入的最多发行数量(maximumPerDaily)值是否正确。