Retrieves a specified order.
Shop Builder API (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.
Download OpenAPI description
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/shop-builder/
https://store.xsolla.com/api/
Personalized catalog
This API allows to specify rules for user attributes. If the user meets all conditions for a concrete rule, personalized items will be shown.
For personalized promotions see Promotions section.
To pass attributes before a purchase, you can use Xsolla Login API or pass them into user.attributes property while generating token using Pay Station API.
Operations
Path
Project ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v2/project/{project_id}/order/{order_id}
- https://store.xsolla.com/api/v2/project/{project_id}/order/{order_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/order/656 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "order_id": 1, "status": "paid", "content": { "price": { … }, "is_free": false, "items": [ … ] } }
Path
Bodyapplication/jsonProject ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
Order search parameters
Number of the order from which the list is generated (the count starts from 0).
Default 0
Start date or date-time of the order creation period per ISO 8601.
Example: "2020-04-15T18:16:00+05:00"
End date or date-time of the order creation period per ISO 8601.
Example: "2020-04-16T18:16:00+05:00"
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v3/project/{project_id}/admin/order/search
- https://store.xsolla.com/api/v3/project/{project_id}/admin/order/search
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/shop-builder/v3/project/44056/admin/order/search \
-H 'Content-Type: application/json' \
-d '{
"offset": 0,
"limit": 5,
"created_date_from": "2018-01-07T00:00:00+03:00",
"created_date_until": "2018-01-09T16:00:00+03:00"
}'Response
application/json
{ "orders": [ { … }, { … }, { … } ], "total_items_count": 11, "has_more": true }