Path
GET
/v2/providers/openapi/apis/api/v1/revenue-history
Example Endpoint
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v1/revenue-history?vendorId=A00012345&recognitionDateFrom=2019-10-01&recognitionDateTo=2019-10-30&token=&maxPerPage=
Request Parameters
Query String Parameter
Name | Required | Type | Description | ||||
---|---|---|---|---|---|---|---|
vendorId | O | String |
Seller ID;
Unique code issued by Coupang to a seller
Example) A00012345
|
||||
recognitionDateFrom | O | String |
Start date of sales recognition;
Up to 31 days;
Format: YYYY-MM-dd
|
||||
recognitionDateTo | O | String |
End date of sales recognition;
Up to 31 days;
Format: YYYY-MM-dd
|
||||
token | O | String |
Token value for the next page query;
Token value to call the next page
(To look up the first page, enter 'token=' only) |
||||
maxPerPage | Number |
Maximum number to call per page
Default: 50; Minimum: 1; Maximum: 50
|
Request Example
Response Message
Name | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
code | Number |
Server response code
|
||||||||||
message | String |
detail info
|
||||||||||
data | Array |
Result list;
An empty list is returned when there is no result.
|
||||||||||
orderId | Number |
Order number
|
||||||||||
saleType | String |
Status type
|
||||||||||
saleDate | String |
Date of payment completion
Format: YYYY-MM-dd
|
||||||||||
recognitionDate | String |
Date of sales recognition
Format: YYYY-MM-dd
'Delivery completed + 7 days' or 'purchase confirmation'
|
||||||||||
settlementDate | String |
Estimated date of settlement
Format: YYYY-MM-dd
|
||||||||||
finalSettlementDate | String |
Estimated date of final settlement
Format: YYYY-MM-dd
Used only for weekly settlement
|
||||||||||
deliveryFee | Object |
Detailed information on shipping fee
|
||||||||||
amount | Number |
Total shipping fee
Total shipping fee: Standard shipping fee + shipping fee for remote areas
|
||||||||||
fee | Number |
Surcharge on total shipping fee
|
||||||||||
feeVat | Number |
VAT on total shipping fee
|
||||||||||
feeRatio | Number |
Surcharge rate for shipping fee (%)
|
||||||||||
settlementAmount | Number |
Estimated settlement amount for shipping fee
Estimated settlement amount: Total shipping fee - surcharge on shipping fee - VAT on shipping fee
|
||||||||||
baseAmount | Number |
Standard shipping fee
|
||||||||||
baseFee | Number |
Surcharge on standard shipping fee
|
||||||||||
baseFeeVat | Number |
VAT on standard shipping fee
|
||||||||||
remoteAmount | Number |
Shipping fee for remote areas
|
||||||||||
remoteFee | Number |
Surcharge on shipping fee for remote areas
|
||||||||||
remoteFeeVat | Number |
VAT on shipping fee for remote areas
|
||||||||||
items | Array |
Details of settlement amount for each order item
|
||||||||||
taxType | String |
Tax type
|
||||||||||
productId | Number |
Exposed product ID
This ID may be changed anytime (e.g., merge or scatter) and cannot be used as key for reconciliation in settlement.
|
||||||||||
productName | String |
Exposed product name
|
||||||||||
vendorItemId | Number |
Option ID;
The smallest unit of product on Coupang (Unit used for product modification, return, etc.).
This ID cannot be changed. Because it is the smallest unit, it is used as key. |
||||||||||
vendorItemName | String |
Option name
|
||||||||||
salePrice | Number |
Total sales price;
Total sales price reflecting quantity
|
||||||||||
quantity | Number |
Quantity
|
||||||||||
coupangDiscountCoupon | Number |
Amount of discount supported by Coupang
|
||||||||||
discountCouponPolicyAgreement | Boolean |
Agree/disagree to discount coupon supported by Coupang
|
||||||||||
saleAmount | Number |
Amount of sales;
Amount of sales = Sales - discount supported by Coupang
|
||||||||||
sellerDiscountCoupon | Number |
Seller discount coupon
|
||||||||||
downloadableCoupon | Number |
Downloadable coupon
|
||||||||||
serviceFee | Number |
Service fee
|
||||||||||
serviceFeeVat | Number |
VAT on service fee
|
||||||||||
serviceFeeRatio | Number |
Service fee rate (%, VAT excluded)
|
||||||||||
settlementAmount | Number |
Amount of settlement
Amount of settlement = Amount of sales - (service fee + VAT on service use)
|
||||||||||
couranteeFeeRatio | Number |
Courantee fee rate (%)
|
||||||||||
couranteeFee | Number |
Courantee fee (amount)
|
||||||||||
couranteeFeeVat | Number |
VAT on Courantee fee
|
||||||||||
externalSellerSkuCode | String |
Seller product management code
|
||||||||||
storeFeeDiscount | Number |
Discount amount for seller store fee
|
||||||||||
storeFeeDiscountVat | Number |
VAT on seller store fee
|
||||||||||
hasNext | Boolean |
Presence of data in the next page
|
||||||||||
nextToken | String |
Token value for the next page query
|
Response Example
{
"code": 200,
"message": "OK",
"data": [
{
"orderId": 28000048862315,
"saleType": "REFUND",
"saleDate": "2019-09-06",
"recognitionDate": "2019-10-02",
"settlementDate": "2019-11-21",
"finalSettlementDate": "2019-11-21",
"deliveryFee": {
"amount": 0,
"fee": 0,
"feeVat": 0,
"feeRatio": 3,
"settlementAmount": 0,
"baseAmount": 0,
"baseFee": 0,
"baseFeeVat": 0,
"remoteAmount": 0,
"remoteFee": 0,
"remoteFeeVat": 0
},
"items": [
{
"taxType": "TAX",
"productId": 294693352,
"productName": "gtest 테스트 비정품잉크",
"vendorItemId": 5307184135,
"vendorItemName": "gtest 테스트 비정품잉크, 1개, 블랙",
"salePrice": 300,
"quantity": 2,
"coupangDiscountCoupon": 0,
"discountCouponPolicyAgreement": false,
"saleAmount": 300,
"sellerDiscountCoupon": 0,
"downloadableCoupon": 0,
"serviceFee": 22,
"serviceFeeVat": 2,
"serviceFeeRatio": 7.0,
"settlementAmount": 276,
"couranteeFeeRatio": 0,
"couranteeFee": 0,
"couranteeFeeVat": 0,
"storeFeeDiscountVat": 0,
"storeFeeDiscount": 0,
"externalSellerSkuCode": ""
},
{
"taxType": "TAX",
"productId": 294692050,
"productName": "gtest 테스트 훈제란",
"vendorItemId": 5307179471,
"vendorItemName": "gtest 테스트 훈제란, 1개, 500g",
"salePrice": 100,
"quantity": 1,
"coupangDiscountCoupon": 0,
"discountCouponPolicyAgreement": false,
"saleAmount": 100,
"sellerDiscountCoupon": 0,
"downloadableCoupon": 0,
"serviceFee": 10,
"serviceFeeVat": 1,
"serviceFeeRatio": 10.0,
"settlementAmount": 89,
"couranteeFeeRatio": 0,
"couranteeFee": 0,
"couranteeFeeVat": 0,
"storeFeeDiscountVat": 0,
"storeFeeDiscount": 0,
"externalSellerSkuCode": ""
}
]
},
{
"orderId": 2000050175528,
"saleType": "SALE",
"saleDate": "2019-09-26",
"recognitionDate": "2019-10-03",
"settlementDate": "2019-11-21",
"finalSettlementDate": "2019-11-21",
"deliveryFee": {
"amount": 0,
"fee": 0,
"feeVat": 0,
"feeRatio": 3,
"settlementAmount": 0,
"baseAmount": 0,
"baseFee": 0,
"baseFeeVat": 0,
"remoteAmount": 0,
"remoteFee": 0,
"remoteFeeVat": 0
},
"items": [
{
"taxType": "TAX",
"productId": 290865426,
"productName": "쁘띠드엔 ㅇㅇ",
"vendorItemId": 5291775079,
"vendorItemName": "쁘띠드엔 ㅇㅇ, 남아, L(7호)",
"salePrice": 200,
"quantity": 1,
"coupangDiscountCoupon": 0,
"discountCouponPolicyAgreement": false,
"saleAmount": 200,
"sellerDiscountCoupon": 0,
"downloadableCoupon": 0,
"serviceFee": 21,
"serviceFeeVat": 2,
"serviceFeeRatio": 10.5,
"settlementAmount": 177,
"couranteeFeeRatio": 0,
"couranteeFee": 0,
"couranteeFeeVat": 0,
"storeFeeDiscountVat": 0,
"storeFeeDiscount": 0,
"externalSellerSkuCode": ""
}
]
},
{
"orderId": 0,
"saleType": "SALE",
"saleDate": "2019-10-31",
"recognitionDate": "2019-10-31",
"settlementDate": "2019-11-21",
"finalSettlementDate": "2019-11-21",
"deliveryFee": {
"amount": 0,
"fee": 0,
"feeVat": 0,
"feeRatio": 3,
"settlementAmount": 0,
"baseAmount": 0,
"baseFee": 0,
"baseFeeVat": 0,
"remoteAmount": 0,
"remoteFee": 0,
"remoteFeeVat": 0
},
"items": [
{
"taxType": "",
"productId": 0,
"productName": "",
"vendorItemId": 0,
"vendorItemName": "",
"salePrice": 0,
"quantity": 0,
"coupangDiscountCoupon": 0,
"discountCouponPolicyAgreement": false,
"saleAmount": 0,
"sellerDiscountCoupon": 0,
"downloadableCoupon": 0,
"serviceFee": 0,
"serviceFeeVat": 0,
"serviceFeeRatio": null,
"settlementAmount": 0,
"couranteeFeeRatio": 0,
"couranteeFee": 0,
"couranteeFeeVat": 0,
"storeFeeDiscountVat": 0,
"storeFeeDiscount": 0,
"externalSellerSkuCode": ""
}
]
}
],
"hasNext": false,
"nextToken": ""
}
Error Spec
HTTP Status Code (Error Type) | Error Message | Solution |
---|---|---|
400 (Check Request Parameter) |
The request is invalid: dateTo: You can only search for the previous day. User input = 2024-08-01 |
Check if you entered only the previous day's date in recognitionDateTo. |
400 (Check Request Parameter) |
The request is invalid: dateFrom, dateTo: You can only search for the range within 1 month. User input = 2024-06-27, 2024-07-27 |
Check if you entered a date within a month. |
400 (Check Request Parameter) |
Required String parameter 'vendorId' is not present |
Make sure that the 'vendorId' value is correct. |
400 (Check Request Parameter) |
The request is invalid: recognitionDateFrom: Invalid format. Use the format: 'yyyy-MM-dd'. (Example) '2011-12-03' User input = **** |
Make sure that the 'recognitionDateFrom' value is correct. |
400 (Check Request Parameter) |
The request is invalid: recognitionDateTo: Invalid format. Use the format: 'yyyy-MM-dd'. (Example) '2011-12-03' User input = **** |
Make sure that the 'recognitionDateTo' value is correct. |
400 (Check Request Parameter) |
Required String parameter 'token' is not present |
Make sure that the token value is correct. |
400 (Check Request Parameter) |
The request is invalid: token: Invalid format. Leave it blank when you call the first page. From the second page and onward, use the 'nextToken' value included in the previous page response. User input value = * |
Make sure that the token value is correct. |
URL API Name
GET_REVENUE_HISTORY