Skip to content

UpdateManualOrder

Use this api to update manual order.

POST /openapi/order/v1/update-manual-order

Request Parameters

Parameter Type Required Description
id string true Ginee Order Id
externalOrderSn string true Order number by customer
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
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
deleteOrderItemIds Array(String) true Array of String, customer delete the order item, ginee order item id
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
id string true Ginee order item id
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
id string true Ginee ShippingAddress item id
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
id string true senderAddress Id
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
logisticsTrackingNumber string false logisticsTrackingNumber

OrderPayRecord

Parameter Type Required Description
payAtDatetime string false payAtDatetime
payAmount string false payAmount
paySerialNumber string false paySerialNumber
id string true ginee OrderPayRecord id

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": "158117099789152",
"customerName": "15811709978",
"customerMobile": "+6215811709978",
"customerEmail": "15811709978@qq.com",
"logisticsInfos": [{
    "logisticsProviderName": "J&T Express_ID",
    "logisticsTrackingNumber": "15811709978"
}],
"noteByBuyer": "15811709978",
"mobileCountry": "ID",
"shippingAddress": {
    "id":"SA3456789034542",
    "name": "15811709978",
    "phoneNumber": "+6215811709978",
    "area": ["Indonesia", "Bali", "Buleleng", "Sawan"],
    "zipCode": "15811709978",
    "fullAddress": "15811709978",
    "id": "OAI633198D659080100011926EB",
    "mobileCountry": "ID",
    "country": "Indonesia",
    "province": "Bali",
    "city": "Buleleng",
    "district": "Sawan"
},
"senderAddress":{
    "id":"SA3456789034542",
    "name": "15811709978",
    "phoneNumber": "+6215811709978",
    "zipCode": "15811709978",
    "fullAddress": "15811709978",
    "country": "Indonesia",
    "province": "Bali",
    "city": "Buleleng",
    "district": "Sawan"
},
"orderItems": [{
    "sku": "test-accurate99",
    "id": "OI633198D659080100011926E8",
    "warehouseId": "WW6087C4E01283940001C1D4AF",
    "warehouseName": "DefaultWarehouse",
    "warehouseCode": "",
    "weight": 4,
    "actualPrice": 11,
    "quantity": 1
}],
"orderPayment": {
    "totalShippingFee": 1,
    "totalDiscounts": 1,
    "taxationFee": 1,
    "insuranceFee": 1,
    "serviceFee": 1,
    "commissionFee": 1,
    "currency": "IDR"
},
"payAmount": 1,
"payAtDatetime": "2022-09-20T16:00:01.000Z",
"paymentMethod": "PREPAY",
"payRecords": [{
    "paySerialNumber": "15811709978",
    "id": "OPR633198D659080100011926EC"
}],
"noteBySeller": "15811709978",
"deleteOrderItemIds": [],
"id": "SO633198D659080100011926E6"

    }' \
"{Ginee Host}/openapi/order/v1/update-manual-order

Success

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

Failure

{
    "code": "CHANNEL_NOT_SUPPORT",
    "message": "This order operation channel does not support",
    "data": "SO5F609DC052FAFF000134FC62",
    "extra": null,
    "pricingStrategy": "FREE"
}

Note

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