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 |
customerName |
customerEmail |
string |
true |
customerEmail |
customerMobile |
string |
true |
customerMobile |
paymentMethod |
string |
true |
PREPAY / COD |
payAmount |
string |
true |
payAmount |
payAtDatetime |
string |
true |
payAtDatetime |
orderItems |
Array(OrderItem) |
true |
Array of object, please refer to OrderItem for details |
shippingAddress |
ShippingAddress |
true |
Array of object, please refer to ShippingAddress for details |
senderAddress |
senderAddress |
false |
Array of object, please refer to senderAddress for details |
logisticsInfos |
Array(LogisticsInfos) |
true |
Array of object, please refer to LogisticsInfos for details |
payRecords |
Array(OrderPayRecord) |
true |
Array of object, please refer to OrderPayRecord for details |
orderPayment |
OrderPayment |
true |
Array of object, please refer to OrderPayment for details |
noteByBuyer |
string |
false |
noteByBuyer |
noteBySeller |
string |
false |
noteBySeller |
OrderItem¶
Parameter | Type | Required | Description |
---|---|---|---|
quantity |
string |
true |
quantity |
actualPrice |
string |
true |
actualPrice |
sku |
string |
true |
sku |
warehouseId |
string |
true |
warehouseId |
warehouseName |
string |
true |
warehouseName |
warehouseCode |
string |
true |
warehouseCode |
weight |
string |
false |
weight |
ShippingAddress¶
Parameter | Type | Required | Description |
---|---|---|---|
name |
string |
true |
name |
phoneNumber |
string |
true |
phoneNumber |
country |
string |
true |
country |
province |
string |
true |
province |
city |
string |
true |
city |
district |
string |
false |
district |
zipCode |
string |
false |
zipCode |
fullAddress |
string |
false |
fullAddress |
senderAddress¶
Parameter | Type | Required | Description |
---|---|---|---|
name |
string |
true |
name |
phoneNumber |
string |
true |
phoneNumber |
country |
string |
true |
country |
province |
string |
true |
province |
city |
string |
true |
city |
district |
string |
false |
district |
zipCode |
string |
false |
zipCode |
fullAddress |
string |
false |
fullAddress |
LogisticsInfos¶
Parameter | Type | Required | Description |
---|---|---|---|
logisticsProviderName |
string |
true |
logisticsProviderName,Using the name field returned by the GetLogisticsList api |
logisticsTrackingNumber |
string |
false |
logisticsTrackingNumber |
OrderPayRecord¶
Parameter | Type | Required | Description |
---|---|---|---|
payAtDatetime |
string |
false |
payAtDatetime |
payAmount |
string |
false |
payAmount |
paySerialNumber |
string |
false |
paySerialNumber |
OrderPayment¶
Parameter | Type | Required | Description |
---|---|---|---|
paySerialNumber |
string |
ture |
paySerialNumber |
totalDiscounts |
string |
ture |
totalDiscounts |
taxationFee |
string |
ture |
taxationFee |
insuranceFee |
string |
ture |
insuranceFee |
currency |
string |
ture |
currency |
commissionFee |
string |
ture |
commissionFee |
serviceFee |
string |
ture |
serviceFee |
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": [
{
"paySerialNumber": "15811709978"
}
],
"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.