coupang
POST/v2/providers/openapi/apis/api/v1/vendors/{vendorId}/label/printOrderLabel2609170000

CGF Lite order Label API

# 01

Summary

CGF Lite order Label API

# 02

Details

This API is used to print order label, now it only support cgf lite order which status is B(Processing) or C(shipped)

Path

POST/v2/providers/openapi/apis/api/v1/vendors/{vendorId}/label/printOrderLabel

Example endpoint

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v1/vendors/A1234567890/label/printOrderLabel
# 03

Path parameters

NameTypeDescription
vendorId*string
Vendor ID

Unique code Coupang issues to vendors
e.g. A00012345
# 04

Request body

Request parameters

Body parameter

NameTypeDescription
orderIdList*object[]
orderId list, max size is 10
templateName*string
templateName.
there are two templateNames: SIXTY_FORTY_MM, SIXTY_THIRTY_MM
SIXTY_FORTY_MM means label size is 6040 mm
SIXTY_THIRTY_MM means label size is 60
30 mm
quantity*integer
how many duplicate copies need to be printed
max quantity is 10
Request exampleapplication/json
{
  "orderIdList": [
    10000120670440,
    20000120391907,
    6000121622041,
    22000121025601
  ],
  "templateName": "SIXTY_FORTY_MM",
  "quantity": 2
}
# 05

Response body

Response message

NameTypeDescription
codeinteger
Server response code
messagestring
Server response message
datastring
pdf file of label content, the format is base64

Response Example

{
  "code": 200,
  "message": "SUCCESS",
  "data": "base64 content"
}
# 06

Error codes

HTTPCodeMessage
--