Search for ordersServer-sideAdmin
post/v3/project/{project_id}/admin/order/search
Retrieves orders filtered list sorted in descending order by creation date.
SecuritybasicAuth
Request
path Parameters
| project_id required | integer Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt. Example: 44056 |
Request Body schema: application/json
Order search parameters
| created_date_from | string <date-time> Start date or date-time of the order creation period per ISO 8601. |
| created_date_until | string <date-time> End date or date-time of the order creation period per ISO 8601. |
| limit | integer [ 1 .. 10 ] Default: 10 A limit on the number of orders included in the response. |
| offset | integer >= 0 Default: 0 Number of the order from which the list is generated (the count starts from 0). |
Responses
200
Successful orders request
401
Basisauthentifizierung nicht bestanden oder falsch. Prüfen Sie die Anmeldedaten und vergewissern Sie sich, dass Sie die Basisauthentifizierung verwenden.
Request samples
- Payload
- curl
- JavaScript
- Node.js
- Python
- C#
- Go
- Java
application/json
{- "created_date_from": "2018-01-07",
- "created_date_until": "2018-01-09T16:00:00+03:00",
- "limit": 5,
- "offset": 0
}Response samples
- 200
- 401
application/json
{- "has_more": true,
- "orders": [
- {
- "date_created": "2018-01-08T15:32:06+03:00",
- "is_free": true,
- "items": [
- {
- "is_bonus": false,
- "is_free": true,
- "item_id": 1005111,
- "order_item_id": 29,
- "quantity": 1,
- "region_id": 1,
- "sku": "1005111_sku",
- "tax_category": "DG00001",
- "type": "virtual_good"
}, - {
- "description": null,
- "is_bonus": true,
- "is_free": true,
- "item_id": 1005112,
- "order_item_id": 30,
- "quantity": 3,
- "region_id": 1,
- "sku": "1005112_sku",
- "tax_category": "DG00001",
- "type": "value_point"
}
], - "mode": "default",
- "order_id": 100511,
- "project_id": 101,
- "status": "done",
- "user": {
- "country": "US",
- "email": "user@xsolla.com",
- "id": "07e653a2b15011e6818f005056a54369",
- "region_id": 1
}
}, - {
- "coupons": [
- {
- "code": "OPQRSTUVWX",
- "coupon_id": 100510,
- "sku": "100510_sku",
- "type": "promocode"
}
], - "date_created": "2018-01-07T15:32:06+03:00",
- "invoice_id": "100510",
- "is_free": false,
- "items": [
- {
- "description": null,
- "is_bonus": false,
- "is_free": false,
- "item_id": 1005101,
- "order_item_id": 27,
- "price": {
- "amount": "67.3400",
- "amount_without_discount": "67.3400",
- "currency": "USD",
- "is_virtual_currency": false
}, - "quantity": 1,
- "region_id": null,
- "sku": "1005101_sku",
- "tax_category": "DG00001",
- "type": "game_key"
}, - {
- "description": null,
- "is_bonus": true,
- "is_free": true,
- "item_id": 1005102,
- "order_item_id": 28,
- "quantity": 2,
- "region_id": null,
- "sku": "1005102_sku",
- "tax_category": "DG00001",
- "type": "value_point"
}
], - "mode": "default",
- "order_id": 100510,
- "price": {
- "amount": "67.3400",
- "amount_without_discount": "72.3400",
- "currency": "USD",
- "is_virtual_currency": false
}, - "project_id": 101,
- "promotions": [
- {
- "promotion_id": 1005101
}
], - "status": "paid",
- "user": {
- "country": "US",
- "email": "user@xsolla.com",
- "id": "07e653a2b15011e6818f005056a54369",
- "region_id": null
}
}, - {
- "date_created": "2018-01-02T15:32:06+03:00",
- "is_free": false,
- "items": [
- {
- "description": null,
- "is_bonus": true,
- "is_free": true,
- "item_id": 1005051,
- "order_item_id": 17,
- "quantity": 1,
- "region_id": null,
- "sku": "1005051_sku",
- "tax_category": "DG00001",
- "type": "virtual_good"
}, - {
- "description": null,
- "is_bonus": true,
- "is_free": true,
- "item_id": 1005052,
- "order_item_id": 18,
- "quantity": 3,
- "region_id": null,
- "sku": "1005052_sku",
- "tax_category": "DG00001",
- "type": "value_point"
}
], - "mode": "default",
- "order_id": 100505,
- "price": {
- "amount": "78.2300",
- "amount_without_discount": "78.2300",
- "currency": "popugi",
- "is_virtual_currency": true
}, - "project_id": 101,
- "status": "paid",
- "user": {
- "country": "US",
- "email": "user@xsolla.com",
- "id": "07e653a2b15011e6818f005056a54369",
- "region_id": null
}
}
], - "total_items_count": 11
}