Get orders list for specified period

Get orders list for specified periodServer-sideAdmin

post/v3/project/{project_id}/admin/order/search

Retrieves orders list, arranged from the earliest to the latest creation date.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056

Request Body schema: application/json

Order search parameters

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).
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.

Responses

200

Order list was successfully retrieved.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

Request samples

application/json

{"offset": 0,
"limit": 5,
"created_date_from": "2018-01-07",
"created_date_until": "2018-01-09T16:00:00+03:00"
}

Response samples

application/json

{"orders": [{"order_id": 100511,
"project_id": 101,
"status": "done",
"date_created": "2018-01-08T15:32:06+03:00",
"mode": "default",
"user": {"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": 1
},
"is_free": true,
"items": [{"order_item_id": 29,
"item_id": 1005111,
"sku": "1005111_sku",
"type": "virtual_good",
"quantity": 1,
"is_free": true,
"is_bonus": false,
"region_id": 1,
"tax_category": "DG00001",
"description": {"name": "bla",
"image_url": "http://example.com/image.jpg",
"description": "yes"
}
},
{"order_item_id": 30,
"item_id": 1005112,
"sku": "1005112_sku",
"type": "value_point",
"quantity": 3,
"is_free": true,
"is_bonus": true,
"region_id": 1,
"tax_category": "DG00001",
"description": null
}
]
},
{"order_id": 100510,
"project_id": 101,
"status": "paid",
"date_created": "2018-01-07T15:32:06+03:00",
"mode": "default",
"user": {"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": null
},
"is_free": false,
"items": [{"order_item_id": 27,
"item_id": 1005101,
"sku": "1005101_sku",
"type": "game_key",
"quantity": 1,
"is_free": false,
"is_bonus": false,
"region_id": null,
"tax_category": "DG00001",
"description": null,
"price": {"amount": "67.3400",
"amount_without_discount": "67.3400",
"currency": "USD",
"is_virtual_currency": false
}
},
{"order_item_id": 28,
"item_id": 1005102,
"sku": "1005102_sku",
"type": "value_point",
"quantity": 2,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
}
],
"price": {"amount": "67.3400",
"amount_without_discount": "72.3400",
"currency": "USD",
"is_virtual_currency": false
},
"invoice_id": "100510",
"promotions": [{"promotion_id": 1005101
}
],
"coupons": [{"coupon_id": 100510,
"sku": "100510_sku",
"code": "OPQRSTUVWX",
"type": "promocode"
}
]
},
{"order_id": 100505,
"project_id": 101,
"status": "paid",
"date_created": "2018-01-02T15:32:06+03:00",
"mode": "default",
"user": {"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": null
},
"is_free": false,
"items": [{"order_item_id": 17,
"item_id": 1005051,
"sku": "1005051_sku",
"type": "virtual_good",
"quantity": 1,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
},
{"order_item_id": 18,
"item_id": 1005052,
"sku": "1005052_sku",
"type": "value_point",
"quantity": 3,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
}
],
"price": {"amount": "78.2300",
"amount_without_discount": "78.2300",
"currency": "popugi",
"is_virtual_currency": true
}
}
],
"total_items_count": 11,
"has_more": true
}