GetOrderDetailV2

Use this api to get order detail.

POST /openapi/order/v2/get

Request Parameters

Parameter	Type	Required	Description
orderId	string	false	Order id in Ginee，Maximum 100
historicalData	boolean	false	Whether it is historical data, if it is more than 3 months from the current time, it is historical data and the value should be true, if it is within 3 months, it is not historical data and can be ignored, default false

Response Parameters

Note

The response body of detail API is extended from the response parameters of ListOrder

Name	Type	Description
orderId	string	order id in Ginee
channel	string	Please refer to Ginee Channel for details
purchasedOn	string	Purchased on which platforms (for Tokopedia Shop Platform)
shopId	string	shop id in Ginee
orderType	string	Please refer to Order Type for details
orderStatus	string	Please refer to Order Status for details
country	string	Please refer to Order Status for details
currency	string	currency
totalAmount	decimal	order total amount
paymentMethod	string	Payment method
payAt	UTC timestamp	Order pay time
promisedToShipBefore	UTC timestamp	promised to ship before
createAt	UTC timestamp	Order create time
closeAt	UTC timestamp	Order Complete time
lastUpdateAt	UTC timestamp	Order last update time
externalShopId	string	Channel shop id
externalOrderId	string	Channel order id
externalOrderSn	string	Channel order sn
externalOrderStatus	string	Channel order status
externalCreateAt	UTC timestamp	Channel order create time
externalUpdateAt	UTC timestamp	Channel order update time
customerInfo	object	see Customer Info
paymentInfo	object	see Payment Info
shippingAddressInfo	object	see Address Info
senderAddressInfo	object	see Address Info
billingAddressInfo	object	see Address Info
items	object	see Order Item
logisticsInfos	array	A array contains logistics informations, see Logistics Info
cancelInfo	object	see Cancel Info
extraInfo	object	see Extra Info
printInfo	object	see Document Info

Customer Info

Name	Type	Description
customerId	string	Customer id
externalCustomerId	string	External customer id
name	string	Customer name
mobile	string	Customer mobile
email	string	Customer email

Payment Info

Name	Type	Description
currency	string	Currency code
totalAmount	decimal	The total amount of orders
subTotal	decimal	Order item amount
totalShippingFee	decimal	Order total shipping amount
totalDiscounts	decimal	Order total discount amount
totalTaxation	decimal	Order taxation amount
insuranceFee	decimal	Order insurance fee
codTotalAmount	decimal	Order cod total amount
commissionFee	decimal	Order Commission Fee
totalDiscountProduct	decimal	total discount product
totalDiscountShipping	decimal	total discount shipping
voucherPlatfom	decimal	Platform discount amount (voucher)
voucherSeller	decimal	Seller Discount Amount (Voucher)
sellerRebate	decimal	Seller Rebate
serviceFee	decimal	Order Service Fee
creditCardPromotion	decimal	Credit Card Promotion Offset Amount
creditCardTransactionFee	decimal	Credit Card Transaction Fee
creditCardServiceFee	decimal	Credit Card Service Fee
sellerReturnRefundAmount	decimal	Seller Return Refund Amount
cashback	decimal	Cash Back
coin	decimal	Amount Paid By Platform Gold Coins

Address Info

Name	Type	Description
name	string	Recipient's name for the address
phoneNumber	string	Recipient's phone number input when order was placed
country	string	The two-digit code representing the country of the Recipient
province	string	The state/province of the recipient's address. Whether there is a state/province will depend on the region and/or country
city	string	The city of the recipient's address. Whether there is a city will depend on the region and/or country
district	string	The district of the recipient's address. Whether there is a district will depend on the region and/or country
town	string	The town of the recipient's address. Whether there is a town will depend on the region and/or country
zipCode	string	Recipient's postal code
fullAddress	string	The full address of the recipient, including country, state, even street, and etc

Order Item

Name	Type	Description
itemId	string	Order item id
productName	string	Product name
productImageUrl	string	Product image url
variationName	string	Variation name
spu	string	Spu
sku	string	Sku
quantity	integer	Quantity
actualPrice	decimal	Actual price
actualTotalPrice	decimal	Actual total price
originalPrice	decimal	Original price
discountedPrice	decimal	Discounted price
orderItemStatus	string	Order item status
externalItemId	string	External item id
externalVariationId	string	External variation id
externalProductId	string	External Product id
externalOrderItemStatus	string	External order item status

Logistics Info

Name	Type	Description
itemId	string	Order item id
logisticsId	string	Logistics id
shippingType	string	Shipping type
logisticsProviderId	string	Logistics provider id
logisticsProviderName	string	The logistics service provider that the buyer selected for the order
logisticsTrackingNumber	string	The tracking number assigned by the shipping carrier for item shipment
packageId	string	Package id
invoiceNumber	string	Invoice number
nlc	string	nlc

Cancel Info

Name	Type	Description
cancelReason	string	Cancel reason
cancelReasonNote	string	Cancel reason note
canceledBy	string	Cancel by
canceledAt	UTC timestamp	Canceled time

Extra Info

Name	Type	Description
country	string	Country
noteByBuyer	string	Buyer note
noteBySeller	string	Seller note
itemTotalWeight	string	Item total weight
dropShipperName	string	Drop shipper Name
dropShipperPhone	string	Drop shipper Phone
dropShipperNote	string	Drop Shipper Note

Document Info

Name	Type	Description
labelPdfUrl	string	the url of lable pdf document
invoicePdfUrl	string	the url of invoice pdf document
packingPdfUrl	string	the url of packing pdf document
pickingPdfUrl	string	the url of picking pdf document

Request Example

Example

curl -X POST  \
-H "X-Advai-Country: ID" \
-H "Authorization: {Your Access Key} + ':' + signature" \
-H "Content-Type: application/json" \
-d '{
        "orderId": "SO5F7DE6046B2F07000191B940"
    }' \
"{Ginee Host}/openapi/order/v2/get

Success

{
"code": "SUCCESS",
"message": "OK",
"data": {`
    "orderId": "SO5F6BFC765908010001E1DD83",
    "channel": "LAZADA_ID",
    "shopId": "SO5F6BFC765908010001E1DD83",
    "orderType": "NORMAL",
    "orderStatus": "PAID",
    "country": "INDONESIA",
    "currency": "IDR",
    "totalAmount": 9100.000000,
    "paymentMethod": "COD",
    "payAt": null,
    "promisedToShipBefore": "2020-09-18T16:59:59Z",
    "createAt": "2020-09-24T01:55:02Z",
    "lastUpdateAt": "2020-09-24T01:55:02Z",
    "externalOrderId": "459785672918841",
    "externalOrderSn": "459785672918841",
    "externalOrderStatus": "pending",
    "externalCreateAt": "2020-09-15T22:53:54Z",
    "customerInfo": {
        "customerId": null,
        "externalCustomerId": null,
        "name": "S*****  ",
        "mobile": "+62*********16",
        "email": null
    },
    "paymentInfo": {
        "currency": "IDR",
        "totalAmount": 9100.000000,
        "subTotal": 3000.000000,
        "totalShippingFee": 6100.000000,
        "totalTaxation": null,
        "insuranceFee": null,
        "totalDiscounts": 0.000000,
        "codTotalAmount": null,
        "waybillUrl": null,
        "commissionFee": 123.000000
    },
    "shippingAddressInfo": {
        "name": "Fikaa ",
        "phoneNumber": "62*********16",
        "country": "Indonesia",
        "province": "B****n",
        "city": "Kota Tangerang",
        "district": "K************g",
        "zipCode": "",
        "fullAddress": "J********************************************************************************0  B****n Kota Tangerang K************g C******h Indonesia"
    },
    "senderAddressInfo": null,
    "billingAddressInfo": {
        "name": "Fikaa ",
        "phoneNumber": "62*********16",
        "country": "Indonesia",
        "province": "B****n",
        "city": "Kota Tangerang",
        "district": "K************g",
        "zipCode": "",
        "fullAddress": "J********************************************************************************0  B****n Kota Tangerang K************g C******h Indonesia"
    },
    "items": [
    {
        "itemId": "OI5F6BFC765908010001E1DD86",
        "productName": "Women Print Chiffon Long Sleeve Sexy Slim Waist Long Dress Yolanda 07022018",
        "productImageUrl": "https://id-live.slatic.net/p/96f297ca14a9a0c76ee8d6578ff20762.jpg",
        "variationName": "Ukuran:Int:S, Warna:Aprikot",
        "spu": null,
        "sku": "p202007022018",
        "quantity": 1,
        "actualPrice": 3000.000000,
        "actualTotalPrice": 3000.000000,
        "originalPrice": 3000.000000,
        "originalTotalPrice": 3000.000000,
        "discountedPrice": null,
        "orderItemStatus": null,
        "externalItemId": null,
        "externalProductId": null,
        "externalVariationId": null,
        "externalProductId": null,
        "externalOrderItemStatus": null
    }
    ],
    "logisticsInfos": [
    {
        "logisticsId": "OL5F6BFC765908010001E1DD89",
        "shippingType": "Dropshipping",
        "logisticsProviderId": null,
        "logisticsProviderName": "",
        "logisticsTrackingNumber": "",
        "packageId": "",
        "invoiceNumber": "",
        "nlc":"BKI-BKI009"
    }
    ],
    "cancelInfo": {
        "cancelReason": null,
        "cancelReasonNote": null,
        "cancelBy": null,
        "canceledAt": null,
        "operator": null
    },
    "extraInfo": {
        "country": "ID",
        "noteByBuyer": null,
        "noteBySeller": "",
        "itemTotalWeight": null,
        "dropShipperName": null,
        "dropShipperPhone": null,
        "dropShipperNote": null
    },
    "printInfo": {
        "labelPdfUrl": null,
        "invoicePdfUrl": null,
        "packingPdfUrl": null,
        "pickingPdfUrl": null
    }
},
"extra": null,
"pricingStrategy": "PAY"
}

order is not exist

{
    "code": "DATA_NOT_EXISTED",
    "message": "The data you requested does not exist",
    "data": null,
    "extra": null
}