Single PO query (using shipmentBoxId)

API to query single PO using shipmentBoxId

※ 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.

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/{shipmentBoxId}

Example Endpoint

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00000001/ordersheets/642538970006401429

Request Parameters

Path Segment Parameter

Name					Required	Type	Description
vendorId					O		vendor code unique code for a seller issued by Coupang Log in to Wing to check your vendor code
shipmentBoxId					O		Shipment No. (bundled shipment No.) View on Wing or query through PO List by minute/day. shipmentBoxId is numerical

Request Example

not require body

Response Message

Name

Type

Description

code

Number

server response code

message

String

server response message

data

Object

shipmentBoxId

Number

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/time of payment completed

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

status

String

PO Status

STATUS	MEANING
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

splitShipping

Boolean

split shipping or not

ableSplitShipping

Boolean

split shipping possible or not possible

receiver

Object

info of the receiver

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

order info

vendorItemPackageId

Number

vendorItemPackageId

for non-use/null, it will return 0

vendorItemPackageName

String

vendorItemPackageName

non-use

productId

Number

Displayed productID

for null, it will return 0

vendorItemId

Number

vendor item ID

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

etcInfoHeader

String

option input per item

optional

etcInfoValue

String

input value by the user for options per item

optional

Not in use

etcInfoValues

Array

List of input value by the user for options per item

optional

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

yyyy-MM-dd

plannedShippingDate

String

actual planned shipping date (for split shipment)

yyyy-MM-dd

invoiceNumberUploadDate

String

Invoice No. upload date

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

extraProperties

Object

Additional option info for seller item

key:value type

pricingBadge

Boolean

Courantee (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 displayed 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

personalCustomsClearanceCode

String

Personal Customs Clearance Code

orderersSsn

String

Not in use

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

Response Example


{
  "code": 200,
  "message": "OK",
  "data": 
    {
      "shipmentBoxId": 64253897***6401429,
      "orderId": 9100041863244,
      "orderedAt": "2024-04-08T22:54:46",
      "orderer": {
        "name": "이*주",
        "email": "",
        "safeNumber": "0502-***6-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-***6-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"
    }
}

Error Spec

HTTP status code(error type)	error message	solution
400 (check parameter requested)	The order got cancelled or returned.	Check if the order is cancelled or returned using Return/Cancellation Request List query API. Ensure the order in question not to be called again.
400 (check parameter requested)	Invalid vendor ID	Please check if you input accurate seller ID (vendor ID). ex) A00012345

URL API Name

GET_ORDERSHEET_BY_SHIPMENTBOX

OPENAPI 관련 안내

Articles in this section

Path

Example Endpoint

Request Parameters

Path Segment 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

Request Example

Response Message

Response Example

Error Spec

URL API Name

Related articles