{"_id":"5722653d49df4f0e0052848d","editedParams2":true,"category":{"_id":"56e3719b591f620e00bf5099","pages":["56e3719c591f620e00bf509b","56e74226555c030e00a52a90","56e7447c7d693632001d5cb4","56e752bd56d59a0e00d5660e","56e755b98aa2c00e00494cd9","56e7584d911296190096dd80","56e759339b25270e001d11a0","56e7593e1b41040e009d10cf","56e7594e911296190096dd88","56e7595e8aa2c00e00494ce3","56e75d7f5669091700c5b2b4","56e77e22911296190096de13","56e77f259b25270e001d1232","56e7b2c737afb90e00e0eb9d","56ec4daf611730190000f23f","56ec4fde26db830e00afa083","56ec8f7204e8940e00966567","56f184cc9791b22d0077b9d9","56f18a2c3af4942b00bb3c47"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"56e3719a591f620e00bf5098","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"editedParams":true,"parentDoc":null,"user":"56e371538b32a10e00f79750","version":{"_id":"56e3719a591f620e00bf5098","hasReference":true,"hasDoc":true,"__v":2,"project":"56e3719a591f620e00bf5095","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["56e3719b591f620e00bf5099","56e7b24ad365390e007baeab"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"__v":0,"project":"56e3719a591f620e00bf5095","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-28T19:32:13.778Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"name":"","code":"{\n  \"from\": \"2016-11-25\",\n  \"to\": \"2016-11-29\",\n  \"amount\": 259,\n  \"minimumStay\": 1\n}","language":"json","status":200},{"code":"Orbirental API - Bad request.","language":"json","status":400,"name":""}]},"settings":"","examples":{"codes":[{"code":"","language":"text"},{"language":"text","code":""},{"code":"","language":"text"}]},"auth":"required","params":[{"_id":"5722653d49df4f0e00528492","ref":"","in":"body","required":true,"desc":"The unique ID of the property","default":"","type":"string","name":"uid"},{"_id":"5722653d49df4f0e00528491","ref":"","in":"body","required":true,"desc":"The start date with format YYYY-MM-DD","default":"","type":"yyyy-mm-dd","name":"from"},{"_id":"5722653d49df4f0e00528490","ref":"","in":"body","required":true,"desc":"The end date with format YYYY-MM-DD","default":"","type":"yyyy-mm-dd","name":"to"},{"_id":"5722653d49df4f0e0052848f","ref":"","in":"body","required":false,"desc":"The nightly rate for this period","default":"0.0","type":"double","name":"amount"},{"_id":"5722653d49df4f0e0052848e","ref":"","in":"body","required":false,"desc":"The minimum amount of nights accepted for booking during this period","default":"1","type":"string","name":"minimumStay"}],"url":"/pricingperiods/"},"isReference":false,"order":33,"body":"","excerpt":"This API allows developers to remotely set the nightly rates for properties. This can also be used to interface Orbirental with a Price Automation / Yield Management service.","slug":"pricingperiods-1","type":"endpoint","title":"/pricingperiods/"}

post/pricingperiods/

This API allows developers to remotely set the nightly rates for properties. This can also be used to interface Orbirental with a Price Automation / Yield Management service.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

uid:
required
string
The unique ID of the property
from:
required
yyyy-mm-dd
The start date with format YYYY-MM-DD
to:
required
yyyy-mm-dd
The end date with format YYYY-MM-DD
amount:
double0.0
The nightly rate for this period
minimumStay:
string1
The minimum amount of nights accepted for booking during this period

Result Format


User Information

Try It Out

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