You can register new orders in the Realpacking system.

Headers

Name	Required/Optional	Type	Description	Notes
Authorization	Required	string	API authentication key	Authorization: Bearer your-api-key

The API authorization key is the API key created in [Web Admin > Workspace > Settings > API Key].
You must add 'Bearer ' in front of the API key to ensure proper authentication processing. | | Version | Required | string | API version | Version: 2025-01-09
You must specify the correct version to use the API. |

Request Body

Name	Required/Optional	Type	Description	Notes
videoCode	Required	string	Recorded Video No.
ordererName	Required	string	Orderer Name
ordererMobileNo	Required	string	Orderer Mobile Phone No.	E.164 Format
orderedDate	Required	string	Purchase date	Y-m-d Format: ISO8601
shopName	Optional	string	Source Name(Shopping Mall)
orderNo	Optional	string	Order No.
ordererPhoneNo	Optional	string	Orderer Phone No.	E.164 Format
ordererEmail	Optional	string	Orderer Email
receiverName	Optional	string	Receiver Name
receiverMobileNo	Optional	string	Receiver Mobile Phone No.	E.164 Format
receiverPhoneNo	Optional	string	Receiver Phone No.	E.164 Format
receiverZipcode	Optional	string	Receiver ZIP Code
receiverAddress	Optional	string	Receiver Address
receiverAddress2	Optional	string	Receiver Detailed Address
totalPrice	Optional	integer	Total payment amount
memo	Optional	string	User Memo
providerCode	Optional	string	Shipper Code
product	Optional	map[]	Goods information array	Required for use of Inspection Mode feature
product[i].productCode	Optional	string	Goods unique code	Required for use of Inspection Mode feature
product[i].productName	Optional	string	Goods name	Required for use of Inspection Mode feature
product[i].productQty	Optional	integer	Goods quantity	Required for use of Inspection Mode feature
product[i].courier	Optional	string	Goods Delivery Company
product[i].waybill	Optional	string	Goods waybill

Request Body Example

If you're sending only required data

{
    "videoCode": "202312150951",
    "ordererName": "Orderer1",
    "ordererMobileNo": "+821011112222",
    "orderedDate": "2023-12-14"
}

When sending product information data together

{
    "videoCode": "202312150952",
    "ordererName": "orderer2",
    "ordererMobileNo": "+821022223333",
    "orderedDate": "2023-12-14",
    "shopName": "amazon",
    "orderNo": "orderno123456789",
    "ordererPhoneNo": "+82321111111",
    "ordererEmail": "[email protected]",
    "receiverName": "receiver",
    "receiverMobileNo": "+821022223333",
    "receiverPhoneNo": "032-111-1111",
    "receiverZipcode": "01234",
    "receiverAddress": "Seoul Mapo District",
    "receiverAddress2": " 147 Street",
    "totalPrice": 100000,
    "memo": "hello world",
    "providerCode": "10",
    "product": [
        {
            "productCode": "productcode0",
            "productName" : "hat",
            "productQty": 1,
            "courier": "UPS",
            "waybill": "123456789"
        }, 
        {
            "productCode": "productcode1",
            "productName" : "shoe",
            "productQty": 2,
            "courier": "Fedex",
            "waybill": "123456789"
        }
    ]
}

Response

Success

201 Created: If the order is registered

Name	Required/Optional	Type	Description	Notes
message	Required	string	http status message
data	Required	string	Result data	Video Recording No. with order creation completed

Response Example

{
    "message": "Created",
    "data": "202312150951"
}

Error

401 Unauthorized: If you don't have permission to access that API

{
    "message": "you are unauthorized for the requested API service"
}

400 Bad Request: If the API Version value in the header is missing or incorrect