coupang
API Documentation
ProductsCategoriesBrandsShipments & OrdersReturnsExchangesPromotions & CouponsLogistics InfoCustomer ServiceSettlementCGF / CGF liteRocket Growth
POST/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/return-exchange-invoices/manualv1

Upload a pickup waybill

# 01

Summary

Available buyer market: Korean Sellers not using the auto return integration service (Goodsflow) to pick up return products can upload a pickup waybill directly through this API when receiving a return/exchange request. Sellers using Goodsflow don't need to use this API.

# 02

Details

Available buyer market: Korean

Sellers not using the auto return integration service (Goodsflow) to pick up return products can upload a pickup waybill directly through this API when receiving a return/exchange request.

Sellers using Goodsflow don't need to use this API.

Return: Usable if the return status (receiptStatus) is Return request received (RETURNS_UNCHECKED) on the list of return requests
Exchange: Usable if the pickup status (collectStatus) is Before pickup integration (BeforeDirection) on the list of exchange requests
 
※ Even after a pickup waybill is uploaded, Customer may cancel a return request if delivery is not trackable, or until the delivery person picks up the product.

 

Path

POST

/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/return-exchange-invoices/manual

Example Endpoint

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/return-exchange-invoices/manual

Request Parameters

Path Segment Parameter

Name Required Type Description
vendorId O String
Seller ID
Unique code issued to Vendor by Coupang
ex) A00012345

Body Parameter

Name Required Type Description
returnExchangeDeliveryType O String
Enter RETURN or EXCHANGE
receiptId O Number
Return or exchange receipt ID
Able to check it using APIs to query lists of return and exchange requests
Must be the number type
deliveryCompanyCode O String
Courier code
Link to a list of courier codes
invoiceNumber O String
Waybill number
regNumber   String
Courier pickup number (enter the pickup number when it's issued)

Request Example

{
  "returnExchangeDeliveryType": "EXCHANGE",
  "receiptId": 101606005,
  "deliveryCompanyCode": "KDEXP",
  "invoiceNumber": "201805291435",
  "regNumber": "1234568"
}

Response Message

Name Type Description
code Number
HTTP Status Code
message String
HTTP Status message
data InvoiceNumberCreateDto
 
  deliveryCompanyCode String
Courier code
  invoiceNumber String
Waybill number
  invoiceNumberId Number
Internal invoiceNumberId
  receiptId Number
Return or exchange receipt ID
  regNumber String
Courier pickup number
  returnDeliveryId Number
Internal returnDeliveryId
  returnExchangeDeliveryType String
RETURN or EXCHANGE

Response Example

{
  "code": 200,
  "message": "OK",
  "data": {
    "deliveryCompanyCode": "KDEXP",
    "invoiceNumber": "201805291435",
    "invoiceNumberId": 26125633,
    "receiptId": 101606005,
    "regNumber": "1234568",
    "returnDeliveryId": 25726758,
    "returnExchangeDeliveryType": "RETURN"
  }
}

Error Spec

HTTP status code (error type) Error message How to resolve
400 (check request parameter) It must differ from the delivery waybill number. Waybill number: 2333*****6911.

Check if the pickup waybill number is the same as the delivery waybill number. Enter a new waybill number for pickup.
500 (check request parameter) Invalid value for DeliveryCompanyCodeEnum: ***

Check if the courier code (DeliveryCompanyCode) you entered is supportable. Check and enter a supportable courier code.

 * Courier Code
400 (check request parameter)

The format of return waybill is not correct.

Waybill number: 1*** , Courier: CJGLS

Check if the waybill number and courier are correct.
400 (check request parameter) Object is null

Check if any entry is null.

URL API Name

CREATE_RETURN_EXCHANGE_INVOICE