{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/orders","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -H \"Authorization: Token YOUR_APP_TOKEN\" https://api.coingate.com/v2/orders?per_page=2&page=1&sort=created_at_desc\n\ncurl -H \"Authorization: Token YOUR_APP_TOKEN\" https://api.coingate.com/v2/orders?created_at[from]=2018-09-01&created_at[to]=2018-09-30"}]},"method":"get","results":{"codes":[{"language":"json","code":"{\n  \"current_page\": 1,\n  \"per_page\": 2,\n  \"total_orders\": 940,\n  \"total_pages\": 470,\n  \"orders\": [\n    {\n      \"id\": 1195862,\n      \"status\": \"new\",\n      \"price_currency\": \"USD\",\n      \"price_amount\": \"2000.0\",\n      \"receive_currency\": \"EUR\",\n      \"receive_amount\": \"\",\n      \"created_at\": \"2018-04-25T13:28:16+00:00\",\n      \"order_id\": \"111\",\n      \"payment_url\": \"https://coingate.com/invoice/6003de09-ee9a-4584-be0e-5c0c71c5e497\"\n    },\n    {\n      \"id\": 1195824,\n      \"status\": \"paid\",\n      \"price_currency\": \"EUR\",\n      \"price_amount\": \"10.0\",\n      \"pay_currency\": \"BTC\",\n      \"pay_amount\": \"0.001281\",\n      \"receive_currency\": \"EUR\",\n      \"receive_amount\": \"9.9\",\n      \"created_at\": \"2018-04-24T23:43:14+00:00\",\n      \"expire_at\": \"2018-04-25T00:05:40+00:00\",\n      \"payment_address\": \"38gmr5MujyDxcEhaqFfC5P9K6bhJo548gu\",\n      \"order_id\": \"110\",\n      \"payment_url\": \"https://coingate.com/invoice/4f5e5a63-5270-435d-bf05-eec369b0fdba\"\n    }\n  ]\n}","name":"","status":200}]},"settings":"5adcc50db719b20003516400","params":[{"name":"per_page","type":"int","default":"100","desc":"How many orders per page. Max: 100. Default: 100.","required":false,"in":"query","ref":"","_id":"5a4538fb1621b50012b570cd"},{"name":"page","type":"int","default":"1","desc":"","required":false,"in":"query","ref":"","_id":"5a4538fb1621b50012b570cc"},{"name":"sort","type":"string","default":"created_at_desc","desc":"Sort orders by field. Available sort options: created_at_asc, created_at_desc. Default: created_at_desc.","required":false,"in":"query","ref":"","_id":"5a4538fb1621b50012b570cb"},{"name":"created_at[from]","type":"string","default":"","desc":"Optional. Where order creation time is equal or greater. Example: 2018-09-01","required":false,"in":"query","ref":"","_id":"5b9fc60fc6d2c00003502119"},{"name":"created_at[to]","type":"string","default":"","desc":"Optional. Where order creation time is equal or less. Example: 2018-09-30","required":false,"in":"query","ref":"","_id":"5b9fc60fc6d2c00003502118"}]},"next":{"description":"","pages":[]},"title":"List Orders","type":"endpoint","slug":"list-orders","excerpt":"Retrieving information of all placed orders","body":"","updates":["5f8081d2337d44006cdfa679"],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5adcc1185cd1890003da816f","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Payment Gateway","slug":"orders","order":2,"from_sync":false,"reference":false,"_id":"5adcc1185cd1890003da8167","version":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","createdAt":"2015-08-18T18:14:59.726Z","__v":1},"user":"5530bf7457cea10d00a3aa3a","parentDoc":null,"project":"5530bfac57cea10d00a3aa3b","version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5adcc1185cd1890003da8166","5adcc1185cd1890003da8167","5adcf4b3ce4b3f00035317e9","5adfb8e9452bd900036d115b","5e7b51281ac49702d745882c","5e7b526560c6cc004f25ca3e"],"_id":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","createdAt":"2018-04-22T17:06:32.152Z","releaseDate":"2018-04-22T17:06:32.152Z","__v":5},"createdAt":"2017-05-04T13:19:48.248Z","githubsync":"","__v":13}

getList Orders

Retrieving information of all placed orders

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

per_page:
integer100
How many orders per page. Max: 100. Default: 100.
page:
integer1
sort:
stringcreated_at_desc
Sort orders by field. Available sort options: created_at_asc, created_at_desc. Default: created_at_desc.
created_at[from]:
string
Optional. Where order creation time is equal or greater. Example: 2018-09-01
created_at[to]:
string
Optional. Where order creation time is equal or less. Example: 2018-09-30

Examples


Result Format