Order API¶

Use this api to gmv-info the order.

POST /openapi/order/v1/gmv-info

Request Parameters¶

Parameter	Type	Required	Description
`createSince`	`UTC timestamp`	`true`	Order id in Ginee search startTime
`createTo`	`UTC timestamp`	`true`	Order id in Ginee search endTime
`orderStatuses`	`array(string)`	`true`	see Order Status for details
`currencyCode`	`string`	`false`	Currency code,For example: ID,please refer to Country Abbreviation for details

Response Parameters¶

Name	Type	Description
`currency`	`string`	currency
`countItems`	`array(CountItem)`	data collection, CountItem

CountItem¶

Name	Type	Description
`dimension`	`string`	order status dimension
`totalAmount`	`decimal`	money

Request Example¶

Example

 curl -X POST  \
 -H "X-Advai-Country: ID" \
 -H "Authorization: {Your Access Key} + ':' + signature" \
 -H "Content-Type: application/json" \
 -d '{
         "orderStatuses": ["PAID"]
         "createSince": "2020-12-01T16:00:04Z",
         "createTo": "2021-03-01T17:00:04Z"
      }'\
 "{Ginee Host}/openapi/order/v1/gmv-info

Success

  {
     "code": "SUCCESS",
     "message": "成功",
     "data": {
         "currency": "IDR",
         "countItems": [
             {
               "dimension": "DELIVERED",
               "totalAmount": 990000
             },
            {
              "dimension": "RETURNED",
             "totalAmount": 1355.2
            }
      ]
  },
  "extra": null,
   "pricingStrategy": "PAY"
}

Failure

{
    "code": "PARAMETER_ERROR",
    "message": "date range cannot exceed 3 months",
    "data": null,
    "extra": null
}

Note

Changes in order status will be notified to you via webhook