Notice on API changes (2024/08/23)

Notice on changes to the exchange request list inquiry API

From September 2, 2024, the phone number in the exchange list query API response will be provided as a secure number. Please see here for more details.

Notice on changes to the purchase order API

From August 6, 2024, the orderer email parameter value in the purchase order purchase and query of coupang contact center inquiries API response will be displayed as an empty value (""). Please see here for more details.

Notice on changes to the purchase order API

From April 12, 2024, the method of displaying the order quantity for automatic generation option orders in the purchase order API response will be changed. Please see here for more details.

Product Creation API Change Notice

Starting April 3, 2024 the number of characters allowed for displayProductName in the product creation API will be changed. Please see here for more details.

Auto-generated option function added

The auto-generated option function will be applied from January 8, 2024. This is a feature that allows sellers to easily sell products as a bundle. Please refer here for more information.

OpenAPI key deletion information

OpenAPI keys will be deleted sequentially to apply the validity period starting October 24, 2023. Please see here for more details.

Notice on strengthening OpenAPI speed limit policy

From October 12, 2023, the rate limit policy for product-related Open APIs, which was temporarily suspended, will be gradually strengthened and applied. Please see here for more details.

Notice of OpenAPI SDK service interruption

OpenAPI Java SDK supports services only until October 31, 2023. After that, update support will not be provided and programs and documents may be changed or deleted without prior notice. Please see here for more details.

Detailed information on changes to the Open API Key issuance method

When issuing/modifying an OpenAPI key, It is only possible with one Integrator(solution, service) or self-development (direct input).
Please see here for details.

[Query of Coupang Contact Center Single Inquiry] API added

[Query of Coupang Contact Center Single Inquiry] API has been added.  Please see here for details.

Introduction of Open API rate limit policy

From July 10 (Mon), a rate limit policy will be introduced when calling OpenAPI to provide stable service. Excessive API calls that exceed the standard are immediately blocked, so please be careful not to make excessive calls per second. Please see here for details.

Please add the information on the integrator (seller tool)

In order to provide reliable and stable services, we would like to collect the information on the IP address as well as the type of API that you use when you access Coupang. The IP information that you provide here will be used to allow/block future access via Open API. Please request us to correct it if there is any change. (Consent required : API integration agreement)

* Individual sellers who do not provide an Integrators program (service or solution) do not need to fill out.

https://forms.office.com/r/cYcMrP2bEQ

Changes to how the Open API Key is issued

To better protect your information, we are changing the way we issue the Open API Key starting July 10, 2023. Please see here for details.

new courier company codes added

32 new courier company codes are added, including Hyundai Glovis. Please see here for details.

From February 2, 2023, the buyerEmail parameter value in the API response message will be provided as an empty value. Please see here for details.

After the domestic or overseas classification set at the time of registration of the shipping address is determined, it is not possible to change from domestic to overseas or from overseas to domestic.

If you want to change the division between domestic and overseas, please register a new shipping address.

The old) Query a shipping location API including the URL below is not supported and will be deleted on October 13, 2022.

Please change to the currently provided query a shipping location API.

openapi/apis/api/v4/vendors/{vendorId}/outboundShippingCenters

When searching the PO list query (by Minute) API, an error in which sections longer than 24 hours are searched has been found and will be corrected.

From August 24, 2022, inquiry is not possible for more than 24 hours, so if you are using the API incorrectly, be sure to change it within the period.

Please note the following when entering purchasing agent (AGENT_BUY) as the deliveryMethod paramenter value in the product creation/modification API.

• Please enter the shipping address for international shipping only. You cannot enter a domestic(Korean) shipping address.
• The pccNeeded parameter value must be set to true.

Those in charge of companies that provide solutions (programs) that work with Coupang, please enter your IP address, emergency contact information and e-mail in the survey form below to provide stable Coupang OpenAPI services.
API access may be blocked without prior notice when massive traffic is repeatedly generated without submitting information.
https://forms.office.com/r/we8Z1sz605 (Select English in the upper right corner)

The URL of the Query one return location API has been changed as follows.

greatwall_api/apis/api/v2/return/shipping-places/center-code

-> openapi/apis/api/v2/return/shipping-places/center-code

From June 30, 2022, URL containing greatwall_api cannot be called, so please change them within the deadline.

If you make an API call with a URL that includes greatwall_api below, be sure to change it to openapi. API calls with greatwall_api no longer work.

1. Query one return location API: greatwall_api/apis/api/v2/return/shipping-places/center-code

2. Query a list of exchange requests API: greatwall_api/apis/api/v4/vendors/{vendorId}/exchangeRequests

3. Customer Inquiry Query by Product API: greatwall_api/apis/api/v4/vendors/{vendorId}/onlineInquiries

Coupang API Gateway will be upgraded to TLS v1.2 on Jun 28, 2022. If you are still using version 1.0 or 1.1, please upgrade the TLS version within the period. For details on how to upgrade the TLS version, please refer here.

The old settlement API including the URL below is not supported and will be deleted soon. Please change to the settlement API currently provided. greatwall_api/api/v4/vendors/{vendorId}/orders/salesDetails  greatwall_api/apis/api/v1/settlement/goods/sales/inquiries/{vendorId}

Query a status of product registration API is added. Please click here for details

Confirmation of category auto matching service agreement API is added. Please click here for details

Category auto matching service is added. Please click here for details

New exchange/return/cancellation VOC reason codes are added. Please click here for details.

From October 12, 2020, open Attribute will be added for product registration. Up to 3 purchase options can be configured. Please click here for details.

New exchange/return/cancellation VOC reason codes are added. Please click here for details.

In the same way as price / inventory / sales status, a new product modification (no approval required) API is provided, which allows you to immediately change delivery-related information without approval.
Please click here for details.

Notice on season 1 API service termination

Season 1 API service will terminate on June 30, 2020.
E-mail notices are sent out to sellers using season 1 API. The current website provides season 2 API. We recommend you to upgrade season 1 to season 2 API for safer use of the services. 

Node.js was added to sample code.
More details are given here

Return process changed

Orders cancelled by customer at the 'preparation' stage will be refunded immediately, starting from Apr. 6 TBD 

Some return query APIs are modified accordingly.

More details are given here

[ordered product cancellation processing] API url changed

Url to call API for ordered product cancellation changed. 

More details are given here.

API to change lowest price guarantee per item for [Courantee] product removed

API to change lowest price guarantee per item is no longer available upon the termination of [Courantee] services. 

Paging query API for list of exposed items removed

Paging query API for list of exposed items is no longer available due to internal errors and low usage rates

Settlement API updates released

New returning results for settlement API

Amounts spent on seller store have been added to Sales breakdown API and payment breakdown API.

OPEN API updates released

query for instantly cancelled orders

Orders cancelled by either customer or seller at the payment completion stage can now be queried. Please refer to API for the list of requested returns/cancellation for more details.

new courier company codes added

10 new courier company codes are added, including Smartlogis. 

status value modified for product querying 

SAVING status value deleted

IN_REVIEW status value added

You can query products staying at IN_REVIEW stage through product list paging search API

Error fixed on usable default value for shipping location creation API 

The default value for usable parameters upon creation of shipping location changed to TRUE (enabling to use the place of address) 

Notice on season 1 API service termination

E-mail notices are sent out to sellers using season 1 API. The current website provides season 2 API. We recommend you to upgrade season 1 to season 2 API for safer use of the services. 

Shipping location list query API removed and replaced with new one

Query API for list of shipping locations deleted

Please use shipping location query API instead. 

API to process cancellation on payment completed orders removed and replaced

API to process cancellation of payment completed orders deleted. Please use ordered product cancellation API instead (API for 'cancellation of orders at preparation stage' has changed as 'ordered product cancellation' API). 

(common) free contract creation API removed

Free contract creation API is automatically called when the budget is set on WING. No need to call it separately. 

Website improvements

Coupang OPEN API website has been renewed. You can submit your inquires directly online. Please refer to the guidelines on seller support online for more details. 

New API to query payment breakdown

Query API for WBI/settled amounts based on monthly revenue recognition has been added  

New shipping location query API added

New query API for shipping locations by shipping location code/name has been added

New parameter for downloadable coupon added

Downloadable Coupon discount amounts are added to the settlement-sales breakdown page. 

New downloadable coupon API added

Downloadable coupon API is released. More details are given here.

conditional free shipping rules updated 

Newly updated rules now allow sellers to adjust the amounts of conditional free shipping charges. 

CS API > CS reply rules updated 

'replayBy' value of CS reply API has been set as mandatory. 

product registration guidelines, VOC code, return delivery fee parameters updated 

List product API guidelines, VOC code for exchange/return/cancellation-related API, and parameters for estimated return shipping fees are all updated. 

FC API improved 

When duplicated shipping/return locations are created, corresponding FC codes are returned as results.  

New settlement API added

New query API for sales breakdown for settlement services has been released. More details are given here.

Coupang's SDK will help you to use OpenAPI more conveniently and quickly. More details are given here.

A guideline for OpenAPI test using Postman has been uploaded. More details are given here.

category recommendation API newly added 

Category recommendation API has been added. Please refer to the relevant API document for more details. 

New query API for history of withdrawn returns with a period value 

A new query API for history of withdrawn returns with a period value has been added. Please refer to the relevant API document for more details. 

Query API for the list of requested returns updated

New parameters of reasonCode (reason-for-return code) and reasonCodeText (descriptions) are added to the response values of the query API for the list of requested returns. Please refer to the relevant API document for more details. 

API to cancel order at preparation stage & Pickup waybill manual uploading API newly added

New APIs to cancel order at preparation stage & manually upload pickup waybill have been updated. Please refer to the relevant API document for more details. 

New API to update delivery invoice 

A new API to update the delivery invoice info has been added. Please refer to the API document under the shipping/refund API for more details. 

Courier company code for "DREAM COURIER" deleted

DREAM COURIER's courier code was deleted upon its closure of the business. Please refer to the relevant API document for more details. 

Query API for the list of requested returns updated

Return pick-up address, detailed address, postal codes are added to Response Sepc. of query API for the list of requested returns API v4. 

Please refer to the API document for more details. 

New API to complete aged 'not shipped out' orders 

A new API has been added to complete orders that are not shipped out more than a month after the invoice registration. Please refer to the API document under the shipping/refund API for more details. 

New API to query history of withdrawn returns

A new API has been added to query the history of the withdrawn return requests by the customer. Please refer to the API document under the return API for more details. 

New API to query single PO with order ID 

New API to query single PO using order ID has been added. Please refer to the API document under the shipment/refund API for more details. 

New coupon API updated

Coupon API and guidelines are updated. Please refer to the relevant API document for more details. 

New courier company "ECMS Express" updated

ECMS Express courier code has been added. Please refer to the relevant API document. 

Query API for list of requested exchanges modified

Reason-for-exchange codes, descriptions and details are added to the Response Spec of the query API for list of requested exchanges. 

Please refer to the relevant API document for more details. 

Requesting Coupang's confirmation API and relevant guidelines will be deleted as of Jan. 29. 

Coupang CS center QnA API structures has changed.

Please refer to the API document for more details. 

API for refund on payment complete orders modified

"CCSSER" to be deleted from the reason code in the middle classification of the return API as of Jan. 15, 2018. Sending the aforementioned code will trigger an error going foward. 

Ccourier company name changed

KG Logis changed its name as "DREAM courier"; no change to the courier code

Coupang CS center QnA API structures to be changed on Jan. 8 of 2018 along with WNIG system & API Specification updates. API errors might occur on the same day.

Coupang CS center QnA API v1 services will be terminated after 2017. Please refer to the API document for more details. 

PO list query API modified

Response Specification for PO list squery API v4 has changed. Please refer to the API document for more details. 

CS API modified

PartnerCounsellingStatus Parameter which is used for Coupang CS center QnA query has changed. Please refer to the API document for more details. 

Open API applied to editable catalog feature

You can request to modify Coupang product info through Product modification API. You can query editable options through the same. 

Category Excel file export feature added

You can export excel spreadsheet from Category list search API page 

New return values for PO query API 

New return values (listed option names and original listed  option names) are added to query API for PO list and single order. Please refer to the API document for more details. 

Descriptions on return API added 

Codes and descriptions are added to FaultByType, CompletionConfirmType return values for return list query API. Please refer to the API documents for more details. 

New product info field added

Product PCC required/not-required field is added

Please refer to the product creation/modification/query API documents for more details. 

E-mail based seller support terminated 

E-mail-based seller support services via wing.openapi@coupang.com to be terminated after Jun. 16, 2017. 

For any inquiry about development, please go to WING > Seller Support > online support and select "OPEN API" from the drop down menu to get swift response.