{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/orders","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"channelCommission\": 12.8,\n    \"subTotal\": \"352.00\",\n    \"transactions\": [\n        {\n            \"amount\": \"473.00\",\n            \"fees\": [\n                {\n                    \"amount\": \"12.80\",\n                    \"label\": \"Affiliate\"\n                },\n                {\n                    \"amount\": \"4.73\",\n                    \"label\": \"Hostfully Platform Commission\"\n                },\n                {\n                    \"amount\": \"0.00\",\n                    \"label\": \"Stripe\"\n                }\n            ],\n            \"isManual\": false,\n            \"type\": \"SALE\",\n            \"transactionID\": \"ch_1FQsaMLsKdfdvR57tN7xAo4Oq\"\n        }\n    ],\n    \"baseAmount\": \"160.00\",\n    \"uid\": \"51cfb64a-a163-4078-b9b6-fc20a06155b1\",\n    \"total\": \"473.00\",\n    \"cleaningFeeAmount\": \"10.00\",\n    \"balance\": \"0.00\",\n    \"securityDepositAmount\": \"10.00\",\n    \"orderFees\": [\n        {\n            \"amount\": \"100.00\",\n            \"name\": \"Linens\"\n        }\n    ],\n    \"currency\": \"EUR\",\n    \"taxAmount\": \"32.00\",\n    \"extraGuestFeeAmount\": \"160.00\",\n    \"cleaningFeeTaxAmount\": \"1.00\"\n\t} \n]","name":""}]},"settings":"","params":[{"name":"propertyUid","type":"string","default":"The unique ID of the property","desc":"","required":true,"in":"query","ref":"","_id":"5db0948229616900509dbc0c"}],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"/orders","type":"endpoint","slug":"orders","excerpt":"Get all booked orders for a particular property","body":"","updates":[],"order":43,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf339a","project":"56e3719a591f620e00bf5095","version":{"version":"1.5","version_clean":"1.5.0","codename":"Domain","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5de85dbbb0b885003ddf3334","project":"56e3719a591f620e00bf5095","__v":19,"createdAt":"2016-03-12T01:32:11.359Z","version":"5de85dbbb0b885003ddf339f"},"user":"56e371538b32a10e00f79750","createdAt":"2019-10-23T17:48:19.057Z","__v":5,"parentDoc":null}

get/orders

Get all booked orders for a particular property

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

propertyUid:
required
stringThe unique ID of the property

Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}