Coupang Developer Center

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

该API用于查看所有当前设置的合同列表，自由合同（NON_CONTRACT_BASED）和一般合同（CONTRACT_BASED）类型的合约都可以查看。

路径

GET

/v2/providers/fms/apis/api/v2/vendors/{vendorId}/contract/list

示例

https://api-gateway.coupang.com/v2/providers/fms/apis/api/v2/vendors/A00012345/contract/list

请求参数

Name

Required

Type

Description

vendorId

String

卖家ID

酷澎分配给卖家的固有代码

e.g. A00012345

请求体

无

返回消息

Name			Type	Description
code			Number	服务器响应代码
message			String	服务器响应信息
httpStatus			Number	HTTP状态代码 (与服务器响应代码的值相同)
httpStatusMessage			String	HTTP 状态信息 (与服务器响应信息的值相同)
errorMessage			String	除HTTP Status 200以外，剩下Status 中包含服务器详细失败原因信息
data			Array	合同列表数据
	success		Boolean	成功与否 True or false
	content		Array	合同列表
		contractId	Number	卖家合同ID e.g. 1, 2
		vendorContractId	Number	卖家合同代码 (用于酷澎管理) e.g. -1, 1, 2
		sellerId	String	卖家ID e.g. A00012345
		sellerShareRatio	Number	该合同中规定的卖家分摊比例(%) e.g. 100
		coupangShareRatio	Number	该合同中规定的酷澎分摊比例 e.g. 100
		gmvRatio	Number	单月销售额比率，单月预算基于酷澎的销售额自动生成 e.g. 100.0

	start	String	开始时间 e.g. 2018-01-22 00:00:00
	end	String	结束时间 e.g. 2018-12-31 23:59:59
	type	String	合同类型 e.g. CONTRACT_BASED, NON_CONTRACT_BASED
	usedBudget	Boolean	是否使用预算限制 e.g. true, false 目前不使用的字段，true为基本值
	modifiedAt	String	最终修改时间 e.g. 2017-09-25 11:40:01
	modifiedBy	String	最终修改人ID
Pagination		Array	分页
	countPerPage	Number	各页数据量 e.g. 10, 20, 30
	currentPage	Number	当前页面 e.g. 1
	totalPages	Number	总页面数 e.g. 1000
	totalElements	Number	总数据量 e.g. 1000

返回消息示例

{
  "code": 200,
  "message": "OK",
  "httpStatus": 200,
  "httpStatusMessage": "OK",
  "errorMessage": "",
  "data": {
    "success": true,
    "content": [
      {
        "contractId": 1,
        "vendorContractId": 2,
        "sellerId": "A00012345",
        "sellerShareRatio": 100,
        "coupangShareRatio": 0,
        "gmvRatio": 10,
        "start": "2017-03-01 00:00:00",
        "end": "2017-12-31 23:59:59",
        "type": "CONTRACT_BASED",
        "useBudget": true,
        "modifiedAt": "2017-09-21 10:57:07",
        "modifiedBy": "pronimance"
      },
      {
        "contractId": 15,
        "vendorContractId": -1,
        "sellerId": "A00013264",
        "sellerShareRatio": 100,
        "coupangShareRatio": 0,
        "gmvRatio": 0,
        "start": "2017-09-25 11:40:01",
        "end": "2999-12-31 23:59:59",
        "type": "NON_CONTRACT_BASED",
        "useBudget": true,
        "modifiedAt": "2017-09-25 11:40:01",
        "modifiedBy": "bcho"
      },
      {
        "contractId": 9962,
        "vendorContractId": 7,
        "sellerId": "A00012345",
        "sellerShareRatio": 100,
        "coupangShareRatio": 0,
        "gmvRatio": 100,
        "start": "2018-01-22 00:00:00",
        "end": "2018-12-31 23:59:59",
        "type": "CONTRACT_BASED",
        "useBudget": true,
        "modifiedAt": "2018-01-22 16:07:10",
        "modifiedBy": "allie"
      }
    ],
    "pagination": null
  }
}

错误信息

HTTP status code (error type)	Error message	Solution
401 (check requested parameter)	请确认卖家权限。	查看卖家ID（vendorid）值是否输入正确

(通用) 查看合同列表

简介

详细内容

路径

示例