PO list query (paging by day)

You can query the PO List by day through paging. ex) from 2020-02-01 to 2020-02-02

You can adjust the size of the rows per page by using the maxPerPage parameter, and set Next Page with [nextToken]. Except for some parts of the Path Parameter, the overall structure is similar to that of the How to query PO List (by Minute).

※ Customers may change their delivery address at the Payment Completed stage. Therefore, you MUST UPDATE the delivery shipping info ("receiver") after confirming that the product is at "Preparation" stage. (We recommend using Single Order query API for it).

※ Timeout errors may occur during Order List querying when the order volume is huge. Please check [How to deal with Timeout errors] and increase the timeout period accordingly.

※ Return Complete cases are not viewed on the Order List. Please use "return/cancellation list query" API instead.

Please check if "sellerProductName + sellerProductItemName" matches "vendorItemName" on the Coupang website before the product is shipped out.
If the product is exposed with the wrong information such as its compartments, quantity, volume, etc, please hold the shipping and submit an online inquiry for quick correction. (My product is displayed with wrong information, > select 'Yes' and request.)
The reflected seller score will be reinstated accordingly in the event that an incorrect display of your product is confirmed.

Path

GET

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

Example Endpoint

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/ordersheets?createdAtFrom=2017-10-10&createdAtTo=2017-10-11&maxPerPage=2&status=INSTRUCT

Request Parameters

Path Segment Parameter

Name				Required	Type	Description
vendorId				O	String	vendor ID unique code for a seller issued by Coupang ex) A00012345

Query String Parameter

Name

Required

Type

Description

createdAtFrom

String

Query start date

Write in the query start date in the form of "yyyy-mm-dd"
ex) 2018-07-01

createdAtTo

String

Query end date

Write in the query end date in the form of "yyyy-mm-dd"
ex) 2018-07-31

You can query up to 31 days.

status

String

PO Status

Parameter Name	Status
ACCEPT	Payment completed
INSTRUCT	Product in preparation
DEPARTURE	Shipment commenced
DELIVERING	In transit
FINAL_DELIVERY	Delivery completed
NONE_TRACKING	Seller to ship out the product directly (or delivery system is not integrated with Coupang's); tracking not available

nextToken

String

Token value to query Next page.

This value is not necessary for querying the first page.

You can request up to 50 per page. To query the next page and after, use [nextToken].

maxPerPage

Number

Maximum query request value per page

default = 50

searchType

String

search type for order sheets results

"searchType=timeFrame" calls PO List query (by Minute). Other than that, PO List query (paging by day) is the default.

Request Example

not require body

Response Message

Name

Type

Description

code

Number

server response code

message

String

server response message

data

Array

result list

the list will return blank when there is no result

shipmentBoxId

Number

shipment No. (bundled shipment No.)

orderId

Number

order No.

orderedAt

String

order date/time

yyyy-MM-dd'T'HH:mm:ss

orderer

Object

info of the orderer

name

String

Name of the orderer

String

e-mail address of the orderer

non-use/empty value("")

safeNumber

String

contact info of the receiver (safety number)

ordererNumber

String

contact info of the orderer (actual phone number)

null

paidAt

String

Date of payment completed

yyyy-MM-dd'T'HH:mm:ss

status

String

PO Status

Parameter Name	Status
ACCEPT	Payment completed
INSTRUCT	Product in preparation
DEPARTURE	Shipment commenced
DELIVERING	In transit
FINAL_DELIVERY	Delivery completed
NONE_TRACKING	Seller to ship out the product directly (or delivery system is not integrated with Coupang's); tracking not available

shippingPrice

Number

shipping fee

remotePrice

Number

shipping fees for highlands and islands

remoteArea

Boolean

check if the delivery address is in the highlands or islands

parcelPrintMessage

String

shipping message

optional

splitShipping

Boolean

split shipping or not

ableSplitShipping

Boolean

split shipping possible or not possible

receiver

Object

name

String

Name of the receiver

safeNumber

String

contact info of the receiver (safety number)

receiverNumber

String

contact info of the receiver (actual phone number)

null

addr1

String

receiver's delivery address 1

addr2

String

receiver's delivery address 2

postCode

String

receiver's Post code

orderItems

Array

Items to deliver

vendorItemPackageId

Number

vendorItemPackageId

for non-use/null, it will return 0

vendorItemPackageName

String

vendorItemPackageName

non-use

productId

Number

Displayed productId

for optional/null, it will return 0

vendorItemId

Number

vendorItemId

vendorItemName

String

Displayed product name

shippingCount

Number

shippingCount = number of items upon ordering
holdCountForCancel = number of items whose orders got cancelled and wait for refund
cancelCount = confirmed number of items for cancellation
number of items available for PO placement = shippingCount - (holdCountForCancel + cancelCount )

salesPrice

Number

price per item

orderPrice

Number

payment amounts: salesPrice*shippingCount

discountPrice

Number

total discount amounts,
discountPrice(total discounts) =
instantCouponDiscount(instant discount coupon) +
downloadableCoupon(downloadable coupon) +
coupangDiscount(Coupang funded discounts)

instantCouponDiscount

Number

instant discount coupon

instant discount coupon amounts

downloadableCouponDiscount

Number

downloadable coupon

downloadable coupon amounts

coupangDiscount

Number

Coupang funded discounts

Coupang funded cart/category coupon etc. amounts

externalVendorSkuCode

String

external item code

optional

etcInfoHeader

String

option input per item

optional

etcInfoValue

String

input value by the user for options per item

optional

The field exists but without any value. If necessary, please us below etcInfoValues.

etcInfoValues

Array

List of input value by the user for options per item

optional

This query is supported by Version 4 only.

sellerProductId

Number

Seller product ID

sellerProductName

String

Registered product name

sellerProductItemName

String

Option name as registered

firstSellerProductItemName

String

Originally registered option name

cancelCount

Number

number of orders got cancelled

holdCountForCancel

Number

number of orders waiting for refund

estimatedShippingDate

String

expected shipping date upon receiving order
(shipping date for split shipment)

optional / yyyy-mm-dd

plannedShippingDate

String

actual planned shipping date (for split shipment)

optional / yyyy-mm-dd

invoiceNumberUploadDate

String

Invoice No. upload date

optional / yyyy-MM-dd'T'HH:mm:ss

extraProperties

Object

Additional option info for seller item

optional / key: value type

pricingBadge

Boolean

is the item price is the lowest?

true/false

usedProduct

Boolean

is it a used item?

true/false

confirmDate

String

date of purchase confirmed

yyyy-MM-dd HH:mm:ss

deliveryChargeTypeName

String

delivery charge type:

not-free, free

upBundleVendorItemId

Number

upbundle option ID

upBundleVendorItemName

String

upbundle display product name

upBundleSize

Number

upbundle count

upBundleItem

Boolean

upbundle item or not
true/false

canceled

Boolean

is the order cancelled?

true/false

overseaShippingInfoDto

Object

overseas delivery info

optional

personalCustomsClearanceCode

String

Personal Customs Clearance Code

optional

orderersSsn

String

Not in use

optional

ordererPhoneNumber

String

Orderer's phone number

deliveryCompanyName

String

Courier companies

CJ Logistics, Hanjin Express, etc.

invoiceNumber

String

Invoice No.

inTrasitDateTime

String

shipment date (shipped-out date)

yyyy-MM-dd HH:mm:ss

deliveredDate

String

delivery-completed date

yyyy-MM-dd HH:mm:ss

refer

String

Payment was made on:

Apps on iPhone, Android or PC/Mobile web page.

shipmentType

String

shipment type

THIRD_PARTY, CGF, CGF LITE

nextToken

String

token value required to send request for next page

It will return null if the current page is the last page.

Response Example


{
  "code": 200,
  "message": "OK",
  "data": [

    {
      "shipmentBoxId": 64253897***6401429,
      "orderId": 9100041863244,
      "orderedAt": "2024-04-08T22:54:46",
      "orderer": {
        "name": "이*주",
        "email": "",
        "safeNumber": "0502-4***-3501",
        "ordererNumber": null
      },
      "paidAt": "2024-04-08T22:54:56",
      "status": "FINAL_DELIVERY",
      "shippingPrice": 0,
      "remotePrice": 0,
      "remoteArea": false,
      "parcelPrintMessage": "문 앞",
      "splitShipping": false,
      "ableSplitShipping": false,
      "receiver": {
        "name": "이*주",
        "safeNumber": "0502-4***-3501",
        "receiverNumber": null,
        "addr1": "***",
        "addr2": "***",
        "postCode": "***84"
      },
      "orderItems": [
        {
          "vendorItemPackageId": 0,
          "vendorItemPackageName": "신서리티 델타 구운 캐슈넛",
          "productId": 7313251147,
          "vendorItemId": 85872453655,
          "vendorItemName": "신서리티 델타 구운 캐슈넛, 5개, 160g",
          "shippingCount": 1,
          "salesPrice": 41000,
          "orderPrice": 41000,
          "discountPrice": 0,
          "instantCouponDiscount": 0,
          "downloadableCouponDiscount": 0,
          "coupangDiscount": 0,
          "externalVendorSkuCode": "",
          "etcInfoHeader": null,
          "etcInfoValue": null,
          "etcInfoValues": null,
          "sellerProductId": 14091699106,
          "sellerProductName": "신서리티 델타 구운 캐슈넛 160g",
          "sellerProductItemName": "1개 160g",
          "firstSellerProductItemName": "1개 160g",
          "cancelCount": 0,
          "holdCountForCancel": 0,
          "estimatedShippingDate": "2024-04-09",
          "plannedShippingDate": "",
          "invoiceNumberUploadDate": "2024-04-09T19:15:38",
          "extraProperties": {
            
          },
          "pricingBadge": false,
          "usedProduct": false,
          "confirmDate": null,
          "deliveryChargeTypeName": "무료",
          "upBundleVendorItemId": 88049657337,
          "upBundleVendorItemName": "신서리티 델타 구운 캐슈넛, 5개, 160g",
          "upBundleSize": 5,
          "upBundleItem": true,
          "canceled": false
        }
      ],
      "overseaShippingInfoDto": {
        "personalCustomsClearanceCode": "",
        "ordererSsn": "",
        "ordererPhoneNumber": ""
      },
      "deliveryCompanyName": "로젠택배",
      "invoiceNumber": "***00402083",
      "inTrasitDateTime": "2024-04-09 22:41:00",
      "deliveredDate": "2024-04-11 09:57:00",
      "refer": "안드로이드앱",
      "shipmentType": "THIRD_PARTY"
    },
    {
      "shipmentBoxId": 64253897***6401428,
      "orderId": 4100042183223,
      "orderedAt": "2024-04-09T13:02:02",
      "orderer": {
        "name": "류*영",
        "email": "st*****@na",
        "safeNumber": "0502-4***-5824",
        "ordererNumber": null
      },
      "paidAt": "2024-04-09T13:02:11",
      "status": "FINAL_DELIVERY",
      "shippingPrice": 0,
      "remotePrice": 0,
      "remoteArea": false,
      "parcelPrintMessage": "직접 받고 부재 시 문 앞",
      "splitShipping": false,
      "ableSplitShipping": false,
      "receiver": {
        "name": "류*영",
        "safeNumber": "0502-41***-5824",
        "receiverNumber": null,
        "addr1": "***",
        "addr2": "***",
        "postCode": "1***3"
      },
      "orderItems": [
        {
          "vendorItemPackageId": 0,
          "vendorItemPackageName": "신서리티 캘리포니아 레몬과즙 파우더 150g",
          "productId": 6875929180,
          "vendorItemId": 83653589505,
          "vendorItemName": "신서리티 미국산 레몬 가루 150g x 3개",
          "shippingCount": 1,
          "salesPrice": 40400,
          "orderPrice": 40400,
          "discountPrice": 0,
          "instantCouponDiscount": 0,
          "downloadableCouponDiscount": 0,
          "coupangDiscount": 0,
          "externalVendorSkuCode": "",
          "etcInfoHeader": null,
          "etcInfoValue": null,
          "etcInfoValues": null,
          "sellerProductId": 13653570850,
          "sellerProductName": "신서리티 미국산 레몬 가루 150g x 3개",
          "sellerProductItemName": "3개 150g",
          "firstSellerProductItemName": "3개 150g",
          "cancelCount": 0,
          "holdCountForCancel": 0,
          "estimatedShippingDate": "2024-04-11",
          "plannedShippingDate": "",
          "invoiceNumberUploadDate": "2024-04-09T19:15:36",
          "extraProperties": {
            
          },
          "pricingBadge": false,
          "usedProduct": false,
          "confirmDate": null,
          "deliveryChargeTypeName": "무료",
          "upBundleVendorItemId": null,
          "upBundleVendorItemName": null,
          "upBundleSize": null,
          "upBundleItem": false,
          "canceled": false
        }
      ],
      "overseaShippingInfoDto": {
        "personalCustomsClearanceCode": "",
        "ordererSsn": "",
        "ordererPhoneNumber": ""
      },
      "deliveryCompanyName": "로젠택배",
      "invoiceNumber": "***11719925",
      "inTrasitDateTime": "2024-04-09 22:40:00",
      "deliveredDate": "2024-04-11 16:11:00",
      "refer": "안드로이드앱",
      "shipmentType": "THIRD_PARTY"
    }
  ],
  "nextToken": "448537989"
}

Error Spec

HTTP status code(error type)	error message	solution
400 ( check parameter requested)	Invalid vendor ID	Please check if you input accurate seller ID (vendor ID). ex) A00012345
400 ( check parameter requested)	endTime-startTime range should less than31.	Please check if the query period is set as 31 days or fewer.

URL API Name

GET_ORDERSHEET

OPENAPI 관련 안내

Articles in this section

Path

Example Endpoint

Request Parameters

Path Segment Parameter

Query String Parameter

Request Example

Response Message

Response Example

Error Spec

URL API Name

OPENAPI 관련 안내

Articles in this section

Path

Example Endpoint

Request Parameters

Path Segment Parameter

Query String Parameter

Request Example

Response Message

Response Example

Error Spec

URL API Name

Related articles