UpdateManualOrder¶

Use this api to update manual order.Only support orders with PAID,PENDING_PAYMENT,PARTIALLY_PAID status.

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`	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)`	`false`	Logistics info, please refer to Logistics Infos for details
`deleteOrderItemIds`	`array(string)`	`false`	Array of String, customer delete the order item, ginee order item id
`orderPayment`	`object`	`false`	Order payment information, please refer to Order Payment for details
`orderPayRecord`	`object`	`false`	Payment records, please refer to Order Pay Record for details
`noteByBuyer`	`string`	`false`	Note by buyer
`noteBySeller`	`string`	`false`	Note by seller

Order Item¶

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`	Warehouse id
`weight`	`string`	`false`	Weight

Shipping Address¶

Parameter	Type	Required	Description
`id`	`string`	`true`	Ginee ShippingAddress item id
`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
`id`	`string`	`true`	Ginee sender address id
`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
`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": "158117099789152",
        "customerName": "15811709978",
        "customerMobile": "+6215811709978",
        "customerEmail": "15811709978@qq.com",
        "logisticsInfos": [
            {
                "logisticsProviderName": "J&T Express_ID",
                "logisticsTrackingNumber": "15811709978"
            }
        ],
        "noteByBuyer": "15811709978",
        "mobileCountry": "ID",
        "shippingAddress": {
            "id": "OAI633198D659080100011926EB",
            "name": "15811709978",
            "phoneNumber": "+6215811709978",
            "area": [
                "Indonesia",
                "Bali",
                "Buleleng",
                "Sawan"
            ],
            "zipCode": "15811709978",
            "fullAddress": "15811709978",
            "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": [
            {
                "payAtDatetime": "2024-03-31T03:55:28.669Z",
                "payAmount": "3000",
                "paymentMethod": "PREPAY",
                "paySerialNumber": "15811709978",
                "payAccountNumber": "VB1234567890"
                "receiptAccountNumber": "VB1234567890"
                "payRecordNote": "Fully paid"
            }
        ],
        "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.