(Common) Run a query on budget status

# 01

Summary

# 02

Details

Available buyer market: Korea

This API is used to view the coupon budget status of all contracts that are currently set.
Since the coupon budget is set on a monthly basis in accordance with contract terms and conditions, you can view the contract on a monthly basis.

Path

GET/v2/providers/fms/apis/api/v1/vendors/{vendorId}/budgets

Example endpoint

https://api-gateway.coupang.com/v2/providers/fms/apis/api/v1/vendors/A00012345/budgets?contractId=-1&targetMonth=2017-08

# 03

Path parameters

Name	Type	Description
vendorId*	string	Vendor ID An unique code Coupang assigns to a vendor e.g.) A00012345

# 04

Query parameters

Name	Type	Description
contractId	number	A contract Id (enter -1 for a free contract)
targetMonth	string	The month for a budget view yyyy-MM You get the view of the current month unless you enter target month.

# 05

Response body

Response message

Name	Type	Description
code	integer	Server response code
message	string	Server response message
httpStatus	integer	HTTP Status Code(the same as server response code)
httpStatusMessage	string	HTTP Status Message (the same as server response message)
errorMessage	string	Except for HTTP Status 200, all other statuses contain a message on a detailed reason for server failure.
data	object	Budget status list data
success data.success	boolean	Success true or false
content data.content	object[]	Budget status list
contractId data.content[].contractId	integer	A vendor contract Id e.g.) 1, 2
targetMonth data.content[].targetMonth	string	The target month for running a query e.g.) 2017-08
vendorShareRatio data.content[].vendorShareRatio	integer	A share ratio(%) : A ratio agreed upon with Coupang in the contract e.g.) 100
totalBudgetAmount data.content[].totalBudgetAmount	integer	Budget amount set for the month concerned e.g.) 1000000
usedBudgetAmount data.content[].usedBudgetAmount	integer	Budget amount used for the month concerned e.g.) 50.00
pagination data.pagination	string

Response Example

{
  "code": 200,
  "message": "OK",
  "httpStatus": 200,
  "httpStatusMessage": "OK",
  "errorMessage": "",
  "data": {
    "success": true,
    "content": [
      {
        "contractId": 2,
        "targetMonth": "2017-08",
        "vendorShareRatio": 100,
        "totalBudgetAmount": 1000000,
        "usedBudgetAmount": 50
      }
    ],
    "pagination": null
  }
}

# 06

Error codes

HTTP	Code	Message
400	HTTP_400	Bad Request

Error specification

HTTP	Type	Error message	Solution
401	401 (Check the requested parameter)	Check the vendor access.	Check the vendor Id for correctness.
400	400 (Check the requested parameter)	Invalid format: "2020" is too short	Check that the target month for running a query is correct.