coupang
API Documentation
ProductsCategoriesBrandsShipments & OrdersReturnsExchangesPromotions & CouponsLogistics InfoCustomer ServiceSettlementCGF / CGF liteRocket Growth
GET/v2/providers/fms/apis/api/v2/vendors/{vendorId}/contractv1

(Common) Query single contract

# 01

Summary

Available buyer market: Korea An API to query a current single contract.

# 02

Details

Available buyer market: Korea
An API to query a current single contract.

 

Path

GET

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

Example Endpoint

https://api-gateway.coupang.com/v2/providers/fms/apis/api/v2/vendors/A00012345/contract?contractId=9962

Request Parameters

Path Segment Parameter

Name Required Type Description
vendorId O String
Seller ID
Unique seller code issued by Coupang
e.g. A00012345

Query String Parameter

Name Required Type Description
contractId O Number
Seller's contract ID

Request Example

not require body

Response Message

Name Type Description
code Number
Server response code
message String
Server response message
httpStatus Number
HTTP Status Code (Same value with Server response code)
httpStatusMessage String
HTTP Status Message (Same value with Server response message)
errorMessage String
This will contain detailed server failure reason message in all status except for HTTP Status 200
data Object
Single contract data
  success Boolean
True or false
  content Object
A single contract
    contractId Number
Seller's contract ID
e.g. 1, 2
    vendorContractId Number
Seller's contract code (for Coupang's management purpose)
e.g. -1, 1, 2
    sellerId String
Seller ID
e.g. A00012345
    sellerShareRatio Number
Seller [funding] rate on the contract(%)
e.g. 100
    coupangShareRatio Number
Coupang [funding] rate on the contract(%)
예) 100
    gmvRatio Number
Monthly sales rate and monthly budget which are automatically generated based on sales in Coupang.
e.g. 100
    start String
Start date and time
e.g. 2018-01-22 00:00:00
    end String
End date and time
e.g. 2018-12-31 23:59:59
    type String
Contract type
e.g. CONTRACT_BASED, NON_CONTRACT_BASED
    usedBudget Boolean
Whether to use budget restriction
e.g. true, false
The value is not in use anymore, and true is set as default
    modifiedAt String
Final modification date and time
e.g. 2017-09-25 11:40:01
    modifiedBy String
Final editor ID
  Pagination null
There is no pagination as it is a single contract

Response Example

{
  "code": 200,
  "message": "OK",
  "httpStatus": 200,
  "httpStatusMessage": "OK",
  "errorMessage": "",
  "data": {
    "success": true,
    "content": {
      "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
  }
}

Error Spec

HTTP status code (error type) Error message Solution
401 (check requested parameter) Please check on seller information permission Make sure proper vendorID was put in.
401 (check requested parameter) Contract ID is invalid for querying Make sure proper contractID was put in.
401 (check requested parameter) Required parameter, 'contractId,' is not present Make sure contractId exists.