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

Query a list of exchange requests

# 01

Summary

Available buyer market: Korean You can check a list of exchange requests received within up to 7 days. Download the attachment below for the receipt reason (reasonCode) of each exchange request.

# 02

Details

Available buyer market: Korean

You can check a list of exchange requests received within up to 7 days.
Download the attachment below for the receipt reason (reasonCode) of each exchange request.

 

Path

GET

/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/exchangeRequests

Example Endpoint

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/exchangeRequests?createdAtFrom=2018-03-05T00:00:00&createdAtTo=2018-03-10T23:59:59&status=PROGRESS

Request Parameters

Path Segment Parameter

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

Query String Parameter

Name Required Type Description
createdAtFrom O String 
Search start date/time (yyyy-MM-ddTHH: mm: ss)
ex) 2016-03-15T13:00:00
createdAtTo O String 
Search end date/time (yyyy-MM-ddTHH: mm: ss)
ex) 2016-03-16T13:00:00
status   String 
Status of exchange progress
All the status to be returned if no specific status is selected
Name Status
RECEIPT Received
PROGRESS In progress
SUCCESS Completed
REJECT Rejected
CANCEL Cancelled
orderId   Number 
Order number
ex) 19000009511537
nextToken   String
Token value to query the next page
You do not need this for your first page query.
maxPerPage   Number
Max. value of query request
Default value: 10
 

Path Segment Parameter

not require body

 

Response Message

Name Type Description
code Number
server response status code
message String
detail info
data Object
Result
  exchangeId Number
Exchange ID
  orderId Number
Order ID
  vendorId String
Seller ID
  orderDeliveryStatusCode String
Order/delivery status
Name Status
ACCEPT Payment completed
INSTRUCT Product in preparation
DEPARTURE Delivery started
DELIVERING In transit
FINAL_DELIVERY Delivery completed
NONE_TRACKING Shipped directly by vendor (delivery not integrated), not trackable
  exchangeStatus String
Exchange status
Name Status
RECEIPT Received
PROGRESS In progress
SUCCESS Completed
REJECT Rejected
CANCEL Cancelled
  referType String
Receipt channel
Name Status
VENDOR Vendor
CS_CENTER CS
WEB_PC Web PC
WEB_MOBILE Web mobile
  faultType String
Accountability
Name Status
COUPANG Coupang at fault
VENDOR Vendor at fault
CUSTOMER Customer at fault
WMS Logistical fault
GENERAL General
  exchangeAmount String
Exchange shipping fee
  reason String
null *No longer in use.
  reasonCode String
Exchange reason code
Download the attachment at the top of this page and check the VOC reason code.
  reasonCodeText String
Description of exchange reason
  reasonEtcDetail String
Detailed description of exchange reason
  cancelReason String
Exchange cancellation reason
  createdByType String
Type of the original requester
Name Status
CUSTOMER Customer
COUNSELOR Agent
COUPANG Internal employee
VENDOR Vendor
ETC Others
  createdAt String
Registration date/time
(yyyy-MM-ddTHH: mm: ss)
  modifiedByType String
Modified by
Name Status
CUSTOMER Customer
COUNSELOR Agent
COUPANG Internal employee
VENDOR Vendor
ETC Others
TRACKING Delivery tracking
  modifiedAt String
Modification date/time
(yyyy-MM-ddTHH: mm: ss)
  exchangeItemDtoV1s Array
List of exchange items 
    exchangeItemId Number
Exchange product ID 
Internal ID used to save exchange data
    orderItemId Number
Original order item ID
    orderItemUnitPrice Number
Original order item unit price
    orderItemName String
Original order item name
    orderPackageId Number
Original order package ID
    orderPackageName String
Original order package name
    targetItemId Number
Exchange item ID
    targetItemUnitPrice Number
Exchange item unit price
    targetItemName String
Exchange item name
    targetPackageId Number
Exchange package ID
    targetPackageName String
Exchange package name
    quantity Number
Exchange quantity
    orderItemDeliveryComplete Boolean
True/False
Whether the original order item is delivered
    orderItemReturnComplete Boolean
True/False
Whether the original order item is returned
    targetItemDeliveryComplete Boolean
True/False
Whether the exchange item is delivered
    createdAt String
Creation date/time
(yyyy-MM-ddTHH: mm: ss)
    modifiedAt String
Modification date/time
(yyyy-MM-ddTHH: mm: ss)
    originalShipmentBoxId Number
Original delivery no.
  exchangeAddressDtoV1 Object
Exchange address
    exchangeAddressId Number
Exchange address ID
    returnCustomerName String
Name of return requester
    returnAddressZipCode String
Zip code of return location
    returnAddress String
Address of return requester
    returnAddressDetail String
Detailed return address
    returnPhone String
Phone number of return requester
    returnMobile String
Mobile phone of return requester
    returnMemo String
Return memo
    deliveryCustomerName String
Name of recipient
    deliveryAddressZipCode String
Zip code
    deliveryAddress String
Address of recipient
    deliveryAddressDetail String
Detailed address
    deliveryPhone String
Phone of recipient
    deliveryMobile String
Mobile phone of recipient (safety number)
    deliveryMemo String
Delivery memo
    createdAt String
Creation date/time
(yyyy-MM-ddTHH: mm: ss)
    modifiedAt String
Modification date/time
(yyyy-MM-ddTHH: mm: ss)
    exchangeId Number
Exchange ID
  deliveryInvoiceGroupDtos Array
Delivery Invoice informations
    shipmentBoxId Number
Delivery ID
    boxPrice Number
Box price
    orderId Number
Order ID
    orderType String
Order type
    customerType String
User type
    bundleType String
Type of delivery bundle
    extraMessage String
Memo
    shippingDeliveryType String
Delivery type
Name Status
DELIVERY General delivery
EXCHANGE_DELIVERY Exchange delivery
FORCED_DELIVERY Additional outbound shipment
    deliveryInvoiceDtos Array
Delivery Invoice informations
      invoiceNumber String
Waybill number
      estimatedDeliveryDate String
Lead time from order to shipment
(yyyy-MM-ddTHH: mm: ss)
      deliveredDate String
Delivery date
(yyyy-MM-ddTHH: mm: ss)
      statusModifiedAt String
Status update date/time
(yyyy-MM-ddTHH: mm: ss)
      invoiceNumberUploadDate String
Waybill number uploading date/time
(yyyy-MM-ddTHH: mm: ss)
      statusCode String
PO status
Name Status
ACCEPT Payment completed
INSTRUCT Product in preparation
DEPARTURE Delivery started
DELIVERING In transit
FINAL_DELIVERY Delivery completed
NONE_TRACKING Shipped directly from vendor (delivery not integrated), not trackable
      deliverCode String
      isMainShipmentInvoice Boolean
Whether it's the main waybill in case of Retail split delivery
      parcelType String
Retail delivery type
      invoiceVendorItemDtos Array
vendor item information
        vendorItemId Number
Option ID
        quantity Number
Quantity
        hasAdditionalItem Boolean
Partial or not
        promiseDeliveryDate String
Estimated delivery date per product at the time order
(yyyy-MM-ddTHH: mm: ss)
        estimatedShippingDate String
Estimated shipping date at the time of order
(yyyy-MM-ddTHH: mm: ss)
  deliveryStatus String
Re-delivery status
Name Status
BeforeDirection Before delivery integration
CompleteDirection Delivery integrated
Delivering In transit
CompleteDelivery Delivery completed
DirectionFail Delivery integration failed
VendorDirect Shipped directly from vendor
Fail Delivery failed
Withdraw Exchange delivery cancelled
NoneData No data
  collectStatus String
회수상태
Name Status
BeforeDirection Before pickup integration
CompleteDirection Pickup integrated
Delivering Pickup in progress
CompleteCollect Sent to vendor
DirectionFail Pickup integration failed
Fail Pickup failed
Withdraw Exchange pickup cancelled
NoCollect Pickup not needed
NoneData No data
  collectCompleteDate String
Date/time of pickup completed
(yyyy-MM-ddTHH: mm: ss)
  collectInformationsDto Object
Pickup info
    returnType String
Return type: Return or exchange (RETURN or EXCHANGE_RETURN)
    expectedReturnDate String
Expected return date/time
(yyyy-MM-ddTHH: mm: ss)
    returndeliveryItemDtos Array
returndeliveryItemDtos
      vendorItemId Number
Option ID
      statusCode String
Status code
Name Status
RETURN_SEND_READY Received
RETURN_SEND_COMPLETE Sent
RETURN_COLLECT_OK Normally returned
RETURN_COLLECT_NOT_OK Abnormally returned (mismatching quantity, etc.)
CHANGE_SEND_READY Exchange confirmed
CHANGE_SEND_HOLD Exchange confirmation on hold (changed to this code if cancelled at exchange confirmation)
CHANGE_SEND_COMPLETE Exchange info sent
CHANGE_SEND_FAIL Exchange OOS (not sent)
COLLECT_FAIL Pickup failed
      returnCount Number
Return quantity
      releaseStatus String
Shipment status
Name Status
RELEASED Already shipped out
NOT_RELEASED

Not shipped out
      paymentReturnDeliveryMapId Number
paymentReturnDeliveryMapId
      paymentItemId Number
paymentItemId
      modifiedBy String
Modified by
      modifiedAt String
Date/time of the final status update
(yyyy-MM-ddTHH: mm: ss)
      createdBy String
Received from
      createdAt String
Receipt date/time
(yyyy-MM-ddTHH: mm: ss)
      count Number
Quantity
      confirmType String
confirmType
Name Status
RELEASED Already shipped out
STOPPED Shipment suspended
      collectStatus String
Pickup status
Name Status
NONE None
RETURN To pick up
NO_RETURN Not to pick up
ALREADY_RETURN Already picked up
CANCEL_REQUEST_WHEN_DEPARTURE Cancellation requested at ship-out
    returndeliveryDestinationDto Object
Info about main pickup location
      vendorZipCode String
Zip code of seller
      vendorPhone String
Phone number of seller
      vendorName String
Name of seller
      vendorMobile String
Mobile phone number of seller
      vendorAddressDetail String
Detailed address of seller
      vendorAddress String
Address of seller
      safetyNumberStatus String
Safety number status
Name Status
WAIT Waiting
ENABLE Available
DEPOSE Disused
DISABLE Unavailable
ERROR Error
RESERVE Reserved
      safetyNumberId Number
Safety number ID
      safetyNumber String
Safety number
      returnDeliveryId Number
Pickup waybill number
      returnCenterCode String
Return center code
      receiptId Number
Receipt ID
      orderedByMobile String
Phone number of orderer
      orderId Number
Order ID
      message String
Message
      customerZipCode String
Zip code of customer
      customerPhone String
Phone number of customer (safety number)
      customerName String
Name of customer
      customerMobile String
Mobile phone number of customer  (safety number)
      customerAddressDetail String
Detailed address of customer
      customerAddress String
Address of customer
  returnDeliveryDtos Object
Pickup info
    deliveryCompanyCode String
Courier code
    deliveryInvoiceNo String
Pickup waybill number
  successable Boolean
True/False
Can process as exchanged Y/N
  orderDeliveryStatusLabel String
Order delivery status label
  exchangeStatusLabel String
Exchange status label
  referTypeLabel String
Receipt channel label
  faultTypeLabel String
Accountability (who is paying for shipping) label
  createdByTypeLabel String
Original requester type label
  rejectable Boolean
True/False
Can process as non-exchangeable Y/N
  modifiedByTypeLabel String
Modifier label 
  deliveryInvoiceModifiable Boolean
True/False
Can enter waybill number Y/N
nextToken String
Token value to query the next page

 

Response Example

{
  "code": 200,
  "message": "OK",
  "data": [
    {
      "exchangeId": 101268974,
      "orderId": 11000013144262,
      "vendorId": "A001234567",
      "orderDeliveryStatusCode": "FINAL_DELIVERY",
      "exchangeStatus": "PROGRESS",
      "referType": "WEB_MOBILE",
      "faultType": "VENDOR",
      "exchangeAmount": 0,
      "reason": null,
      "reasonCode": "DIFFERENTOPT",
      "reasonCodeText": "색상/ 사이즈가 기대와 다름",
      "reasonEtcDetail": "베이지색 주문했는데 브라운이 왔습니다",
      "cancelReason": null,
      "createdByType": "CUSTOMER",
      "createdAt": "2018-03-05T10:54:41",
      "modifiedByType": "TRACKING",
      "modifiedAt": "2018-03-05T10:54:41",
      "exchangeItemDtoV1s": [
        {
          "exchangeItemId": 1765111,
          "orderItemId": 3476137875,
          "orderItemUnitPrice": 35900,
          "orderItemName": null,
          "orderPackageId": null,
          "orderPackageName": null,
          "targetItemId": 3476137875,
          "targetItemUnitPrice": 35900,
          "targetItemName": "후아유(WHO.A.U) 벙커Ⅰ 레터 백팩 / WHAK82104C, (35)Beige, FREE",
          "targetPackageId": -1,
          "targetPackageName": "",
          "quantity": 1,
          "orderItemDeliveryComplete": null,
          "orderItemReturnComplete": null,
          "targetItemDeliveryComplete": null,
          "createdAt": "2018-03-05T10:54:41",
          "modifiedAt": "2018-03-05T10:54:41",
          "originalShipmentBoxId": 123456789012345678
        }
      ],
      "exchangeAddressDtoV1": {
        "exchangeAddressId": 1691712,
        "returnCustomerName": "이***",
        "returnAddressZipCode": "431-0*",
        "returnAddress": "경기도 안양시 동안구 평촌동",
        "returnAddressDetail": "꿈마을건영아파트 *",
        "returnPhone": null,
        "returnMobile": "010-****-****",
        "returnMemo": null,
        "deliveryCustomerName": "이인용",
        "deliveryAddressZipCode": "431-0*",
        "deliveryAddress": "경기도 안양시 동안구 평촌동",
        "deliveryAddressDetail": "꿈마을건영아파트 *",
        "deliveryPhone": null,
        "deliveryMobile": "050382470825",
        "deliveryMemo": null,
        "createdAt": "2018-03-05T10:54:41",
        "modifiedAt": "2018-03-05T10:54:41",
        "exchangeId": 101268974
      },
      "deliveryInvoiceGroupDtos": [],
      "deliveryStatus": "BeforeDirection",
      "collectStatus": "Collecting",
      "collectCompleteDate": null,
      "collectInformationsDto": {
        "returnType": "EXCHANGE_RETURN",
        "expectedReturnDate": "2018-03-08T10:54:41",
        "returndeliveryItemDtos": [
          {
            "vendorItemId": 3476137875,
            "statusCode": "RETURN_SEND_READY",
            "returnCount": null,
            "releaseStatus": "RELEASED",
            "paymentReturnDeliveryMapId": 29713264,
            "paymentItemId": 1,
            "modifiedBy": "104132490",
            "moodifiedAt": "2018-03-05T10:54:41",
            "createdBy": "104132490",
            "createdAt": "2018-03-05T10:54:41",
            "count": 1,
            "confirmType": null,
            "collectStatus": "RETURN"
          }
        ],
        "returndeliveryDestinationDto": {
          "vendorZipCode": "312-14",
          "vendorPhone": "1899-6500",
          "vendorName": "(주)*몰)",
          "vendorMobile": "",
          "vendorAddressDetail": "** 물류센터 지하1층",
          "vendorAddress": "충청남도 천안시 동남구 풍세면 * ()",
          "safetyNumberStatus": "DISABLE",
          "safetyNumberId": 245668944,
          "safetyNumber": "050382470825",
          "returnDeliveryId": null,
          "returnCenterCode": "1000276167",
          "receiptId": null,
          "orderedByMobile": null,
          "orderId": 11000013144262,
          "message": null,
          "customerZipCode": "14101",
          "customerPhone": "050382470825",
          "customerName": "이**",
          "customerMobile": "050382470825",
          "customerAddressDetail": "꿈마을건영아파트 *",
          "customerAddress": "경기도 안양시 동안구 평촌동"
        }
      },
      "returnDeliveryDtos": [
        {
          "deliveryCompanyCode": "CJGLS",
          "deliveryInvoiceNo": ""
        }
      ],
      "orderDeliveryStatusLabel": "FINAL_DELIVERY",
      "exchangeStatusLabel": "PROGRESS",
      "referTypeLabel": "WEB_MOBILE",
      "faultTypeLabel": "VENDOR",
      "createdByTypeLabel": "CUSTOMER",
      "rejectable": false,
      "modifiedByTypeLabel": "CUSTOMER",
      "deliveryInvoiceModifiable": false,
      "successable": false
    },
    {
      "exchangeId": 101284720,
      "orderId": 3000013258427,
      "vendorId": "A00127960",
      "orderDeliveryStatusCode": "FINAL_DELIVERY",
      "exchangeStatus": "PROGRESS",
      "referType": "WEB_MOBILE",
      "faultType": "VENDOR",
      "exchangeAmount": 0,
      "reason": null,
      "reasonCode": "COMPOMISS",
      "reasonCodeText": "상품의 구성품, 부속품이 제대로 들어있지 않음",
      "reasonEtcDetail": "배송되지 않았어요 확인해주세요",
      "cancelReason": null,
      "createdByType": "CUSTOMER",
      "createdAt": "2018-03-08T16:42:11",
      "modifiedByType": "TRACKING",
      "modifiedAt": "2018-03-08T16:42:11",
      "exchangeItemDtoV1s": [
        {
          "exchangeItemId": 1784732,
          "orderItemId": 3288964806,
          "orderItemUnitPrice": 4900,
          "orderItemName": null,
          "orderPackageId": null,
          "orderPackageName": null,
          "targetItemId": 3288964806,
          "targetItemUnitPrice": 4900,
          "targetItemName": "펠릭스키즈 펠릭스 시그니쳐 맨투맨 FXMS178N3, 30 YELLOW, 100호",
          "targetPackageId": -1,
          "targetPackageName": "",
          "quantity": 1,
          "orderItemDeliveryComplete": null,
          "orderItemReturnComplete": null,
          "targetItemDeliveryComplete": null,
          "createdAt": "2018-03-08T16:42:11",
          "modifiedAt": "2018-03-08T16:42:11",
          "originalShipmentBoxId": 123456789012345679
        },
        {
          "exchangeItemId": 1784733,
          "orderItemId": 3288975565,
          "orderItemUnitPrice": 4900,
          "orderItemName": null,
          "orderPackageId": null,
          "orderPackageName": null,
          "targetItemId": 3288975565,
          "targetItemUnitPrice": 4900,
          "targetItemName": "펠릭스키즈 펠릭스 시그니쳐 맨투맨 FXMS178N3, 30 YELLOW, 120호",
          "targetPackageId": -1,
          "targetPackageName": "",
          "quantity": 1,
          "orderItemDeliveryComplete": null,
          "orderItemReturnComplete": null,
          "targetItemDeliveryComplete": null,
          "createdAt": "2018-03-08T16:42:11",
          "modifiedAt": "2018-03-08T16:42:11",
          "originalShipmentBoxId": 123456789012345677
        }
      ],
      "exchangeAddressDtoV1": {
        "exchangeAddressId": 1707458,
        "returnCustomerName": "김혜은",
        "returnAddressZipCode": "18488",
        "returnAddress": "경기도 화성시 동탄면 동탄대로9길 20",
        "returnAddressDetail": "Lh26단지 *",
        "returnPhone": null,
        "returnMobile": "010-****-****",
        "returnMemo": null,
        "deliveryCustomerName": "김**",
        "deliveryAddressZipCode": "18488",
        "deliveryAddress": "경기도 화성시 동탄면 동탄대로9길 20",
        "deliveryAddressDetail": "Lh26단지 *",
        "deliveryPhone": null,
        "deliveryMobile": "050382470825",
        "deliveryMemo": null,
        "createdAt": "2018-03-08T16:42:11",
        "modifiedAt": "2018-03-08T16:42:11",
        "exchangeId": 101284720
      },
      "deliveryInvoiceGroupDtos": [],
      "deliveryStatus": "BeforeDirection",
      "collectStatus": "Collecting",
      "collectCompleteDate": null,
      "collectInformationsDto": {
        "returnType": "EXCHANGE_RETURN",
        "expectedReturnDate": "2018-03-13T16:42:11",
        "returndeliveryItemDtos": [
          {
            "vendorItemId": 3288975565,
            "statusCode": "RETURN_SEND_READY",
            "returnCount": null,
            "releaseStatus": "RELEASED",
            "paymentReturnDeliveryMapId": 29829105,
            "paymentItemId": 1,
            "modifiedBy": "56373890",
            "moodifiedAt": "2018-03-08T16:42:11",
            "createdBy": "56373890",
            "createdAt": "2018-03-08T16:42:11",
            "count": 1,
            "confirmType": null,
            "collectStatus": "RETURN"
          },
          {
            "vendorItemId": 3288964806,
            "statusCode": "RETURN_SEND_READY",
            "returnCount": null,
            "releaseStatus": "RELEASED",
            "paymentReturnDeliveryMapId": 29829106,
            "paymentItemId": 1,
            "modifiedBy": "56373890",
            "moodifiedAt": "2018-03-08T16:42:11",
            "createdBy": "56373890",
            "createdAt": "2018-03-08T16:42:11",
            "count": 1,
            "confirmType": null,
            "collectStatus": "RETURN"
          }
        ],
        "returndeliveryDestinationDto": {
          "vendorZipCode": "312-14",
          "vendorPhone": "1899-6500",
          "vendorName": "(주)**몰)",
          "vendorMobile": "010-9203-8248",
          "vendorAddressDetail": "**물류센터 4층 이커머스BD",
          "vendorAddress": "충청남도 천안시 동남구 *()",
          "safetyNumberStatus": "ENABLE",
          "safetyNumberId": 247397194,
          "safetyNumber": "0502987****",
          "returnDeliveryId": null,
          "returnCenterCode": "1000274320",
          "receiptId": null,
          "orderedByMobile": null,
          "orderId": 3000013258427,
          "message": null,
          "customerZipCode": "18488",
          "customerPhone": "050382470825",
          "customerName": "김혜은",
          "customerMobile": "050382470825",
          "customerAddressDetail": "Lh26단지 ***",
          "customerAddress": "경기도 화성시 동탄면 동탄대로9길 20"
        }
      },
      "returnDeliveryDtos": [
        {
          "deliveryCompanyCode": "CJGLS",
          "deliveryInvoiceNo": ""
        }
      ],
      "orderDeliveryStatusLabel": "FINAL_DELIVERY",
      "exchangeStatusLabel": "PROGRESS",
      "referTypeLabel": "WEB_MOBILE",
      "faultTypeLabel": "VENDOR",
      "createdByTypeLabel": "CUSTOMER",
      "rejectable": false,
      "modifiedByTypeLabel": "CUSTOMER",
      "deliveryInvoiceModifiable": false,
      "successable": false
    }
  ],
  "nextToken": ""
}

Error Spec

HTTP status code (error type) Error message How to resolve
400 (check request parameter) error-message=createdAtTo - createdAtFrom should less then 7day.

Check if the query range is 7 days or less.
400 (check request parameter) createdAtFrom format should be yyyy-MM-ddTHH:mm:ss.

Check if the entry format of search start date/time is yyyy-MM-ddTHH:mm:ss. 

 
400 (check request parameter) The vendorId in path or requestBody doesn't match the one got from api-gateway.

Check if vendorId (seller ID) is correct.  
400 (check request parameter) start time should early or equals to end time

Check if the search end date/time is earlier than the start date/time.

URL API Name

GET_EXCHANGE_REQUEST