{"_id":"543eb947afca8a08003a2293","version":{"_id":"543005c87d487022005b3fab","__v":6,"project":"543005c87d487022005b3fa8","createdAt":"2014-10-04T14:35:52.362Z","releaseDate":"2014-10-04T14:35:52.362Z","categories":["543005c87d487022005b3fac","54345156edce04080040964e","543ee0c055bb1008000955b6","54c82a78ab706219009e0656","57390d0e1f4b740e00b06cb2","5741d5ab28f5fb0e0063ed36"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"is_link":false,"project":"543005c87d487022005b3fa8","__v":4,"editedParams":true,"editedParams2":true,"category":{"_id":"543ee0c055bb1008000955b6","__v":21,"pages":["543ee1d615d0560800502749","543ee5c015d0560800502758","543ee87715d0560800502763","543ee9e315d056080050276c","543f003c55bb100800095624","543f030555bb10080009563f","543f0b3e15d05608005027ee","543f0d0755bb10080009566d","543f0e8415d056080050281b","543f0f8f55bb10080009567e","543f109055bb100800095689","543f11d315d056080050282b","543f15c615d0560800502845","544aec7fa761f90800c41d32","545a7fae1d018b1400227eff","545e9dc97e32310e00f400ca","5603c5dde416560d00fa63ad","564ed2eb9209cf0d001d6917","56cb2acb245b841300806ea4","56e05f414685db1700d9480b","56e063e4f97d422900d639bf"],"project":"543005c87d487022005b3fa8","version":"543005c87d487022005b3fab","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-15T21:01:52.185Z","from_sync":false,"order":1,"slug":"iwebcab-api-tools","title":"Gazoop Internal API"},"parentDoc":null,"user":"543005a67d487022005b3fa7","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-15T18:13:27.392Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","settings":"","try":false,"basic_auth":false,"examples":{"codes":[]},"results":{"codes":[{"name":"Success","code":"{\n  \"result\": \"valid\"\n}","language":"json"}]},"auth":"never","params":[{"_id":"543eb947afca8a08003a2299","ref":"","in":"body","required":true,"desc":"This is a 25 alphanumeric hash code provided to you by the fleet.","default":"","type":"string","name":"api_key"},{"_id":"543eb947afca8a08003a2298","ref":"","in":"body","required":true,"desc":"This is the command or tool you wish to access or execute. For example, in order to place a booking you would use “instant_booking”.","default":"","type":"string","name":"command"},{"_id":"543eb947afca8a08003a2297","ref":"","in":"body","required":false,"desc":"If TRUE, all keys are returned in uppercase.","default":"false","type":"boolean","name":"uppercase"},{"_id":"543eb947afca8a08003a2295","ref":"","in":"body","required":true,"desc":"This is the customer accounts phone number.","default":"","type":"string","name":"phone_number"},{"_id":"543eb947afca8a08003a2294","ref":"","in":"body","required":false,"desc":"You can also send the customers PIN number for verification, if this fails, the API command will fail. If left blank, no validation is done on the authenticity of the customer ID.","default":"","type":"string","name":"customer_pin"}],"url":"/live.json"},"isReference":false,"order":1,"body":"Most tools will require customer authentication, it is important you have validated each customers session prior to using these tools.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Customer Validation\",\n  \"body\": \"We highly recommend using validate_customer_hash prior to doing any actions, it is possible the PIN number is invalid, and therefore the customer hash you provide will not work. \\n\\nIn addition, it maybe possible the customers account is not verified which will also block the use of various tools, in this case you must ask the customer to provide the security verification code using the validate_sec_code tool.\"\n}\n[/block]","excerpt":"When completing an API Transaction that is specific to a customer account, for example placing, managing, and cancelling bookings.","slug":"customer-api-transaction","type":"endpoint","title":"Customer Transaction"}

postCustomer Transaction

When completing an API Transaction that is specific to a customer account, for example placing, managing, and cancelling bookings.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

api_key:
required
string
This is a 25 alphanumeric hash code provided to you by the fleet.
command:
required
string
This is the command or tool you wish to access or execute. For example, in order to place a booking you would use “instant_booking”.
uppercase:
booleanfalse
If TRUE, all keys are returned in uppercase.
phone_number:
required
string
This is the customer accounts phone number.
customer_pin:
string
You can also send the customers PIN number for verification, if this fails, the API command will fail. If left blank, no validation is done on the authenticity of the customer ID.

Result Format


Documentation

Most tools will require customer authentication, it is important you have validated each customers session prior to using these tools. [block:callout] { "type": "danger", "title": "Customer Validation", "body": "We highly recommend using validate_customer_hash prior to doing any actions, it is possible the PIN number is invalid, and therefore the customer hash you provide will not work. \n\nIn addition, it maybe possible the customers account is not verified which will also block the use of various tools, in this case you must ask the customer to provide the security verification code using the validate_sec_code tool." } [/block]

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 }}