CreateManualOrder

Use this api to create manual order.

POST /openapi/order/v1/create-manual-order

Request Parameters

Parameter	Type	Required	Description
externalOrderSn	string	true	Order number by customer
shopId	string	true	Manual Shop ID (new)
customerName	string	true	Customer name
customerEmail	string	true	Customer email
customerMobile	string	true	Customer mobile
paymentMethod	string	true	PREPAY / COD
payAmount	decimal	true	Pay amount
payAtDatetime	UTC timestamp	true	Payment time
orderItems	array(object)	true	Array of object, please refer to Order Item for details
shippingAddress	object	true	Shipping address, please refer to Shipping Address for details
senderAddress	object	false	Sender address, please refer to Sender Address for details
logisticsInfos	array(object)	true	Logistics info, please refer to Logistics Infos for details
payRecords	array(object)	true	Array of object, please refer to Order Pay Record for details
orderPayment	object	true	Order payment information, please refer to Order Payment for details
noteByBuyer	string	false	Note by buyer
noteBySeller	string	false	Note by seller

Order Item

Parameter	Type	Required	Description
quantity	int	true	Quantity
actualPrice	deciaml	true	Actual price
sku	string	true	Sku
warehouseId	string	true	Warehouse id
weight	int	false	Weight

Shipping Address

Parameter	Type	Required	Description
name	string	true	Name
phoneNumber	string	true	Phone number
country	string	true	Country
province	string	true	Province
city	string	true	City
district	string	false	District
zipCode	string	false	Zip code
fullAddress	string	false	Full address

sender Address

Parameter	Type	Required	Description
name	string	true	Name
phoneNumber	string	true	Phone number
country	string	true	Country
province	string	true	Province
city	string	true	City
district	string	false	District
zipCode	string	false	Zip code
fullAddress	string	false	Full address

Logistics Infos

Parameter	Type	Required	Description
logisticsProviderName	string	true	Logistics provider name,Using the name field returned by the GetLogisticsList api
logisticsTrackingNumber	string	false	Logistics tracking number

Order Pay Record

Parameter	Type	Required	Description
payAtDatetime	UTC timestamp	true	Payment datetime
payAmount	decimal	true	Pay amount
paymentMethod	string	true	PREPAY / COD
paySerialNumber	string	false	Pay serial number
payAccountNumber	string	false	Pay account number
receiptAccountNumber	string	false	Receipt account number
payRecordNote	string	false	Note

Order Payment

Parameter	Type	Required	Description
paySerialNumber	string	ture	Pay serial number
totalDiscounts	decimal	ture	total discounts
taxationFee	decimal	ture	Taxation fee
insuranceFee	decimal	ture	InsuranceFee
currency	string	ture	Currency
commissionFee	decimal	ture	Commission fee
serviceFee	decimal	ture	Service fee

Response Parameters

Name	Type	Description
orderId	string	Ginee Order Id

Request Example

Example

curl -X POST  \
-H "X-Advai-Country: ID" \
-H "Authorization: {Your Access Key} + ':' + signature" \
-H "Content-Type: application/json" \
-d '{
        "externalOrderSn": "1581170997816",
        "customerName": "15811709978",
        "customerMobile": "+6215811709978",
        "customerEmail": "15811709978@qq.com",
        "logisticsInfos": [
            {
                "logisticsProviderName": "Ninja Van ID Express",
                "logisticsTrackingNumber": ""
            }
        ],
        "noteByBuyer": "15811709978",
        "mobileCountry": "ID",
        "shippingAddress": {
            "name": "15811709978",
            "phoneNumber": "+6215811709978",
            "area": [
                "Indonesia",
                "Bali",
                "Buleleng",
                "Sawan"
            ],
            "zipCode": "15811709978",
            "fullAddress": "15811709978",
            "id": "OAI633055A95908010001C4005E",
            "mobileCountry": "ID",
            "country": "Indonesia",
            "province": "Bali",
            "city": "Buleleng",
            "district": "Sawan"
        },
        "senderAddress": {
            "name": "15811709978",
            "phoneNumber": "+6215811709978",
            "zipCode": "15811709978",
            "fullAddress": "15811709978",
            "country": "Indonesia",
            "province": "Bali",
            "city": "Buleleng",
            "district": "Sawan"
        },
        "orderItems": [
            {
                "sku": "shipper_test-20220329-1",
                "id": "OI633055A95908010001C4005B",
                "warehouseId": "WW6238569FCFF47E00015DDC56",
                "warehouseName": "WH-TGR04+GINEEERP",
                "warehouseCode": "",
                "weight": 4,
                "actualPrice": 11,
                "quantity": 1000
            }
        ],
        "orderPayment": {
            "totalShippingFee": 1,
            "totalDiscounts": 1,
            "taxationFee": 1,
            "insuranceFee": 1,
            "serviceFee": 11,
            "commissionFee": 1,
            "currency": "IDR"
        },
        "payAmount": 1,
        "payAtDatetime": "2022-09-20T16:00:01.000Z",
        "paymentMethod": "PREPAY",
        "payRecords": [
            {
                "payAtDatetime": "2024-03-31T03:55:28.669Z",
                "payAmount": "3000",
                "paymentMethod": "PREPAY",
                "paySerialNumber": "15811709978",
                "payAccountNumber": "VB1234567890"
                "receiptAccountNumber": "VB1234567890"
                "payRecordNote": "Fully paid"
            }
        ],
        "noteBySeller": "15811709978"
    }' \
"{Ginee Host}/openapi/order/v1/create-manual-order

Success

   {
       "code":"SUCCESS",
       "message":"OK",
       "data": "SO6125178AF4428A0001DABC8F",
       "extra":null,
       "transactionId":"f49f370af5805764"
   }

Failure

{
    "code":"PARAMETER_ERROR",
    "message":"shopId not is null",
    "data":null,
    "extra":null,
    "transactionId":"0bed3cb743305d1b"
}

Note

You need to check the code to see if the operation was successful. If failed, see message for detail reason.