{"_id":"5569f85b6637291700e426ec","hidden":false,"slug":"getting-started","type":"basic","excerpt":"","githubsync":"","parentDoc":null,"sync_unique":"","updates":[],"createdAt":"2015-05-28T21:15:19.984Z","link_external":false,"title":"Getting Started","__v":3,"body":"The Pingup API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP verbs, which can be understood by off-the-shelf HTTP clients, and we support cross-origin resource sharing to allow you to interact securely with our API from a client-side web application. JSON will be returned in all responses from the API, including errors and meta data.","category":"5569f85a6637291700e426eb","project":"556785630145bc23008e3bb3","user":"55678558820d1a3700874dd4","version":"5569f8596637291700e426ea","api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[]}},"link_url":"","order":0,"childrenPages":[]}

Getting Started


The Pingup API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP verbs, which can be understood by off-the-shelf HTTP clients, and we support cross-origin resource sharing to allow you to interact securely with our API from a client-side web application. JSON will be returned in all responses from the API, including errors and meta data.
{"_id":"5571a9b047936d23006d3635","parentDoc":null,"project":"556785630145bc23008e3bb3","sync_unique":"","api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]}},"category":"5569f85a6637291700e426eb","link_external":false,"link_url":"","order":1,"createdAt":"2015-06-05T13:52:48.400Z","type":"basic","updates":[],"version":"5569f8596637291700e426ea","__v":6,"body":"Sandbox API\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://api.sandbox.pingup.com/\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nProduction API\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.pingup.com/\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"","hidden":false,"title":"Base URL","githubsync":"","slug":"base-url","user":"55678558820d1a3700874dd4","childrenPages":[]}

Base URL


Sandbox API [block:code] { "codes": [ { "code": "http://api.sandbox.pingup.com/", "language": "curl" } ] } [/block] Production API [block:code] { "codes": [ { "code": "https://api.pingup.com/", "language": "curl" } ] } [/block]
Sandbox API [block:code] { "codes": [ { "code": "http://api.sandbox.pingup.com/", "language": "curl" } ] } [/block] Production API [block:code] { "codes": [ { "code": "https://api.pingup.com/", "language": "curl" } ] } [/block]
{"_id":"5571ab3a47936d23006d364b","next":{"description":"","pages":[]},"parentDoc":null,"slug":"generate-token","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"To make the Pingup API as explorable as possible, accounts have sandbox-mode API keys as well as production-mode API keys.\n\nAll API requests in the production environment must be made over HTTPS.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Obtain an access token\"\n}\n[/block]\nBefore your application can access the Pingup API, it must obtain an access token. To generate an access token, you will need a key and secret which you can retrieve via the [Pingup developer console](http://dashboard.pingup.com/signup). You will have separate keys and secrets for Sandbox and Production. An access token has a limited lifetime and a refresh token allows your application to obtain a new one.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X POST --data \\\"key=123&secret=abc\\\" http://api.sandbox.pingup.com:80/auth/generateTokens\",\n      \"language\": \"text\",\n      \"name\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Send the access token to the API\"\n}\n[/block]\nAfter an application obtains an access token, it sends the token to the Pingup API in an HTTP authorization header. Pingup does not support sending tokens as URI query-string parameters.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X GET --header \\\"token: 12345\\\" https://booknow.pingup.com/places/64851/services\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Refresh the access token, if necessary\"\n}\n[/block]\nAccess tokens have limited lifetimes. If your application needs access to the Pingup API beyond the lifetime of a single access token, it can obtain a refresh token. A refresh token allows your application to obtain new access tokens.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Save refresh tokens in secure long-term storage and continue to use them as long as they remain valid. If your application requests enough refresh tokens to go over one of the limits, older refresh tokens stop working.\",\n  \"title\": \"Note:\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"All calls must be signed with an access token.\",\n  \"title\": \"Note\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"More Info\"\n}\n[/block]\nFurther information (and code samples) about authentication can be found in the [FAQ](https://dash.readme.io/project/pingup/v1/blog/welcome-to-pingup).\n\nOr try generating your own token in the [API explorer](http://pingup.readme.io/v1/docs/authgeneratetokens).","category":"5571a9bd47936d23006d3637","link_external":false,"link_url":"","excerpt":"","sync_unique":"","type":"basic","user":"55678558820d1a3700874dd4","order":0,"project":"556785630145bc23008e3bb3","updates":[],"createdAt":"2015-06-05T13:59:22.170Z","githubsync":"","hidden":false,"isReference":false,"version":"5569f8596637291700e426ea","__v":16,"title":"Authentication","childrenPages":[]}

Authentication


To make the Pingup API as explorable as possible, accounts have sandbox-mode API keys as well as production-mode API keys. All API requests in the production environment must be made over HTTPS. [block:api-header] { "type": "basic", "title": "Obtain an access token" } [/block] Before your application can access the Pingup API, it must obtain an access token. To generate an access token, you will need a key and secret which you can retrieve via the [Pingup developer console](http://dashboard.pingup.com/signup). You will have separate keys and secrets for Sandbox and Production. An access token has a limited lifetime and a refresh token allows your application to obtain a new one. [block:code] { "codes": [ { "code": "curl -X POST --data \"key=123&secret=abc\" http://api.sandbox.pingup.com:80/auth/generateTokens", "language": "text", "name": "curl" } ] } [/block] [block:api-header] { "type": "basic", "title": "Send the access token to the API" } [/block] After an application obtains an access token, it sends the token to the Pingup API in an HTTP authorization header. Pingup does not support sending tokens as URI query-string parameters. [block:code] { "codes": [ { "code": "curl -X GET --header \"token: 12345\" https://booknow.pingup.com/places/64851/services", "language": "text" } ] } [/block] [block:api-header] { "type": "basic", "title": "Refresh the access token, if necessary" } [/block] Access tokens have limited lifetimes. If your application needs access to the Pingup API beyond the lifetime of a single access token, it can obtain a refresh token. A refresh token allows your application to obtain new access tokens. [block:callout] { "type": "warning", "body": "Save refresh tokens in secure long-term storage and continue to use them as long as they remain valid. If your application requests enough refresh tokens to go over one of the limits, older refresh tokens stop working.", "title": "Note:" } [/block] [block:callout] { "type": "info", "body": "All calls must be signed with an access token.", "title": "Note", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "More Info" } [/block] Further information (and code samples) about authentication can be found in the [FAQ](https://dash.readme.io/project/pingup/v1/blog/welcome-to-pingup). Or try generating your own token in the [API explorer](http://pingup.readme.io/v1/docs/authgeneratetokens).
To make the Pingup API as explorable as possible, accounts have sandbox-mode API keys as well as production-mode API keys. All API requests in the production environment must be made over HTTPS. [block:api-header] { "type": "basic", "title": "Obtain an access token" } [/block] Before your application can access the Pingup API, it must obtain an access token. To generate an access token, you will need a key and secret which you can retrieve via the [Pingup developer console](http://dashboard.pingup.com/signup). You will have separate keys and secrets for Sandbox and Production. An access token has a limited lifetime and a refresh token allows your application to obtain a new one. [block:code] { "codes": [ { "code": "curl -X POST --data \"key=123&secret=abc\" http://api.sandbox.pingup.com:80/auth/generateTokens", "language": "text", "name": "curl" } ] } [/block] [block:api-header] { "type": "basic", "title": "Send the access token to the API" } [/block] After an application obtains an access token, it sends the token to the Pingup API in an HTTP authorization header. Pingup does not support sending tokens as URI query-string parameters. [block:code] { "codes": [ { "code": "curl -X GET --header \"token: 12345\" https://booknow.pingup.com/places/64851/services", "language": "text" } ] } [/block] [block:api-header] { "type": "basic", "title": "Refresh the access token, if necessary" } [/block] Access tokens have limited lifetimes. If your application needs access to the Pingup API beyond the lifetime of a single access token, it can obtain a refresh token. A refresh token allows your application to obtain new access tokens. [block:callout] { "type": "warning", "body": "Save refresh tokens in secure long-term storage and continue to use them as long as they remain valid. If your application requests enough refresh tokens to go over one of the limits, older refresh tokens stop working.", "title": "Note:" } [/block] [block:callout] { "type": "info", "body": "All calls must be signed with an access token.", "title": "Note", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "More Info" } [/block] Further information (and code samples) about authentication can be found in the [FAQ](https://dash.readme.io/project/pingup/v1/blog/welcome-to-pingup). Or try generating your own token in the [API explorer](http://pingup.readme.io/v1/docs/authgeneratetokens).
{"_id":"5571b19547936d23006d3657","githubsync":"","parentDoc":null,"project":"556785630145bc23008e3bb3","type":"post","updates":[],"body":"","category":"5571a9bd47936d23006d3637","excerpt":"","link_external":false,"link_url":"","order":1,"slug":"authgeneratetokens","version":"5569f8596637291700e426ea","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/auth/generateTokens","auth":"never","method":"post","params":[{"desc":"","name":"key","required":false,"type":"string","in":"body","_id":"5571b19547936d23006d3659","default":""},{"required":false,"type":"string","in":"body","_id":"5571b19547936d23006d3658","default":"","desc":"","name":"secret"}]},"editedParams":true,"hidden":false,"sync_unique":"","title":"Generate Token","user":"55678558820d1a3700874dd4","createdAt":"2015-06-05T14:26:29.974Z","editedParams2":true,"__v":0,"childrenPages":[]}

postGenerate Token


Body Params

key:
string
secret:
string

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5571bbe047936d23006d3688","editedParams2":true,"link_url":"","slug":"refresh-token","sync_unique":"","type":"put","user":"55678558820d1a3700874dd4","__v":1,"body":"","category":"5571a9bd47936d23006d3637","version":"5569f8596637291700e426ea","title":"Refresh Token","updates":[],"editedParams":true,"hidden":false,"order":2,"excerpt":"","githubsync":"","link_external":false,"parentDoc":null,"project":"556785630145bc23008e3bb3","api":{"auth":"never","method":"put","params":[{"in":"body","_id":"5571bc1e47936d23006d368d","required":false,"desc":"This is your Secret","default":"","type":"string","name":"secret"},{"type":"string","name":"token","in":"body","_id":"5571bc1e47936d23006d368c","required":false,"desc":"This is your Refresh Token","default":""}],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/auth/refreshToken"},"createdAt":"2015-06-05T15:10:24.414Z","childrenPages":[]}

putRefresh Token


Body Params

secret:
string
This is your Secret
token:
string
This is your Refresh Token

User Information

Try It Out

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"58ef4f5914ab683100de1499","user":"5655ddfda66be71700968e03","api":{"url":"/v:version/categories","method":"get","examples":{"codes":[{"code":"curl  \"https://api.pingup.com/v1/categories?offset=0&limit=10\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X GET","language":"curl"}]},"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"meta-data\": {\n        \"code\": 200,\n        \"message\": \"OK\",\n        \"totalResults\": 460,\n        \"offset\": 0,\n        \"limit\": 5,\n        \"prev\": \"\",\n        \"next\": \"http://api.pingup.com/v1/categories?limit=5&offset=5\"\n    },\n    \"categories\": [\n        {\n            \"id\": \"1581\",\n            \"parentId\": \"1576\",\n            \"name\": \"Accounting and Bookkeeping\",\n            \"fullName\": \"Services and Supplies > Financial > Accounting and Bookkeeping\"\n        },\n        {\n            \"id\": \"846\",\n            \"parentId\": \"841\",\n            \"name\": \"Acupuncture\",\n            \"fullName\": \"Healthcare > Holistic, Alternative and Naturopathic Medicine > Acupuncture\"\n        },\n        {\n            \"id\": \"1101\",\n            \"parentId\": \"1096\",\n            \"name\": \"Adult\",\n            \"fullName\": \"Retail > Adult\"\n        },\n        {\n            \"id\": \"2071\",\n            \"parentId\": \"2066\",\n            \"name\": \"Adult\",\n            \"fullName\": \"Social > Entertainment > Adult\"\n        },\n        {\n            \"id\": \"616\",\n            \"parentId\": \"611\",\n            \"name\": \"Adult Education\",\n            \"fullName\": \"Community and Government > Education > Adult Education\"\n        }\n    ]\n}"},{"status":400,"language":"json","code":"{\n    \"httpStatus\": 400,\n    \"responseReference\": 40026,\n    \"message\": \"The request cannot be fulfilled due to bad syntax. \",\n    \"description\": \"Invalid sort parameter received. For more information visit documentation: http://developers.pingup.com/\"\n}","name":""}]},"settings":"","auth":"required","params":[{"required":false,"desc":"This offsets the start of each page by the number specified.","default":"0","type":"string","name":"offset","_id":"58ef4f5914ab683100de14a0","ref":"","in":"query"},{"type":"string","name":"limit","_id":"58ef4f5914ab683100de149f","ref":"","in":"query","required":false,"desc":"This is the number of individual objects that are returned in each page. Maximum value: 50","default":"20"},{"required":false,"desc":"This parameter does filtering of the results by category name and category full name","default":"","type":"string","name":"query","_id":"58ef4f5914ab683100de149e","ref":"","in":"query"},{"ref":"","in":"query","required":false,"desc":"This is the sorting parameter. Possible values are: NAME, FEATURED, POPULAR. Default value: NAME. Categories are filtered by geolocation in case sort value is POPULAR and both latitude and longitude parameters are provided.","default":"","type":"string","name":"sort","_id":"58ef4f5914ab683100de149d"},{"default":"","type":"string","name":"latitude","_id":"58ef4f5914ab683100de149c","ref":"","in":"query","required":false,"desc":"Latitude in decimal degrees."},{"default":"","type":"string","name":"longitude","_id":"58ef4f5914ab683100de149b","ref":"","in":"query","required":false,"desc":"Longitude in decimal degrees."},{"in":"query","required":false,"desc":"Search radius in kilometers.","default":"30","type":"string","name":"radius","_id":"58ef4f5914ab683100de149a","ref":""}]},"githubsync":"","link_url":"","project":"556785630145bc23008e3bb3","slug":"list-categories","updates":[],"type":"get","version":"5569f8596637291700e426ea","body":"","createdAt":"2017-04-13T10:13:45.122Z","next":{"pages":[],"description":""},"order":0,"parentDoc":null,"excerpt":"","hidden":false,"link_external":false,"title":"List Categories","__v":0,"category":"58ef4d642c4ffc390008ae7d","isReference":false,"sync_unique":"","childrenPages":[]}

getList Categories


Query Params

offset:
string0
This offsets the start of each page by the number specified.
limit:
string20
This is the number of individual objects that are returned in each page. Maximum value: 50
query:
string
This parameter does filtering of the results by category name and category full name
sort:
string
This is the sorting parameter. Possible values are: NAME, FEATURED, POPULAR. Default value: NAME. Categories are filtered by geolocation in case sort value is POPULAR and both latitude and longitude parameters are provided.
latitude:
string
Latitude in decimal degrees.
longitude:
string
Longitude in decimal degrees.
radius:
string30
Search radius in kilometers.

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"58ef51b0f8c3b00f00011cd1","__v":0,"user":"5655ddfda66be71700968e03","order":1,"parentDoc":null,"project":"556785630145bc23008e3bb3","sync_unique":"","title":"List Places","body":"","excerpt":"List Places (Businesses) available for online booking.","hidden":false,"isReference":false,"link_external":false,"updates":[],"version":"5569f8596637291700e426ea","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta-data\" : {\n    \"code\" : 200,\n    \"message\" : \"OK\",\n    \"totalResults\" : 11281,\n    \"offset\" : 0,\n    \"limit\" : 5,\n    \"prev\" : \"\",\n    \"next\" : \"http://api.pingup.com/v1/places?offset=5&limit=5&region=MA\"\n  },\n  \"places\" : [ {\n    \"id\": \"20296\",\n    \"uniqueId\": \"B7NDaq\",\n    \"name\": \"Bare Laser Hair Removal LLC \",\n    \"phoneNumber\": \"5085303720\",\n    \"webSite\": null,\n    \"description\": null,\n    \"logoUrl\": \"http://booknow.pingup.com/public/images/business/default-logo.png\",\n    \"pingupUrl\": \"http://booknow.pingup.com/B7NDaq\",\n    \"lastModified\": 1480672627000,\n    \"categories\": [ {\n      \"id\": \"1781\",\n      \"parentId\": \"1656\",\n      \"name\": \"Pools and Spas\",\n      \"fullName\": \"Businesses and Services > Home Improvement > Pools and Spas\"\n    }, {\n      \"id\": \"1906\",\n      \"parentId\": \"1866\",\n      \"name\": \"Spas\",\n      \"fullName\": \"Businesses and Services > Personal Care > Spas\"\n    }, {\n      \"id\": \"486\",\n      \"parentId\": null,\n      \"name\": \"General\",\n      \"fullName\": \"General\"\n    }, {\n      \"id\": \"1876\",\n      \"parentId\": \"1866\",\n      \"name\": \"Hair Removal\",\n      \"fullName\": \"Businesses and Services > Personal Care > Hair Removal\"\n    } ],\n    \"address\": {\n      \"addressLine1\": \"9 Summer Street Unit 101A \",\n      \"addressLine2\": null,\n      \"country\": {\n        \"abbreviation\": \"US/Eastern\",\n        \"name\": \"United States\"\n\t  },\n\t  \"geo\": {\n\t\t\"latitude\": 42.0817162,\n\t\t\"longitude\": -71.3958616\n\t  },\n\t  \"timeZone\": \"US/Eastern\",\n\t  \"locality\": \"Franklin\",\n\t  \"region\": \"MA\",\n\t  \"postCode\": \"02038\"\n\t},\n\t\"status\": \"ACTIVE\",\n\t\"bookingType\": [\"APPOINTMENT\"],\n\t\"factualId\": \"3785eb31-2a52-4d35-9efb-64447af2e3df\"\n  }, {\n    \"id\" : \"20256\",\n    \"uniqueId\" : \"qZ2bPq\",\n    \"name\" : \"...ahh Time Skin  Lash Massage Studio\",\n    \"phoneNumber\" : \"5084771837\",\n    \"webSite\" : \"http://www.ahhtimeskinspa.net\",\n    \"description\" : null,\n\t\"logoUrl\": \"http://booknow.pingup.com/public/images/business/default-logo.png\",\n    \"pingupUrl\" : \"http://booknow.pingup.com/qZ2bPq\",\n    \"lastModified\" : 1429518583000,\n    \"categories\" : [ {\n      \"id\" : \"1781\",\n      \"parentId\" : \"1656\",\n      \"name\" : \"Pools and Spas\",\n      \"fullName\" : \"Businesses and Services > Home Improvement > Pools and Spas\"\n    }, {\n      \"id\" : \"1906\",\n      \"parentId\" : \"1866\",\n      \"name\" : \"Spas\",\n      \"fullName\" : \"Businesses and Services > Personal Care > Spas\"\n    }, {\n      \"id\" : \"486\",\n      \"parentId\" : null,\n      \"name\" : \"General\",\n      \"fullName\" : \"General\"\n    }, {\n      \"id\" : \"1881\",\n      \"parentId\" : \"1866\",\n      \"name\" : \"Hair Salons and Barbers\",\n      \"fullName\" : \"Businesses and Services > Personal Care > Hair Salons and Barbers\"\n    } ],\n    \"address\" : {\n      \"addressLine1\" : \"35C & D South Street\",\n      \"addressLine2\" : \"(between Wicked and Oak and Ember)\",\n      \"country\" : {\n        \"abbreviation\" : \"US\",\n        \"name\" : \"United States\"\n      },\n      \"geo\" : {\n        \"latitude\" : 33.1431884,\n        \"longitude\" : -96.8556364\n      },\n      \"timeZone\" : \"US/Eastern\",\n      \"locality\" : \"Mashpee\",\n      \"region\" : \"MA\",\n      \"postCode\" : \"02649\"\n    },\n    \"status\" : \"ACTIVE\",\n    \"bookingType\" : [ \"APPOINTMENT\" ],\n    \"factualId\" : \"face9db5-fcce-4a16-90f9-8ab46554b8d2\"\n  }, {\n    \"id\" : \"20261\",\n    \"uniqueId\" : \"pKzDxB\",\n    \"name\" : \"A Beautiful You\",\n    \"phoneNumber\" : \"5084808883\",\n    \"webSite\" : \"http://www.iloveabeautifulyou.com\",\n    \"description\" : \"Your satisfaction is first and foremost to our skin care professionals. Our staff is highly trained; your safety is their first priority. They are passionate and committed to create an atmosphere for every visit to be enjoyable and comfortable.(please rephrase) You will look forward to return visits again and again!\",\n    \"logoUrl\": \"http://booknow.pingup.com/public/images/business/default-logo.png\",\n\t\"pingupUrl\" : \"http://booknow.pingup.com/pKzDxB\",\n    \"lastModified\" : null,\n    \"categories\" : [ {\n      \"id\" : \"851\",\n      \"parentId\" : \"791\",\n      \"name\" : \"Hospitals, Clinics and Medical Centers\",\n      \"fullName\" : \"Healthcare > Hospitals, Clinics and Medical Centers\"\n    }, {\n      \"id\" : \"891\",\n      \"parentId\" : \"886\",\n      \"name\" : \"Sports Medicine\",\n      \"fullName\" : \"Healthcare > Physical Therapy and Rehabilitation > Sports Medicine\"\n    }, {\n      \"id\" : \"1781\",\n      \"parentId\" : \"1656\",\n      \"name\" : \"Pools and Spas\",\n      \"fullName\" : \"Businesses and Services > Home Improvement > Pools and Spas\"\n    }, {\n      \"id\" : \"1906\",\n      \"parentId\" : \"1866\",\n      \"name\" : \"Spas\",\n      \"fullName\" : \"Businesses and Services > Personal Care > Spas\"\n    }, {\n      \"id\" : \"1901\",\n      \"parentId\" : \"1866\",\n      \"name\" : \"Skin Care\",\n      \"fullName\" : \"Businesses and Services > Personal Care > Skin Care\"\n    } ],\n    \"address\" : {\n      \"addressLine1\" : \"154 Turnpike Rd \",\n      \"addressLine2\" : null,\n      \"country\" : {\n        \"abbreviation\" : \"US\",\n        \"name\" : \"United States\"\n      },\n      \"geo\" : {\n        \"latitude\" : 42.2912561,\n        \"longitude\" : -71.5296164\n      },\n      \"timeZone\" : \"US/Eastern\",\n      \"locality\" : \"Southborough\",\n      \"region\" : \"MA\",\n      \"postCode\" : \"01772\"\n    },\n    \"status\" : \"ACTIVE\",\n    \"bookingType\" : [ \"APPOINTMENT\" ],\n    \"factualId\" : \"39c05577-a576-4869-b1e0-0b96583a473a\"\n  }, {\n    \"id\" : \"20266\",\n    \"uniqueId\" : \"yo0MQq\",\n    \"name\" : \"Aaqua Blue Salon\",\n    \"phoneNumber\" : \"9784632230\",\n    \"webSite\" : \"http://www.aaquablue.com/\",\n    \"description\" : null,\n    \"logoUrl\": \"http://booknow.pingup.com/public/images/business/default-logo.png\",\n\t\"pingupUrl\" : \"http://booknow.pingup.com/yo0MQq\",\n    \"lastModified\" : 1429518594000,\n    \"categories\" : [ {\n      \"id\" : \"1881\",\n      \"parentId\" : \"1866\",\n      \"name\" : \"Hair Salons and Barbers\",\n      \"fullName\" : \"Businesses and Services > Personal Care > Hair Salons and Barbers\"\n    }, {\n      \"id\" : \"1911\",\n      \"parentId\" : \"1866\",\n      \"name\" : \"Tanning Salons\",\n      \"fullName\" : \"Businesses and Services > Personal Care > Tanning Salons\"\n    }, {\n      \"id\" : \"1876\",\n      \"parentId\" : \"1866\",\n      \"name\" : \"Hair Removal\",\n      \"fullName\" : \"Businesses and Services > Personal Care > Hair Removal\"\n    } ],\n    \"address\" : {\n      \"addressLine1\" : \"10 Prince Place\",\n      \"addressLine2\" : null,\n      \"country\" : {\n        \"abbreviation\" : \"US\",\n        \"name\" : \"United States\"\n      },\n      \"geo\" : {\n        \"latitude\" : 42.8094137,\n        \"longitude\" : -70.8720349\n      },\n      \"timeZone\" : \"US/Eastern\",\n      \"locality\" : \"Newburyport\",\n      \"region\" : \"MA\",\n      \"postCode\" : \"01950\"\n    },\n    \"status\" : \"ACTIVE\",\n    \"bookingType\" : [ \"APPOINTMENT\" ],\n    \"factualId\" : \"1111a1a3-a5d3-4912-b27f-7351997cb144\"\n  }, {\n    \"id\" : \"20271\",\n    \"uniqueId\" : \"pYlb7B\",\n    \"name\" : \"Adara Spa\",\n    \"phoneNumber\" : \"6172275499\",\n    \"webSite\" : \"http://adaraspaboston.com\",\n    \"description\" : \"Our philosophy is a simple one, with all of our products and services aimed at bringing out the most beautiful you. Unlike other spas that focus on “making one beautiful,” our belief is that each person has an innate beauty that shines when one is feeling healthy and refreshed. Our name and brand identity are born from this conviction and we look forward to offering our expertise in bringing out your most beautiful qualities. We invite you to step inside and let the cares of daily stresses melt away in an environment of tranquility and pampering. With body wraps, facials, massages, nail treatments, and many more offerings, you will walk out fully rejuvenated from head to toe. We are the exclusive provider of several services (featured on Oprah and used at the Academy Awards) that cannot be found anywhere else, in either Boston and/or Massachusetts, that will peel away the inches to reveal a more svelte you.\",\n    \"logoUrl\": \"http://booknow.pingup.com/public/images/business/default-logo.png\",\n\t\"pingupUrl\" : \"http://booknow.pingup.com/pYlb7B\",\n    \"lastModified\" : null,\n    \"categories\" : [ {\n      \"id\" : \"1781\",\n      \"parentId\" : \"1656\",\n      \"name\" : \"Pools and Spas\",\n      \"fullName\" : \"Businesses and Services > Home Improvement > Pools and Spas\"\n    }, {\n      \"id\" : \"1906\",\n      \"parentId\" : \"1866\",\n      \"name\" : \"Spas\",\n      \"fullName\" : \"Businesses and Services > Personal Care > Spas\"\n    } ],\n    \"address\" : {\n      \"addressLine1\" : \"115 Lewis Wharf\",\n      \"addressLine2\" : null,\n      \"country\" : {\n        \"abbreviation\" : \"US\",\n        \"name\" : \"United States\"\n      },\n      \"geo\" : {\n        \"latitude\" : 42.3635907,\n        \"longitude\" : -71.0507932\n      },\n      \"timeZone\" : \"US/Eastern\",\n      \"locality\" : \"Boston\",\n      \"region\" : \"MA\",\n      \"postCode\" : \"02110\"\n    },\n    \"status\" : \"ACTIVE\",\n    \"bookingType\" : [ \"APPOINTMENT\" ],\n    \"factualId\" : \"0fbf2ff1-ff1c-48b6-91a5-083b61057fee\"\n  } ]","name":""},{"name":"","status":400,"language":"json","code":"{\n    \"httpStatus\": 400,\n    \"responseReference\": 40054,\n    \"message\": \"The request cannot be fulfilled due to bad syntax. \",\n    \"description\": \"Error in request. Both latitude and longitude values must be defined. For more information visit documentation: http://developers.pingup.com/\"\n}"}]},"settings":"","auth":"required","params":[{"type":"int","name":"offset","_id":"58ef51b0f8c3b00f00011ce1","ref":"","in":"query","required":false,"desc":"This offsets the start of each page by the number specified..","default":"0"},{"required":false,"desc":"This is the number of individual objects that are returned in each page. Maximum value: 50","default":"20","type":"int","name":"limit","_id":"58ef51b0f8c3b00f00011ce0","ref":"","in":"query"},{"ref":"","in":"query","required":false,"desc":"Place/ Business name","default":"","type":"string","name":"name","_id":"58ef51b0f8c3b00f00011cdf"},{"in":"query","required":false,"desc":"Address number and street name","default":"","type":"string","name":"street","_id":"58ef51b0f8c3b00f00011cde","ref":""},{"desc":"City, town or equivalent","default":"","type":"string","name":"locality","_id":"58ef51b0f8c3b00f00011cdd","ref":"","in":"query","required":false},{"name":"region","_id":"58ef51b0f8c3b00f00011cdc","ref":"","in":"query","required":false,"desc":"State, province, territory, or equivalent","default":"","type":"string"},{"ref":"","in":"query","required":false,"desc":"Postcode or equivalent (zipcode in US)","default":"","type":"string","name":"postCode","_id":"58ef51b0f8c3b00f00011cdb"},{"in":"query","required":false,"desc":"Two letter ISO Country Code","default":"","type":"string","name":"country","_id":"58ef51b0f8c3b00f00011cda","ref":""},{"desc":"Latitude in decimal degrees.","default":"","type":"string","name":"latitude","_id":"58ef51b0f8c3b00f00011cd9","ref":"","in":"query","required":false},{"name":"longitude","_id":"58ef51b0f8c3b00f00011cd8","ref":"","in":"query","required":false,"desc":"Longitude in decimal degrees.","default":"","type":"string"},{"type":"int","name":"radius","_id":"58ef51b0f8c3b00f00011cd7","ref":"","in":"query","required":false,"desc":"Search radius in kilometers.","default":"30"},{"desc":"Comma separated list of category ids","default":"","type":"string","name":"category","_id":"58ef51b0f8c3b00f00011cd6","ref":"","in":"query","required":false},{"name":"modifiedSince","_id":"58ef51b0f8c3b00f00011cd5","ref":"","in":"query","required":false,"desc":"Search returns only places modified after this date.","default":"","type":"yyyy-mm-dd"},{"type":"string","name":"referenceId","_id":"58ef51b0f8c3b00f00011cd4","ref":"","in":"query","required":false,"desc":"Place / Business uniqueId","default":""},{"desc":"Phone number (US)","default":"","type":"string","name":"phoneNumber","_id":"58ef51b0f8c3b00f00011cd3","ref":"","in":"query","required":false},{"name":"status","_id":"58ef51b0f8c3b00f00011cd2","ref":"","in":"query","required":false,"desc":"Status of the business. Possible values are: ACTIVE / INACTIVE","default":"","type":"string"}],"url":"/v:version/places","method":"get","examples":{"codes":[{"language":"curl","code":"curl  \"https://api.pingup.com/v1/places?offset=0&limit=5&region=MA\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X GET\n"}]}},"category":"58ef4d642c4ffc390008ae7d","createdAt":"2017-04-13T10:23:44.952Z","githubsync":"","link_url":"","next":{"pages":[],"description":""},"slug":"list-places","type":"get","childrenPages":[]}

getList Places

List Places (Businesses) available for online booking.

Query Params

offset:
integer0
This offsets the start of each page by the number specified..
limit:
integer20
This is the number of individual objects that are returned in each page. Maximum value: 50
name:
string
Place/ Business name
street:
string
Address number and street name
locality:
string
City, town or equivalent
region:
string
State, province, territory, or equivalent
postCode:
string
Postcode or equivalent (zipcode in US)
country:
string
Two letter ISO Country Code
latitude:
string
Latitude in decimal degrees.
longitude:
string
Longitude in decimal degrees.
radius:
integer30
Search radius in kilometers.
category:
string
Comma separated list of category ids
modifiedSince:
yyyy-mm-dd
Search returns only places modified after this date.
referenceId:
string
Place / Business uniqueId
phoneNumber:
string
Phone number (US)
status:
string
Status of the business. Possible values are: ACTIVE / INACTIVE

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"58ef52ad8646742f0099ff38","order":2,"title":"Single Place","version":"5569f8596637291700e426ea","githubsync":"","link_url":"","parentDoc":null,"slug":"single-place","type":"get","user":"5655ddfda66be71700968e03","api":{"method":"get","examples":{"codes":[{"language":"curl","code":"curl  \"https://api.pingup.com/v1/places/PLACE_ID\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X GET"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"meta-data\": {\n        \"code\": 200,\n        \"message\": \"OK\"\n    },\n    \"place\": {\n        \"id\": \"20231\",\n        \"uniqueId\": \"B8nz1y\",\n        \"name\": \"Tracy Anderson Method Tribeca\",\n        \"phoneNumber\": \"2129651408\",\n        \"webSite\": \"http://www.tracyandersonmethod.com\",\n        \"description\": null,\n        \"logoUrl\": \"http://booknow.pingup.com/public/images/business/default-logo.png\",\n        \"pingupUrl\": \"http://booknow.pingup.com/B8nz1y\",\n        \"lastModified\": 1430836031000,\n        \"categories\": [\n            {\n                \"id\": \"791\",\n                \"parentId\": \"486\",\n                \"name\": \"Healthcare\",\n                \"fullName\": \"Healthcare\"\n            },\n            {\n                \"id\": \"1256\",\n                \"parentId\": \"1226\",\n                \"name\": \"Health and Diet Food\",\n                \"fullName\": \"Retail > Food and Beverage > Health and Diet Food\"\n            },\n            {\n                \"id\": \"551\",\n                \"parentId\": \"491\",\n                \"name\": \"Motorcycles, Mopeds and Scooters\",\n                \"fullName\": \"Automotive > Motorcycles, Mopeds and Scooters\"\n            }\n        ],\n        \"address\": {\n            \"addressLine1\": \"24 Hubert Street\",\n            \"addressLine2\": null,\n            \"country\": {\n                \"abbreviation\": \"US\",\n                \"name\": \"United States\"\n            },\n            \"geo\": {\n                \"latitude\": 40.7216709,\n                \"longitude\": -74.0102084\n            },\n            \"timeZone\": \"US/Eastern\",\n            \"locality\": \"New York\",\n            \"region\": \"NY\",\n            \"postCode\": \"10013\"\n        },\n        \"status\": \"ACTIVE\",\n        \"bookingType\": [\n            \"APPOINTMENT\"\n        ],\n        \"factualId\": \"e8f166da-01e7-4f0b-828e-bbdc7268c47c\"\n    }\n}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","auth":"required","params":[{"desc":"Place ID","default":"","type":"string","name":"placeId","_id":"58ef52ad8646742f0099ff39","ref":"","in":"path","required":true}],"url":"/v:version/places/:placeId"},"excerpt":"","body":"","hidden":false,"isReference":false,"link_external":false,"next":{"pages":[],"description":""},"updates":[],"__v":0,"project":"556785630145bc23008e3bb3","sync_unique":"","category":"58ef4d642c4ffc390008ae7d","createdAt":"2017-04-13T10:27:57.308Z","childrenPages":[]}

getSingle Place


Path Params

placeId:
required
string
Place ID

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5571d9501cd8283500a8b496","parentDoc":null,"project":"556785630145bc23008e3bb3","sync_unique":"","title":"List Services","api":{"method":"get","params":[{"in":"path","name":"placeId","ref":"","required":true,"type":"string","_id":"5571d9501cd8283500a8b497","default":"","desc":"Place ID"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"meta-data\": {\n        \"code\": 200,\n        \"message\": \"OK\"\n    },\n    \"services\": [\n        {\n            \"id\": \"12251-1034962\",\n            \"type\": null,\n            \"category\": \"Fitness\",\n            \"description\": \"**This class is reserved for MEN ONLY** Men are built very differently than women, and generally have less flexibility and range of motion: In these classes, we will use heavier weights and involve a lot more agility work through bands to engage the upper body. A typical workout will include a full body warm-up, an arm routine, a lower-body workout that employs planks along with movements that use a variety of weights and levels of resistance to build strength and flexibility, and a focused core routine that defines the abdominal muscles and works deeply in the transverse abdominals. The workout concludes with high-intensity, agility-based cardio work.\",\n            \"name\": \"men's atTAin definition\",\n            \"duration\": 60,\n            \"price\": {\n                \"type\": \"EXACT\",\n                \"amount\": \"40.00\",\n                \"description\": null,\n                \"currency\": \"USD\"\n            },\n            \"payments\": null\n        }\n    ]\n}","name":""},{"status":400,"language":"json","code":"{\n    \"httpStatus\": 400,\n    \"responseReference\": 40003,\n    \"message\": \"The request cannot be fulfilled due to bad syntax. \",\n    \"description\": \"Invalid placeId  value received. For more information visit documentation: http://developers.pingup.com/\"\n}","name":""}]},"settings":"","url":"/v:version/places/:placeId/services","auth":"required","examples":{"codes":[{"language":"curl","code":"curl  \"https://api.pingup.com/v1/places/PLACE_ID/services\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X GET","name":""}]}},"hidden":false,"next":{"description":"","pages":[]},"createdAt":"2015-06-05T17:16:00.138Z","editedParams":true,"excerpt":"Each place offers a set of services that can be booked online (menu).","link_external":false,"updates":[],"__v":1,"body":"","user":"55678558820d1a3700874dd4","isReference":false,"order":0,"category":"5571b37d31433c1900940986","editedParams2":true,"githubsync":"","version":"5569f8596637291700e426ea","link_url":"","slug":"get-services","type":"get","childrenPages":[]}

getList Services

Each place offers a set of services that can be booked online (menu).

Path Params

placeId:
required
string
Place ID

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5571da896d8908230061f3d7","link_external":false,"body":"","category":"5571b37d31433c1900940986","editedParams":true,"githubsync":"","excerpt":"","isReference":false,"project":"556785630145bc23008e3bb3","user":"55678558820d1a3700874dd4","hidden":false,"link_url":"","parentDoc":null,"title":"List Personnel (Service Providers)","__v":2,"createdAt":"2015-06-05T17:21:13.698Z","editedParams2":true,"type":"get","version":"5569f8596637291700e426ea","sync_unique":"","updates":[],"api":{"settings":"","url":"/v:version/places/:placeId/services/:serviceId/personnel","auth":"required","examples":{"codes":[{"language":"curl","code":"curl  \"https://api.pingup.com/v1/places/PLACE_ID/services/SERVICE_ID/personnel\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X GET","name":""}]},"method":"get","params":[{"desc":"Place ID","in":"path","name":"placeId","ref":"","required":true,"type":"string","_id":"5571dae68956493700aae1c9","default":""},{"name":"serviceId","ref":"","required":true,"type":"string","_id":"5571dae68956493700aae1c8","default":"","desc":"Service ID","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"meta-data\": {\n        \"code\": 200,\n        \"message\": \"OK\"\n    },\n    \"personnel\": [\n        {\n            \"id\": \"41316\",\n            \"fullName\": \"Tracy Anderson\",\n            \"gender\": \"FEMALE\",\n            \"description\": null\n        },\n        {\n            \"id\": \"248228\",\n            \"fullName\": \"Tiffany Boomer\",\n            \"gender\": \"FEMALE\",\n            \"description\": null\n        },\n        {\n            \"id\": \"41321\",\n            \"fullName\": \"Evan Breed\",\n            \"gender\": \"FEMALE\",\n            \"description\": null\n        },\n        {\n            \"id\": \"248227\",\n            \"fullName\": \"Katya Bryleva\",\n            \"gender\": \"FEMALE\",\n            \"description\": null\n        },\n        {\n            \"id\": \"41318\",\n            \"fullName\": \"Maria Davidson\",\n            \"gender\": \"FEMALE\",\n            \"description\": null\n        },\n        {\n            \"id\": \"274934\",\n            \"fullName\": \"Molly Griffin\",\n            \"gender\": \"FEMALE\",\n            \"description\": null\n        },\n        {\n            \"id\": \"83267\",\n            \"fullName\": \"Zerita Hamilton\",\n            \"gender\": \"FEMALE\",\n            \"description\": null\n        }\n    ]\n}","language":"json","status":200},{"status":400,"name":"","code":"{\n    \"httpStatus\": 400,\n    \"responseReference\": 40003,\n    \"message\": \"The request cannot be fulfilled due to bad syntax. \",\n    \"description\": \"Invalid placeId  value received. For more information visit documentation: http://developers.pingup.com/\"\n}","language":"json"}]}},"next":{"description":"","pages":[]},"order":1,"slug":"service-providers-personnel","childrenPages":[]}

getList Personnel (Service Providers)


Path Params

placeId:
required
string
Place ID
serviceId:
required
string
Service ID

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"58ee37d2d1ee2f0f0034a263","body":"","isReference":false,"link_external":false,"next":{"description":"","pages":[]},"order":2,"version":"5569f8596637291700e426ea","api":{"method":"get","params":[{"desc":"Place ID","default":"","type":"string","name":"placeId","_id":"5571e3771cd8283500a8b4ac","ref":"","in":"path","required":true},{"name":"serviceId","_id":"5571e3771cd8283500a8b4ab","ref":"","in":"path","required":true,"desc":"Service ID","default":"","type":"string"},{"ref":"","in":"query","required":true,"desc":"Start date for the listing of date availability. Format of this parameter is 'yyyy-mm-dd'. It must be passed in the route.","default":"","type":"yyyy-mm-dd","name":"startTime","_id":"5571e4a38956493700aae1e3"},{"desc":"End date for the listing of date availability.The difference between this parameter and 'startTime' can be interval bigger than a day (week, month, year). Format of this parameter is 'yyyy-mm-dd'. It must be passed in the route.","in":"query","name":"endTime","ref":"","required":true,"type":"yyyy-mm-dd","_id":"5571e4a38956493700aae1e2","default":""},{"in":"query","name":"personnelId","ref":"","required":false,"type":"string","_id":"5571e4a38956493700aae1e1","default":"","desc":"Id of the personnel performing the service. If this parameter is used, available days of the specified personnel will be returned. It's optional in the route."}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n    \"meta-data\": {\n        \"code\": 200,\n        \"message\": \"OK\"\n    },\n    \"availableTimeslots\" : [ \n\t     {\n          \"date\" : \"2017-04-12\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-13\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-14\",\n          \"isAvailable\" : false\n       }, \n\t     {\n          \"date\" : \"2017-04-15\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-16\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-17\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-18\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-19\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-20\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-21\",\n          \"isAvailable\" : false\n       }, \n\t     {\n          \"date\" : \"2017-04-22\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-23\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-24\",\n          \"isAvailable\" : true\n       }, \n\t     { \n          \"date\" : \"2017-04-25\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-26\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-27\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-28\",\n          \"isAvailable\" : false\n       }, \n\t     {\n          \"date\" : \"2017-04-29\",\n          \"isAvailable\" : true\n       }, \n\t     {\n          \"date\" : \"2017-04-30\",\n          \"isAvailable\" : true\n       } \n\t  ]\n}"},{"status":400,"name":"","code":"{\n    \"httpStatus\": 400,\n    \"responseReference\": 40055,\n    \"message\": \"Parameters invalid or missing\",\n    \"description\": \"Error in request. Missing query parameter. For more information visit documentation: http://developers.pingup.com/\"\n}","language":"json"}]},"settings":"","url":"/v:version/places/:placeId/services/:serviceId/availability","auth":"required","examples":{"codes":[{"language":"curl","code":"curl  \"https://api.pingup.com/v1/places/PLACE_ID/services/SERVICE_ID/availability?startTime=START_TIME&endTime=END_TIME\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X GET\n","name":""}]}},"hidden":false,"project":"556785630145bc23008e3bb3","excerpt":"","githubsync":"","sync_unique":"","type":"get","updates":[],"user":"5655ddfda66be71700968e03","createdAt":"2017-04-12T14:21:06.472Z","link_url":"","parentDoc":null,"slug":"list-date-availability","title":"List Date Availability","__v":0,"category":"5571b37d31433c1900940986","childrenPages":[]}

getList Date Availability


Path Params

placeId:
required
string
Place ID
serviceId:
required
string
Service ID

Query Params

startTime:
required
yyyy-mm-dd
Start date for the listing of date availability. Format of this parameter is 'yyyy-mm-dd'. It must be passed in the route.
endTime:
required
yyyy-mm-dd
End date for the listing of date availability.The difference between this parameter and 'startTime' can be interval bigger than a day (week, month, year). Format of this parameter is 'yyyy-mm-dd'. It must be passed in the route.
personnelId:
string
Id of the personnel performing the service. If this parameter is used, available days of the specified personnel will be returned. It's optional in the route.

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5571e3771cd8283500a8b4aa","category":"5571b37d31433c1900940986","createdAt":"2015-06-05T17:59:19.259Z","editedParams2":true,"excerpt":"","githubsync":"","next":{"description":"","pages":[]},"project":"556785630145bc23008e3bb3","__v":2,"api":{"settings":"","url":"/v:version/places/:placeId/services/:serviceId/timeSlots","auth":"required","examples":{"codes":[{"name":"","language":"curl","code":"curl  \"https://api.pingup.com/v1/places/PLACE_ID/services/SERVICE_ID/timeSlots?startTime=START_TIME&endTime=END_TIME&personnelId=PERSONNEL_ID\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X GET\n"}]},"method":"get","params":[{"in":"path","name":"placeId","ref":"","required":true,"type":"string","_id":"5571e3771cd8283500a8b4ac","default":"","desc":"Place ID"},{"default":"","desc":"Service ID","in":"path","name":"serviceId","ref":"","required":true,"type":"string","_id":"5571e3771cd8283500a8b4ab"},{"ref":"","required":true,"type":"yyyy-mm-dd","_id":"5571e4a38956493700aae1e3","default":"","desc":"Start date for the listing of the time slots. Format of this parameter is 'yyyy-mm-dd'. It must be passed in the route.","in":"query","name":"startTime"},{"ref":"","required":true,"type":"yyyy-mm-dd","_id":"5571e4a38956493700aae1e2","default":"","desc":"End date for the listing of the time slots.The difference between this parameter and 'startTime' must not be bigger than seven days. Format of this parameter is 'yyyy-mm-dd'. It must be passed in the route.","in":"query","name":"endTime"},{"desc":"Id of the personnel performing the service. If this parameter is used, all time slots of the specified personnel will be returned. It must be passed in the route.","in":"query","name":"personnelId","ref":"","required":false,"type":"string","_id":"5571e4a38956493700aae1e1","default":""}],"results":{"codes":[{"name":"","code":"{\n    \"meta-data\": {\n        \"code\": 200,\n        \"message\": \"OK\"\n    },\n    \"time_slots\": [\n        {\n            \"personnelId\": \"52948\",\n            \"duration\": 60,\n            \"startTime\": \"2015-07-01T06:00\",\n            \"timeZone\": \"-0400\",\n            \"price\": {\n                \"type\": \"EXACT\",\n                \"amount\": \"40.00\",\n                \"description\": null,\n                \"currency\": \"USD\"\n            },\n\t          \"generalParam\" : null\n        },\n        {\n            \"personnelId\": \"52948\",\n            \"duration\": 60,\n            \"startTime\": \"2015-07-01T07:00\",\n            \"timeZone\": \"-0400\",\n            \"price\": {\n                \"type\": \"EXACT\",\n                \"amount\": \"40.00\",\n                \"description\": null,\n                \"currency\": \"USD\"\n            },\n\t          \"generalParam\" : null\n        },\n        {\n            \"personnelId\": \"52948\",\n            \"duration\": 60,\n            \"startTime\": \"2015-07-01T08:00\",\n            \"timeZone\": \"-0400\",\n            \"price\": {\n                \"type\": \"EXACT\",\n                \"amount\": \"40.00\",\n                \"description\": null,\n                \"currency\": \"USD\"\n            },\n\t          \"generalParam\" : null\n        },\n        {\n            \"personnelId\": \"52948\",\n            \"duration\": 60,\n            \"startTime\": \"2015-07-01T09:00\",\n            \"timeZone\": \"-0400\",\n            \"price\": {\n                \"type\": \"EXACT\",\n                \"amount\": \"40.00\",\n                \"description\": null,\n                \"currency\": \"USD\"\n            },\n\t          \"generalParam\" : null\n        },\n        {\n            \"personnelId\": \"52948\",\n            \"duration\": 60,\n            \"startTime\": \"2015-07-01T10:00\",\n            \"timeZone\": \"-0400\",\n            \"price\": {\n                \"type\": \"EXACT\",\n                \"amount\": \"40.00\",\n                \"description\": null,\n                \"currency\": \"USD\"\n            },\n\t          \"generalParam\" : null\n        },\n        {\n            \"personnelId\": \"52948\",\n            \"duration\": 60,\n            \"startTime\": \"2015-07-01T11:00\",\n            \"timeZone\": \"-0400\",\n            \"price\": {\n                \"type\": \"EXACT\",\n                \"amount\": \"40.00\",\n                \"description\": null,\n                \"currency\": \"USD\"\n            },\n\t          \"generalParam\" : null\n        }\n    ]\n}","language":"json","status":200},{"name":"","code":"{\n    \"httpStatus\": 400,\n    \"responseReference\": 40056,\n    \"message\": \"The request cannot be fulfilled due to bad syntax. \",\n    \"description\": \"Error in request for time slots. Missing start parameter. For more information visit documentation: http://developers.pingup.com/\"\n}","language":"json","status":400}]}},"parentDoc":null,"slug":"time-slots-availability","sync_unique":"","updates":[],"version":"5569f8596637291700e426ea","body":"","link_url":"","order":3,"title":"List Time Slots (Availability)","editedParams":true,"hidden":false,"isReference":false,"link_external":false,"type":"get","user":"55678558820d1a3700874dd4","childrenPages":[]}

getList Time Slots (Availability)


Path Params

placeId:
required
string
Place ID
serviceId:
required
string
Service ID

Query Params

startTime:
required
yyyy-mm-dd
Start date for the listing of the time slots. Format of this parameter is 'yyyy-mm-dd'. It must be passed in the route.
endTime:
required
yyyy-mm-dd
End date for the listing of the time slots.The difference between this parameter and 'startTime' must not be bigger than seven days. Format of this parameter is 'yyyy-mm-dd'. It must be passed in the route.
personnelId:
string
Id of the personnel performing the service. If this parameter is used, all time slots of the specified personnel will be returned. It must be passed in the route.

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5571eab56d8908230061f404","editedParams":true,"link_url":"","title":"Create Appointment","type":"post","__v":7,"createdAt":"2015-06-05T18:30:13.086Z","editedParams2":true,"category":"5571b37d31433c1900940986","excerpt":"Create a new appointment.","githubsync":"","isReference":false,"link_external":false,"project":"556785630145bc23008e3bb3","body":"","updates":[],"slug":"appoitments","sync_unique":"","next":{"description":"","pages":[]},"order":4,"parentDoc":null,"user":"55678558820d1a3700874dd4","version":"5569f8596637291700e426ea","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl https://api.pingup.com/v1/appointments  \\\n-H \"token: ACCESS_TOKEN\" \\\n-d '{\"placeId\": PLACE_ID, \"serviceId\": SERVICE_ID, \"userId\": USER_ID, \"timeSlot\": {\"personnelId\": PERSONNEL_ID, \"startTime\": \"2014-05-15T07:30\", \"timeZone\": \"-0400\", \"price\": {\"type\": \"EXACT\", \"amount\": \"115.0\", \"description\": null, \"currency\": \"USD\" }, \"duration\": 75, \"generalParam\": \"\"}, \"customer\":{\"email\":\"joe@example.com\",\"firstName\":\"Joe\",\"lastName\":\"Doe\",\"phoneNumber\":\"(555) 555-5555\"}}' \\\n-X POST","name":""},{"code":"{\n  \"placeId\": \"20231\",\n  \"serviceId\": \"12276-843962\",\n  \"userId\": \"io8bg91p45nv6fbu5h8i9sseu3\",\n  \"timeSlot\":  {\n    \"personnelId\": \"120475\",\n    \"duration\": 75,\n    \"startTime\": \"2014-05-15T07:30\",\n    \"timeZone\": \"-0400\",\n    \"price\": {\n      \"type\": \"EXACT\",\n      \"amount\": \"115.0\",\n      \"description\": null,\n      \"currency\": \"USD\"\n    }\n  }\n}","language":"json"}]},"method":"post","params":[{"in":"body","required":false,"desc":"Place ID","default":"","type":"string","name":"placeId","_id":"566805d98639090d007592e3","ref":""},{"desc":"Service ID","default":"","type":"string","name":"serviceId","_id":"566807ba515adb0d0043e844","ref":"","in":"body","required":false},{"name":"userId","_id":"566807ba515adb0d0043e843","ref":"","in":"body","required":false,"desc":"User ID","default":"","type":"string"},{"ref":"","in":"body","required":false,"desc":"TimeSlot [PersonnelId]","default":"","type":"string","name":"timeSlot[personnelId]","_id":"566818d605cae40d00bea7e6"},{"in":"body","required":false,"desc":"TimeSlot [Duration]","default":"","type":"double","name":"timeSlot[duration]","_id":"566821e832fe4e0d0084f3b9","ref":""},{"required":false,"desc":"TimeSlot [Start Time]","default":"","type":"string","name":"timeSlot[startTime]","_id":"566821e832fe4e0d0084f3b8","ref":"","in":"body"},{"ref":"","in":"body","required":false,"desc":"TimeSlot [TimeZone]","default":"","type":"string","name":"timeSlot[timeZone]","_id":"566821e832fe4e0d0084f3b7"},{"default":"","type":"object","name":"timeSlot[price]","_id":"566821e832fe4e0d0084f3b6","ref":"","in":"body","required":false,"desc":"TimeSlot [Price]"},{"ref":"","required":false,"type":"string","_id":"58ef40bc303ea40f00c2ed87","default":"","desc":"Customer [E-mail address]","in":"body","name":"customer[email]"},{"desc":"Customer [First name]","in":"body","name":"customer[firstName]","ref":"","required":false,"type":"string","_id":"58ef40bc303ea40f00c2ed86","default":""},{"name":"customer[lastName]","ref":"","required":false,"type":"string","_id":"58ef40bc303ea40f00c2ed85","default":"","desc":"Customer [Last name]","in":"body"},{"_id":"58ef40bc303ea40f00c2ed84","default":"","desc":"Customer [Phone number]","in":"body","name":"customer[phoneNumber]","ref":"","required":false,"type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"meta-data\":{  \n      \"code\":200,\n      \"message\":\"OK\"\n   },\n   \"appointment\":{  \n      \"id\":\"btm43a5n4a35c66uu6j9gamk339\",\n      \"status\":\"SCHEDULED\",\n      \"placeId\":\"20231\",\n      \"startTime\":\"2014-05-15T07:30\",\n      \"endTime\":\"2014-05-15T08:45\",\n      \"timeZone\":\"-0400\",\n      \"customer\":{  \n         \"email\":\"joe@example.com\",\n         \"firstName\":\"Joe\",\n         \"lastName\":\"Doe\",\n         \"phoneNumber\":\"(555) 555-5555\"\n      },\n      \"personnel\":{  \n         \"id\":\"120475\",\n         \"fullName\":\"Maureen\",\n         \"gender\":\"FEMALE\",\n         \"description\":\"Licensed aesthetician\\r\\nAdvanced lash certified \\r\\n\\r\\n\"\n      },\n      \"service\":{  \n         \"id\":\"12276-843962\",\n         \"type\":\"APPOINTMENT\",\n         \"category\":\"Facials\",\n         \"description\":\"This Galvanic treatment uses negatively charged gel and current to loosen dead skin, oils and dirt from the epidermis. Positively charged gel rich with nutrients is then forced into the deep layers of the skin with a positive current. This is a wonderful way to fresh and lighten ones appearance, giving results you can truly see, Most also see improvement in the muscle and skin tone in just one treatment! \",\n         \"name\":\"Weekly Galvanic Facial Treatment\",\n         \"duration\":20,\n         \"price\":{  \n            \"type\":\"EXACT\",\n            \"amount\":\"115.0\",\n            \"description\":null,\n            \"currency\":\"USD\"\n         },\n         \"payments\" : null\n      },\n      \"place\":{  \n         \"id\":\"20231\",\n         \"name\":\"Tracy Anderson Method NYC\",\n         \"phoneNumber\":\"2129651408\",\n         \"webSite\":\"http://www.tracyandersonmethod.com\",\n         \"description\":\"With years of research based on her former training as a dancer, Tracy has developed her very own unique approach to fitness. Her method for transforming the body is based on targeting the accessory muscles (the small muscle groups). Strengthening the accessory muscles help to create a tight knit group of small muscles that actually pull in the larger muscle groups. Strengthening the accessory muscles help to create a tight knit group of small muscles that actually pull in the larger muscle groups. This results in a lean figure without the extra bulk - which gives women a tiny dancer body and men a skinny ripped body.\",\n         \"logoUrl\" : \"http://booknow.pingup.com/public/images/business/default-logo.png\",\n         \"pingupUrl\":\"http://booknow.pingup.com/b/1374767164507\",\n         \"lastModified\":null,\n         \"categories\":[  \n            {  \n               \"id\":\"791\",\n               \"parentId\":\"486\",\n               \"name\":\"Healthcare\",\n               \"fullName\":\"Healthcare\"\n            },\n            {  \n               \"id\":\"1256\",\n               \"parentId\":\"1226\",\n               \"name\":\"Health and Diet Food\",\n               \"fullName\":\"Retail > Food and Beverage > Health and Diet Food\"\n            }\n         ],\n         \"address\":{  \n            \"addressLine1\":\"24 Hubert Street\",\n            \"addressLine2\":null,\n            \"locality\":\"New York\",\n            \"region\":\"NY\",\n            \"postCode\":\"10013\",\n            \"country\":{  \n               \"abbreviation\":\"US\",\n               \"name\":\"United States\"\n            },\n            \"geo\":{  \n               \"latitude\":40.7215035,\n               \"longitude\":-74.0101024\n            },\n            \"timeZone\":\"US/Eastern\",\n         },\n         \"status\":\"ACTIVE\",\n         \"bookingType\":[\"APPOINTMENT\"],\n         \"factualId\":null\n      }\n   }\n}","name":""},{"name":"","status":400,"language":"json","code":"{\n  \"httpStatus\": 400,\n  \"responseReference\": 40,\n  \"message\": \"The request cannot be fulfilled due to bad syntax. \",\n  \"description\": \"Specified appointment time is not available\"\n}\n"}]},"settings":"","url":"/v:version/appointments"},"hidden":false,"childrenPages":[]}

postCreate Appointment

Create a new appointment.

Body Params

placeId:
string
Place ID
serviceId:
string
Service ID
userId:
string
User ID
timeSlot[personnelId]:
string
TimeSlot [PersonnelId]
timeSlot[duration]:
double
TimeSlot [Duration]
timeSlot[startTime]:
string
TimeSlot [Start Time]
timeSlot[timeZone]:
string
TimeSlot [TimeZone]
timeSlot[price]:
object
TimeSlot [Price]
customer[email]:
string
Customer [E-mail address]
customer[firstName]:
string
Customer [First name]
customer[lastName]:
string
Customer [Last name]
customer[phoneNumber]:
string
Customer [Phone number]

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5571f0228956493700aae215","api":{"method":"get","params":[{"desc":"User ID","default":"","type":"string","name":"userId","_id":"5571f0228956493700aae21b","ref":"","in":"query","required":true},{"name":"placeId","_id":"58ef49012c4ffc390008ae53","ref":"","in":"query","required":true,"desc":"Place / Business Id","default":"","type":"string"},{"ref":"","in":"query","required":false,"desc":"This offsets the start of each page by the number specified.","default":"0","type":"string","name":"offset","_id":"5571f0228956493700aae21a"},{"default":"20","type":"string","name":"limit","_id":"5571f0228956493700aae219","ref":"","in":"query","required":false,"desc":"This is the number of individual objects that are returned in each page. Maximum value: 50"},{"in":"query","required":false,"desc":"This is the appointment status. Possible values are: PENDING, SCHEDULED, COMPLETED, CANCELLED, NO_SHOW","default":"","type":"string","name":"status","_id":"5571f0228956493700aae218","ref":""},{"required":false,"desc":"It will return only appointments that are scheduled after specified date (included that date). Format of this parameter is 'yyyy-mm-dd'","default":"","type":"yyyy-mm-dd","name":"dateFrom","_id":"5571f0228956493700aae217","ref":"","in":"query"},{"ref":"","in":"query","required":false,"desc":"It will return only appointments that are scheduled before specified date (included that date). Format of this parameter is 'yyyy-mm-dd'","default":"","type":"yyyy-mm-dd","name":"dateTo","_id":"5571f0228956493700aae216"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n   \"meta-data\":    {\n      \"code\": 200,\n      \"message\": \"OK\",\n      \"totalResults\": 24,\n      \"offset\": 0,\n      \"limit\": 20,\n      \"prev\": \"\",\n      \"next\": \"https://api.pingup.com/v1/appointments?offset=20&limit=20&userId=io8bg91p45nv6fbu5h8i9sseu3\"\n   },\n   \"appointments\":    [\n            {\n         \"id\": \"b1ggjdnlb6e4jsi7hvmbd09aa9c\",\n         \"status\": \"CANCELLED\",\n         \"placeId\": \"20231\",\n         \"startTime\": \"2014-05-20T11:00\",\n         \"endTime\": \"2014-05-20T11:20\",\n         \"timeZone\": \"-0500\",\n         \"customer\": {\n            \"email\": \"joe@example.com\",\n            \"firstName\": \"Joe\",\n            \"lastName\": \"Doe\",\n            \"phoneNumber\": \"(555) 555-5555\"\n         },\n         \"personnel\":          {\n            \"id\": \"241508\",\n            \"fullName\": \"Beverly Walters\",\n\t          \"gender\": \"MALE\",\n            \"description\": null\n         },\n         \"service\":          {\n            \"id\": \"12486-211888\",\n            \"type\": \"APPOINTMENT\",\n            \"category\": \"Waxing\",\n            \"description\": \"Duration may vary.\",\n            \"name\": \"Chin Tweezing\",\n            \"duration\": 20,\n            \"price\":             {\n               \"type\": \"EXACT\",\n               \"amount\": \"10.0\",\n               \"description\": null,\n               \"currency\": \"USD\"\n            },\n            \"payments\": null\n         },\n         \"place\": {\n         \"id\": \"20231\",\n         \"uniqueId\": \"B8nz1y\",\n         \"name\": \"Tracy Anderson Method NYC\",\n         \"phoneNumber\": \"2129651408\",\n         \"webSite\": \"http://www.tracyandersonmethod.com\",\n         \"description\": \"With years of research based on her former training as a dancer, Tracy has developed her very own unique approach to fitness. Her method for transforming the body is based on targeting the accessory muscles (the small muscle groups). Strengthening the accessory muscles help to create a tight knit group of small muscles that actually pull in the larger muscle groups. Strengthening the accessory muscles help to create a tight knit group of small muscles that actually pull in the larger muscle groups. This results in a lean figure without the extra bulk - which gives women a tiny dancer body and men a skinny ripped body.\",\n         \"logoUrl\": \"http://booknow.pingup.com/public/images/business/default-logo.png\",\n         \"pingupUrl\": \"http://booknow.pingup.com/b/1374767164507\",\n         \"lastModified\": null,\n         \"categories\": [\n           {\n             \"id\": \"791\",\n\t           \"parentId\": \"486\",\n             \"name\": \"Healthcare\",\n             \"fullName\": \"Healthcare\"\n           },\n           {\n             \"id\": \"1256\",\n\t           \"parentId\": \"1226\",\n             \"name\": \"Health and Diet Food\",\n             \"fullName\": \"Retail > Food and Beverage > Health and Diet Food\"\n           }\n         ],\n         \"address\": {\n            \"addressLine1\": \"24 Hubert Street\",\n            \"addressLine2\": null,\n            \"locality\": \"New York\",\n            \"region\": \"NY\",\n            \"postCode\": \"10013\",\n            \"country\":             {\n               \"abbreviation\": \"US\",\n               \"name\": \"United States\"\n            },\n            \"geo\":             {\n               \"latitude\": 40.7215035,\n               \"longitude\": -74.0101024\n            },\n            \"timeZone\":\"US/Eastern\",\n         },\n         \"status\": \"ACTIVE\",\n         \"bookingType\": [\"APPOINTMENT\"],\n         \"factualId\": null\n      }\n   },\n   ...\n   ]\n}"},{"status":400,"language":"json","code":"{\n  \"httpStatus\": 400,\n  \"responseReference\": 40003,\n  \"message\": \"The request cannot be fulfilled due to bad syntax. \",\n  \"description\": \"Invalid placeId value received. For more information visit documentation: http://developers.pingup.com/\"\n}\n","name":""}]},"settings":"","url":"/v:version/appointments","auth":"required","examples":{"codes":[{"language":"curl","code":"curl  \"https://api.pingup.com/v1/appointments?placeId=PLACE_ID&userId=USER_ID&offset=0&limit=10\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X GET","name":""}]}},"editedParams2":true,"link_external":false,"link_url":"","order":5,"slug":"list-appoitments","__v":1,"user":"55678558820d1a3700874dd4","type":"get","editedParams":true,"isReference":false,"parentDoc":null,"version":"5569f8596637291700e426ea","category":"5571b37d31433c1900940986","project":"556785630145bc23008e3bb3","sync_unique":"","title":"List Appointments","hidden":false,"createdAt":"2015-06-05T18:53:22.847Z","excerpt":"","githubsync":"","next":{"pages":[],"description":""},"updates":[],"body":"","childrenPages":[]}

getList Appointments


Query Params

userId:
required
string
User ID
placeId:
required
string
Place / Business Id
offset:
string0
This offsets the start of each page by the number specified.
limit:
string20
This is the number of individual objects that are returned in each page. Maximum value: 50
status:
string
This is the appointment status. Possible values are: PENDING, SCHEDULED, COMPLETED, CANCELLED, NO_SHOW
dateFrom:
yyyy-mm-dd
It will return only appointments that are scheduled after specified date (included that date). Format of this parameter is 'yyyy-mm-dd'
dateTo:
yyyy-mm-dd
It will return only appointments that are scheduled before specified date (included that date). Format of this parameter is 'yyyy-mm-dd'

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5571f11c1cd8283500a8b4e2","createdAt":"2015-06-05T18:57:32.162Z","excerpt":"Create User.","isReference":false,"link_url":"","project":"556785630145bc23008e3bb3","slug":"create-user","sync_unique":"","__v":3,"version":"5569f8596637291700e426ea","category":"5571b37d31433c1900940986","editedParams2":true,"link_external":false,"order":6,"api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl https://api.pingup.com/v1/auth/customer/registration  \\\n-H \"token: ACCESS_TOKEN\" \\\n-d '{ \"email\":\"joe@example.com\", \"password\":\"password123\", \"apiKey\":\"123\", \"apiSecret\":\"abc\" }' \\\n-X POST","name":""},{"language":"json","code":"{\n  \"firstName\":\"Joe\",\n  \"lastName\":\"Doe\",\n  \"phoneNumber\":\"(555) 555-5555\",\n  \"email\":\"joe@example.com\"\n}"}]},"method":"post","params":[{"required":false,"type":"string","_id":"5571f1d41cd8283500a8b4e9","default":"","desc":"E-mail address","in":"body","name":"email","ref":""},{"in":"body","name":"password","ref":"","required":false,"type":"string","_id":"5571f1d41cd8283500a8b4e8","default":"","desc":"Password"},{"default":"","desc":"API key","in":"body","name":"apiKey","ref":"","required":false,"type":"string","_id":"5571f1d41cd8283500a8b4e7"},{"desc":"API secret","in":"body","name":"apiSecret","ref":"","required":false,"type":"string","_id":"5571f1d41cd8283500a8b4e6","default":""}],"results":{"codes":[{"language":"json","code":"{\n   \"meta-data\":    {\n     \"code\": 200,\n     \"message\": \"OK\"\n   },\n   \"token\":    {\n     \"accessToken\" : \"12345\",\n     \"tokenExpiration\" : 1494602170119,\n     \"refreshToken\" : \"12345\",\n     \"userId\" : \"4e2lqpb1v92seb6ttjgqd0ldev\"\n   }\n}","name":"","status":200},{"code":"{\n  \"httpStatus\": 400,\n  \"responseReference\": 40000,\n  \"message\": \"The request cannot be fulfilled due to bad syntax. \",\n  \"description\": \"The provided secret and key parameters are invalid. For more information visit documentation: http://developers.pingup.com/\"\n}   \n","name":"","status":400,"language":"json"}]},"settings":"","url":"/v:version/auth/customer/registration"},"editedParams":true,"githubsync":"","hidden":false,"next":{"description":"","pages":[]},"body":"","parentDoc":null,"title":"Create User","type":"post","updates":[],"user":"55678558820d1a3700874dd4","childrenPages":[]}

postCreate User

Create User.

Body Params

email:
string
E-mail address
password:
string
Password
apiKey:
string
API key
apiSecret:
string
API secret

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5571f5421cd8283500a8b506","editedParams":true,"excerpt":"Update User","githubsync":"","hidden":false,"parentDoc":null,"category":"5571b37d31433c1900940986","editedParams2":true,"isReference":false,"updates":[],"version":"5569f8596637291700e426ea","__v":3,"api":{"params":[{"required":true,"type":"string","_id":"5571f5c16d8908230061f450","default":"","desc":"User ID","in":"path","name":"userId","ref":""},{"name":"firstName","ref":"","required":false,"type":"string","_id":"5571f6a41cd8283500a8b50f","default":"","desc":"First name","in":"body"},{"type":"string","_id":"5571f6a41cd8283500a8b50e","default":"","desc":"Last name","in":"body","name":"lastName","ref":"","required":false},{"required":false,"type":"string","_id":"5571f6a41cd8283500a8b50d","default":"","desc":"Phone Number","in":"body","name":"phoneNumber","ref":""},{"in":"body","name":"email","ref":"","required":false,"type":"string","_id":"5571f6a41cd8283500a8b50c","default":"","desc":"E-mail address"}],"results":{"codes":[{"name":"","code":"{  \n   \"meta-data\":{  \n      \"code\":200,\n      \"message\":\"OK\"\n   },\n   \"user\":{  \n      \"id\":\"4e2lqpb1v92seb6ttjgqd0ldev\",\n      \"firstName\":\"Joe\",\n      \"lastName\":\"Doe\",\n      \"phoneNumber\":\"(555) 555-5555\",\n      \"email\":\"joe@example.com\"\n   }\n}","language":"json","status":200},{"language":"json","status":401,"name":"","code":"{\n  \"httpStatus\": 401,\n  \"responseReference\": 40102,\n  \"message\": \"Unauthorized to complete operation. \",\n  \"description\": \"Check if you are using proper prod API key. For more information visit documentation: http://developers.pingup.com/\"\n}"}]},"settings":"","url":"/v:version/users/:userId","auth":"required","examples":{"codes":[{"name":"","code":"curl https://api.pingup.com/v1/users/USER_ID  \\\n-H \"token: ACCESS_TOKEN\" \\\n-d '{ \"firstName\":\"Joe\", \"lastName\":\"Doe\", \"phoneNumber\":\"(555) 555-5555\", \"email\":\"joe@example.com\" }' \\\n-X PUT","language":"curl"},{"language":"json","code":"{  \n   \"firstName\":\"Joe\",\n   \"lastName\":\"Doe\",\n   \"phoneNumber\":\"(555) 555-5555\",\n   \"email\":\"joe@example.com\"\n}"}]},"method":"put"},"createdAt":"2015-06-05T19:15:14.879Z","link_url":"","slug":"users-1","title":"Update User","user":"55678558820d1a3700874dd4","body":"","link_external":false,"next":{"pages":[],"description":""},"order":7,"project":"556785630145bc23008e3bb3","sync_unique":"","type":"put","childrenPages":[]}

putUpdate User

Update User

Path Params

userId:
required
string
User ID

Body Params

firstName:
string
First name
lastName:
string
Last name
phoneNumber:
string
Phone Number
email:
string
E-mail address

User Information

Try It Out

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5571f4598956493700aae239","body":"","excerpt":"Delete User","githubsync":"","slug":"users","title":"Deactivate User","updates":[],"api":{"params":[{"default":"","desc":"User ID","name":"userId","required":true,"type":"string","in":"path","_id":"5571f4b01cd8283500a8b4ff"}],"results":{"codes":[{"name":"","code":"{  \n   \"meta-data\":{  \n      \"code\":200,\n      \"message\":\"OK\"\n   },\n   \"user\":{  \n      \"id\":\"4e2lqpb1v92seb6ttjgqd0ldev\",\n      \"firstName\":\"Joe\",\n      \"lastName\":\"Doe\",\n      \"phoneNumber\":\"(555) 555-5555\",\n      \"email\":\"joe@example.com\"\n   }\n}","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{}"}]},"settings":"","url":"/v:version/users/:userId","auth":"required","examples":{"codes":[{"code":"curl  \"https://api.pingup.com/v1/users/USER_ID\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X DELETE","name":"","language":"json"}]},"method":"delete"},"type":"delete","__v":1,"hidden":false,"parentDoc":null,"sync_unique":"","user":"55678558820d1a3700874dd4","version":"5569f8596637291700e426ea","link_url":"","order":8,"category":"5571b37d31433c1900940986","createdAt":"2015-06-05T19:11:21.024Z","editedParams":true,"editedParams2":true,"link_external":false,"project":"556785630145bc23008e3bb3","childrenPages":[]}

deleteDeactivate User

Delete User

Path Params

userId:
required
string
User ID

User Information

Try It Out

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"58ef7685f8dd1f1b00c1973b","isReference":false,"updates":[],"user":"5655ddfda66be71700968e03","version":"5569f8596637291700e426ea","excerpt":"Provides the menu for a restaurant","githubsync":"","link_external":false,"parentDoc":null,"slug":"restaurant-menu","type":"get","api":{"url":"/v:version/restaurants/:placeId","method":"get","examples":{"codes":[{"language":"curl","code":"curl  \"https://api.pingup.com/v1/restaurants/PLACE_ID\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X GET"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta-data\" : {\n    \"code\" : 200,\n\t  \"message\" : \"OK\"\n  },\n  \"restaurant\" : {\n    \"order_minimum\" : \"25.00\",\n\t  \"order_fee\": \"5.00\",\n    \"sales_tax\": \"0.55\",\n    \"delivery_fee_taxable\": true,\n\t  \"menu\" : [ {\n\t    \"category\" : \"Pizza\",\n\t    \"items\" : [ {\n\t\t    \"menu_item_id\": \"1\",\n\t      \"category\" : \"Pizza\",\n\t\t    \"name\" : \"Carbonara\",\n\t\t    \"description\" : \"Pizza with carbonara sauce\",\n\t\t    \"price\" : \"10.00\",\n\t\t    \"favorite\" : false,\n\t\t    \"menu_item_options\" : [{\n\t\t      \"required\" : false,\n\t\t      \"option_type\": \"multi\",\n\t\t      \"options\": [{\n\t\t        \"menu_item_option_id\" : \"12\",\n\t\t\t      \"name\" : \"Ketchup\",\n\t\t\t      \"price\": \"2.50\"\n\t\t      }]\n\t\t    }]\n\t    }, \n      {\n    \t  \"menu_item_id\": \"2\",\n\t      \"category\" : \"Pizza\",\n\t\t    \"name\" : \"Capricciosa\",\n\t\t    \"description\" : \"Pizza Capricciosa\",\n\t\t    \"price\" : \"3.00\",\n\t\t    \"favorite\" : true,\n\t\t    \"menu_item_options\" : [{\n\t\t      \"required\" : false,\n\t\t      \"option_type\": \"single\",\n\t\t      \"options\": [{\n\t\t        \"menu_item_option_id\" : \"15\",\n\t\t\t      \"name\" : \"Mushrooms\",\n\t\t\t      \"price\": \"5.00\"\n\t\t      }, \n          {\n\t\t        \"menu_item_option_id\" : \"9\",\n\t\t\t      \"name\" : \"Cheese\",\n\t\t\t      \"price\": \"7.00\"\t\t  \n\t\t      }]\n\t\t    }]\n\t    }]\n\t  }, \n    {\n\t    \"category\" : \"Salads\",\n\t    \"items\" : [ \n      {\n\t\t    \"menu_item_id\": \"1\",\n\t      \"category\" : \"Salads\",\n\t\t    \"name\" : \"Supreme Garden Salad\",\n\t\t    \"description\" : \"Lettuce, tomatoes, cucumbers, red onions, green peppers, shredded carrots and red cabagge\",\n\t\t    \"price\" : \"10.00\",\n\t\t    \"favorite\" : false,\n\t\t    \"menu_item_options\" : [{\n\t\t      \"required\" : false,\n\t\t      \"option_type\": \"single\",\n\t\t      \"options\": [{\n\t\t        \"menu_item_option_id\" : \"17\",\n\t\t\t      \"name\" : \"Ranch Dressing\",\n\t\t\t      \"price\": \"1.50\"\n\t\t      }]\n\t\t    }]\n\t    }]\t\t\n\t  }]\n  }\n}\n","name":""},{"status":500,"language":"json","code":"{\n\t\"meta-data\": {\n\t\t\"code\": 500,\n\t\t\"message\": \"An internal error has occurred.\"\n\t}\n}","name":""}]},"settings":"","auth":"required","params":[{"desc":"Place ID","default":"","type":"string","name":"placeId","_id":"58ef7685f8dd1f1b00c1973c","ref":"","in":"path","required":true}]},"body":"","createdAt":"2017-04-13T13:00:53.392Z","hidden":false,"link_url":"","next":{"pages":[],"description":""},"sync_unique":"","__v":0,"order":0,"project":"556785630145bc23008e3bb3","title":"Restaurant menu","category":"58ef53812c4ffc390008af3d","childrenPages":[]}

getRestaurant menu

Provides the menu for a restaurant

Path Params

placeId:
required
string
Place ID

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"58ef7a23f8dd1f1b00c1979f","parentDoc":null,"excerpt":"Provides additional information about a restaurant menu delivery.","order":1,"hidden":false,"link_url":"","updates":[],"body":"","createdAt":"2017-04-13T13:16:19.351Z","next":{"pages":[],"description":""},"project":"556785630145bc23008e3bb3","slug":"delivery-possibility","type":"get","user":"5655ddfda66be71700968e03","version":"5569f8596637291700e426ea","githubsync":"","category":"58ef53812c4ffc390008af3d","isReference":false,"link_external":false,"sync_unique":"","title":"Delivery Possibility","__v":1,"api":{"method":"get","examples":{"codes":[{"code":"curl  \"https://api.pingup.com/v1/restaurants/PLACE_ID/delivery_possibility?address=316%20W.%20Washington%20Ave.%2C%20Madison%2C%20WI%2053703\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X GET","language":"curl"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta-data\" : {\n    \"code\" : 200,\n\t  \"message\" : \"OK\"\n  },\n  \"delivery\": {\n\t\t\"possible\": true,\n\t\t\"cost\": \"0.00\",\n\t\t\"min_price\": \"0.00\",\n\t\t\"min_time\": 35,\n\t\t\"max_time\": 50\n\t}\n}","name":""},{"status":500,"language":"json","code":"{\n\t\"meta-data\": {\n\t\t\"code\": 500,\n\t\t\"message\": \"An internal error has occurred.\"\n\t}\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"58ef7a23f8dd1f1b00c197a0","ref":"","in":"path","required":true,"desc":"Place ID","default":"","type":"string","name":"placeId"},{"_id":"5952519bf8a1ac001b0f693e","ref":"","in":"query","required":false,"desc":"An address to determine delivery cost and order minimum price. If exist it should contain street address at least.","default":"316 W. Washington Ave., Madison, WI 53703","type":"string","name":"address"}],"url":"/v:version/restaurants/:placeId/delivery_possibility"},"childrenPages":[]}

getDelivery Possibility

Provides additional information about a restaurant menu delivery.

Path Params

placeId:
required
string
Place ID

Query Params

address:
string316 W. Washington Ave., Madison, WI 53703
An address to determine delivery cost and order minimum price. If exist it should contain street address at least.

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"58ef89ca9f17721b00587eb4","__v":0,"category":"58ef53812c4ffc390008af3d","createdAt":"2017-04-13T14:23:06.792Z","parentDoc":null,"sync_unique":"","version":"5569f8596637291700e426ea","api":{"method":"get","examples":{"codes":[{"language":"curl","code":"curl  \"https://api.pingup.com/v1/restaurants/PLACE_ID/menu_items/MENU_ITEM_ID\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X GET"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta-data\" : {\n    \"code\" : 200,\n\t  \"message\" : \"OK\"\n  },\n\t\"menu_item_id\": \"1\",\n\t\"category\" : \"Pizza\",\n  \"name\" : \"Carbonara\",\n\t\"description\" : \"Pizza with carbonara sauce\",\n\t\"price\" : \"10.00\",\n\t\"favorite\" : false,\n\t\"menu_item_options\" : [\n\t{\n\t\t\"required\" : true,\n\t\t\"option_type\": \"multi\",\n\t\t\"options\": [\n\t\t{\n\t\t  \"menu_item_option_id\" : \"12\",\n\t\t\t\"name\" : \"Ketchup\",\n\t\t\t\"price\": \"2.50\"\n\t\t}]\n\t}]\n}","name":""},{"status":500,"language":"json","code":"{\n\t\"meta-data\": {\n\t\t\"code\": 500,\n\t\t\"message\": \"An internal error has occurred.\"\n\t}\n}","name":""}]},"settings":"","auth":"required","params":[{"name":"placeId","_id":"58ef89ca9f17721b00587eb6","ref":"","in":"path","required":true,"desc":"Place ID","default":"","type":"string"},{"ref":"","in":"path","required":true,"desc":"Menu Item ID","default":"","type":"string","name":"menuItemId","_id":"58ef89ca9f17721b00587eb5"}],"url":"/v:version/restaurants/:placeId/menu_items/:menuItemId"},"link_external":false,"project":"556785630145bc23008e3bb3","slug":"single-menu-item","user":"5655ddfda66be71700968e03","githubsync":"","isReference":false,"link_url":"","next":{"pages":[],"description":""},"updates":[],"body":"","excerpt":"Retrieves Menu Item","hidden":false,"order":2,"title":"Single Menu Item","type":"get","childrenPages":[]}

getSingle Menu Item

Retrieves Menu Item

Path Params

placeId:
required
string
Place ID
menuItemId:
required
string
Menu Item ID

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"58ef8dd43ecbd60f00ddc02b","link_external":false,"project":"556785630145bc23008e3bb3","__v":0,"body":"","excerpt":"Creates shopping cart","hidden":false,"type":"post","githubsync":"","link_url":"","next":{"pages":[],"description":""},"version":"5569f8596637291700e426ea","order":3,"parentDoc":null,"updates":[],"user":"5655ddfda66be71700968e03","slug":"create-cart","sync_unique":"","title":"Create Cart","api":{"method":"post","examples":{"codes":[{"code":"curl  \"https://api.pingup.com/v1/restaurants/PLACE_ID/carts\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X POST","language":"curl"}]},"results":{"codes":[{"code":"{\n  \"meta-data\" : {\n    \"code\" : 200,\n\t  \"message\" : \"OK\"\n  },\n  \"shoppingCartId\" : \"12345\"\n}","name":"","status":200,"language":"json"},{"name":"","status":500,"language":"json","code":"{\n\t\"meta-data\": {\n\t\t\"code\": 500,\n\t\t\"message\": \"An internal error has occurred.\"\n\t}\n}"}]},"settings":"","auth":"required","params":[{"type":"string","name":"placeId","_id":"58ef8dd43ecbd60f00ddc02c","ref":"","in":"path","required":true,"desc":"Place ID","default":""}],"url":"/v:version/restaurants/:placeId/carts"},"category":"58ef53812c4ffc390008af3d","createdAt":"2017-04-13T14:40:20.666Z","isReference":false,"childrenPages":[]}

postCreate Cart

Creates shopping cart

Path Params

placeId:
required
string
Place ID

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"58ef932e3ecbd60f00ddc247","hidden":false,"isReference":false,"project":"556785630145bc23008e3bb3","sync_unique":"","link_external":false,"order":4,"body":"","category":"58ef53812c4ffc390008af3d","createdAt":"2017-04-13T15:03:10.452Z","githubsync":"","next":{"pages":[],"description":""},"parentDoc":null,"slug":"add-menu-items","type":"post","__v":1,"excerpt":"Add menu item in shopping cart","link_url":"","version":"5569f8596637291700e426ea","api":{"method":"post","params":[{"_id":"58ef932e3ecbd60f00ddc24b","ref":"","in":"path","required":true,"desc":"Cart ID","default":"","type":"string","name":"cartId"},{"_id":"58ef932e3ecbd60f00ddc24a","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"itemId"},{"_id":"58ef932e3ecbd60f00ddc249","ref":"","in":"body","required":false,"desc":"","default":"","type":"int","name":"itemQuantity"},{"_id":"58ef932e3ecbd60f00ddc248","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"itemName"},{"_id":"59525e9fc86ac3003f370f18","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"itemCategoryName"},{"_id":"59525e9fc86ac3003f370f17","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"itemDescription"},{"_id":"59525e9fc86ac3003f370f16","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"itemPrice"},{"_id":"59525e9fc86ac3003f370f15","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"specialInstructions"},{"_id":"59525e9fc86ac3003f370f14","ref":"","in":"body","required":false,"desc":"Contains list of item options. Required fields: optionId, optionName, optionPrice.","default":"","type":"array_string","name":"itemOptions"}],"results":{"codes":[{"name":"","code":"{\n  \"meta-data\" : {\n    \"code\" : 200,\n\t  \"message\" : \"OK\"\n  },\n  \"results\": [\n    {\n\t\t\t\"cartItemId\": \"4d0f5aa8-8330-4029-bfb2-0103a841c8c3\",\n\t\t\t\"itemId\": \"11947769\"\n\t\t},\n\t\t{\n\t\t\t\"cartItemId\": \"9f6d82d5-6ec9-4b0e-a78b-f9505f015380\",\n\t\t\t\"itemId\": \"11948050\"\n\t\t}\n\t]\t\n} ","language":"json","status":200},{"name":"","code":"{\n\t\"meta-data\": {\n\t\t\"code\": 400,\n\t\t\"message\": \"Error in request. Cart item list should be populated.\"\n\t}\n}","language":"json","status":400}]},"settings":"","url":"/v:version/carts/:cartId/menu_items","auth":"required","examples":{"codes":[{"language":"curl","code":"curl  \"https://api.pingup.com/v1/carts/CART_ID/menu_items\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-d '[{\"itemId\":\"11947769\",\"itemCategoryName\":\"Curry Entrees\",\"itemName\":\"Squash Curry - Chicken\",\n \"itemDescription\":\"Red and Yellow Curry Coconut Milk with Squash, Potatoes, Green Bean & Bamboo Shoot. Choice of Chicken, Beef, Pork, Tofu or Shrimp.\",\n\"itemPrice\":\"6.95\",\"specialInstructions\":\"Not salted\",\n\"itemOptions\":[{\"optionId\":\"9454236\",\"optionName\":\"Extra White Rice\",\"optionPrice\":\"1.00\"},\n{\"optionId\":\"9454238\",\"optionName\":\"Bread\",\"optionPrice\":\"1.50\"}]},\n{\"itemId\":\"11948050\",\"itemCategoryName\":\"Football Special Pizzas\",\"itemName\":\"Giardiniera Peppers\",\n\"itemPrice\":\"10.00\",\"itemOptions\":[{\"optionId\":\"105331737\",\"optionName\":\"2nd Half\",\"optionPrice\":\"1.10\"}]}]' \\\n-X POST"}]}},"title":"Add Menu Items","updates":[],"user":"5655ddfda66be71700968e03","childrenPages":[]}

postAdd Menu Items

Add menu item in shopping cart

Path Params

cartId:
required
string
Cart ID

Body Params

itemId:
required
string
itemQuantity:
integer
itemName:
string
itemCategoryName:
string
itemDescription:
string
itemPrice:
string
specialInstructions:
string
itemOptions:
array of strings
Contains list of item options. Required fields: optionId, optionName, optionPrice.

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"58ef951f3ecbd60f00ddc292","githubsync":"","isReference":false,"order":6,"slug":"update-menu-item","sync_unique":"","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl https://api.pingup.com/v1/carts/CART_ID/cart_items/CART_ITEM_ID  \\\n-H \"token: ACCESS_TOKEN\" \\\n-d '{\"itemId\":\"11948050\",\"itemQuantity\":3,\"itemCategoryName\":\"Football Special Pizzas\",\"itemName\":\"Giardiniera Peppers\",\n\"itemPrice\":\"10.00\",\"itemOptions\":[{\"optionId\":\"105331737\",\"optionName\":\"2nd Half\",\"optionPrice\":\"1.10\"}]}' \\\n-X PUT"}]},"method":"put","params":[{"_id":"58ef951f3ecbd60f00ddc297","ref":"","in":"path","required":true,"desc":"Cart ID","default":"","type":"string","name":"cartId"},{"_id":"58ef951f3ecbd60f00ddc296","ref":"","in":"path","required":true,"desc":"Cart Item ID","default":"","type":"string","name":"cartItemId"},{"_id":"58ef951f3ecbd60f00ddc295","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"itemId"},{"_id":"58ef951f3ecbd60f00ddc294","ref":"","in":"body","required":false,"desc":"","default":"","type":"int","name":"itemQuantity"},{"_id":"58ef951f3ecbd60f00ddc293","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"itemName"},{"_id":"59526336f8a1ac001b0f698e","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"itemCategoryName"},{"_id":"59526336f8a1ac001b0f698d","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"itemDescription"},{"_id":"59526336f8a1ac001b0f698c","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"itemPrice"},{"_id":"59526336f8a1ac001b0f698b","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"specialInstructions"},{"_id":"59526336f8a1ac001b0f698a","ref":"","in":"body","required":false,"desc":"Contains list of item options. Required fields: optionId, optionName, optionPrice.","default":"","type":"array_string","name":"itemOptions"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta-data\" : {\n    \"code\" : 200,\n\t  \"message\" : \"OK\"\n  },\n  \"success\": true\n}","name":""},{"status":400,"language":"json","code":"{\n\t\"meta-data\": {\n\t\t\"code\": 400,\n\t\t\"message\": \"Error in request. Missing itemId parameter.\"\n\t}\n}","name":""}]},"settings":"","url":"/v:version/carts/:cartId/cart_items/:cartItemId"},"body":"","excerpt":"Update menu item in shopping cart","user":"5655ddfda66be71700968e03","type":"put","updates":[],"version":"5569f8596637291700e426ea","__v":1,"next":{"pages":[],"description":""},"title":"Update Menu Item","link_url":"","parentDoc":null,"project":"556785630145bc23008e3bb3","createdAt":"2017-04-13T15:11:27.342Z","hidden":false,"category":"58ef53812c4ffc390008af3d","link_external":false,"childrenPages":[]}

putUpdate Menu Item

Update menu item in shopping cart

Path Params

cartId:
required
string
Cart ID
cartItemId:
required
string
Cart Item ID

Body Params

itemId:
required
string
itemQuantity:
integer
itemName:
string
itemCategoryName:
string
itemDescription:
string
itemPrice:
string
specialInstructions:
string
itemOptions:
array of strings
Contains list of item options. Required fields: optionId, optionName, optionPrice.

User Information

Try It Out

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"58ef970d1637c925006fd425","body":"","slug":"list-cart-item","__v":0,"api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl https://api.pingup.com/v1/carts/CART_ID/cart_items/CART_ITEM_ID  \\\n-H \"token: ACCESS_TOKEN\" \\\n-X GET"}]},"method":"get","params":[{"_id":"58ef970d1637c925006fd427","ref":"","in":"path","required":true,"desc":"Cart ID","default":"","type":"string","name":"cartId"},{"_id":"58ef970d1637c925006fd426","ref":"","in":"path","required":true,"desc":"Cart Item ID","default":"","type":"string","name":"cartItemId"}],"results":{"codes":[{"name":"","code":"{\n  \"meta-data\" : {\n    \"code\" : 200,\n\t  \"message\" : \"OK\"\n  },\n  \"results\": [\n\t{\n\t\t\"cartItemId\": \"9f6d82d5-6ec9-4b0e-a78b-f9505f015380\",\n\t\t\"itemId\": \"11948050\",\n\t\t\"itemName\": \"Giardiniera Peppers\",\n\t\t\"itemCategoryName\": \"Football Special Pizzas\",\n\t\t\"itemPrice\": \"10.00\",\n\t\t\"itemOptions\": [\n\t\t{\n\t\t\t\"optionId\": \"105331737\",\n\t\t\t\"optionName\": \"2nd Half\",\n\t\t\t\"optionPrice\": \"1.10\"\n\t\t}],\n\t}],\n}","language":"json","status":200},{"name":"","code":"{\n\t\"meta-data\": {\n\t\t\"code\": 500,\n\t\t\"message\": \"An internal error has occurred.\"\n\t}\n}","language":"json","status":500}]},"settings":"","url":"/v:version/carts/:cartId/cart_items/:cartItemId"},"category":"58ef53812c4ffc390008af3d","githubsync":"","isReference":false,"order":6,"sync_unique":"","user":"5655ddfda66be71700968e03","version":"5569f8596637291700e426ea","hidden":false,"link_url":"","next":{"pages":[],"description":""},"type":"get","createdAt":"2017-04-13T15:19:41.174Z","excerpt":"Retrieves item details from shopping cart","link_external":false,"project":"556785630145bc23008e3bb3","title":"Cart Item","updates":[],"parentDoc":null,"childrenPages":[]}

getCart Item

Retrieves item details from shopping cart

Path Params

cartId:
required
string
Cart ID
cartItemId:
required
string
Cart Item ID

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"58ef97a8de2a332300c9e1fa","project":"556785630145bc23008e3bb3","link_url":"","order":7,"title":"Remove Cart Item","githubsync":"","isReference":false,"body":"","category":"58ef53812c4ffc390008af3d","hidden":false,"slug":"remove-cart-item","sync_unique":"","api":{"method":"delete","examples":{"codes":[{"language":"curl","code":"curl https://api.pingup.com/v1/carts/CART_ID/cart_items/CART_ITEM_ID  \\\n-H \"token: ACCESS_TOKEN\" \\\n-X DELETE"}]},"results":{"codes":[{"language":"json","code":"{\n  \"meta-data\" : {\n    \"code\" : 200,\n\t  \"message\" : \"OK\"\n  },\n  \"success\": true\n}  \n  ","name":"","status":200},{"status":500,"language":"json","code":"{\n\t\"meta-data\": {\n\t\t\"code\": 500,\n\t\t\"message\": \"An internal error has occurred.\"\n\t}\n}","name":""}]},"settings":"","auth":"required","params":[{"default":"","type":"string","name":"cartId","_id":"58ef97a8de2a332300c9e1fc","ref":"","in":"path","required":true,"desc":"Cart ID"},{"in":"path","required":true,"desc":"Cart Item ID","default":"","type":"string","name":"cartItemId","_id":"58ef97a8de2a332300c9e1fb","ref":""}],"url":"/v:version/carts/:cartId/cart_items/:cartItemId"},"version":"5569f8596637291700e426ea","user":"5655ddfda66be71700968e03","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-04-13T15:22:16.036Z","link_external":false,"excerpt":"Remove menu item from shopping cart","type":"delete","__v":0,"parentDoc":null,"childrenPages":[]}

deleteRemove Cart Item

Remove menu item from shopping cart

Path Params

cartId:
required
string
Cart ID
cartItemId:
required
string
Cart Item ID

User Information

Try It Out

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"58ef90d53ecbd60f00ddc097","hidden":false,"order":8,"sync_unique":"","type":"get","updates":[],"user":"5655ddfda66be71700968e03","api":{"method":"get","params":[{"name":"cartId","ref":"","required":true,"type":"string","_id":"58ef90d53ecbd60f00ddc098","default":"","desc":"Cart ID","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"meta-data\": {\n\t\t\"code\": 200,\n\t\t\"message\": \"OK\"\n\t},\n\t\"cart\": {\n\t\t\"placeId\": \"12345\",\n\t\t\"providerId\": 66,\n\t\t\"externalLocationId\": \"8750937597ma\",\n\t\t\"dateTimeCreated\": 1498565613985,\n\t\t\"cartId\": \"113257a0-b781-485f-82b5-eb83f55d5a08\",\n\t\t\"items\": [\n\t\t\t{\n\t\t\t\t\"cartItemId\": \"4d0f5aa8-8330-4029-bfb2-0103a841c8c3\",\n\t\t\t\t\"itemId\": \"11947769\",\n\t\t\t\t\"itemQuantity\": 1,\n\t\t\t\t\"itemName\": \"Squash Curry - Chicken\",\n\t\t\t\t\"itemCategoryName\": \"Curry Entrees\",\n\t\t\t\t\"itemDescription\": \"Red and Yellow Curry Coconut Milk with Squash, Potatoes, Green Bean & Bamboo Shoot. Choice of Chicken, Beef, Pork, Tofu or Shrimp.\",\n\t\t\t\t\"itemPrice\": \"6.95\",\n\t\t\t\t\"specialInstructions\": \"Not salted\",\n\t\t\t\t\"selectedMenuOptions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"optionId\": \"9454236\",\n\t\t\t\t\t\t\"optionName\": \"Extra White Rice\",\n\t\t\t\t\t\t\"optionPrice\": \"1.00\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"optionId\": \"9454238\",\n\t\t\t\t\t\t\"optionName\": \"Bread\",\n\t\t\t\t\t\t\"optionPrice\": \"1.50\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"cartItemId\": \"9f6d82d5-6ec9-4b0e-a78b-f9505f015380\",\n\t\t\t\t\"itemId\": \"11948050\",\n\t\t\t\t\"itemQuantity\": 3,\n\t\t\t\t\"itemName\": \"Giardiniera Peppers\",\n\t\t\t\t\"itemCategoryName\": \"Football Special Pizzas\",\n\t\t\t\t\"itemPrice\": \"10.00\",\n\t\t\t\t\"selectedMenuOptions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"optionId\": \"105331737\",\n\t\t\t\t\t\t\"optionName\": \"2nd Half\",\n\t\t\t\t\t\t\"optionPrice\": \"1.10\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t]\n\t}\n}","name":""},{"status":500,"language":"json","code":"{\n\t\"meta-data\": {\n\t\t\"code\": 500,\n\t\t\"message\": \"An internal error has occurred.\"\n\t}\n}","name":""}]},"settings":"","url":"/v:version/carts/:cartId","auth":"required","examples":{"codes":[{"language":"curl","code":"curl  \"https://api.pingup.com/v1/carts/CART_ID\" \\\n-H \"token: ACCESS_TOKEN\" \\\n-X GET"}]}},"githubsync":"","body":"","next":{"description":"","pages":[]},"project":"556785630145bc23008e3bb3","title":"Cart Info","__v":0,"excerpt":"Retrieves shopping cart details","isReference":false,"link_external":false,"link_url":"","category":"58ef53812c4ffc390008af3d","createdAt":"2017-04-13T14:53:09.610Z","version":"5569f8596637291700e426ea","parentDoc":null,"slug":"cart-info","childrenPages":[]}

getCart Info

Retrieves shopping cart details

Path Params

cartId:
required
string
Cart ID

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"58ef98459f17721b005883d2","body":"","link_url":"","next":{"pages":[],"description":""},"updates":[],"type":"post","api":{"auth":"required","examples":{"codes":[{"code":"curl https://api.pingup.com/v1/carts/CART_ID/checkout  \\\n-H \"token: ACCESS_TOKEN\" \\\n-d '{\n\t\"sessionToken\": \"12345he78llo\",\n\t\"deliveryType\": \"delivery\",\n\t\"paymentType\": \"cash\",\n\t\"userFirstName\": \"John\",\n\t\"userLastName\": \"Plat\",\n\t\"userEmail\": \"john@plat.com\",\n\t\"userPhone\": \"(555) 555-5555\",\n\t\"deliveryAddress\": \"11 Elkins St, Suite 230\",\n\t\"deliveryCity\": \"Boston\",\n\t\"tip\": \"3.08\"\n}' \\\n-X POST","language":"curl"}]},"method":"post","params":[{"_id":"58ef98459f17721b005883d3","ref":"","in":"path","required":true,"desc":"Cart ID","default":"","type":"string","name":"cartId"},{"_id":"58efbdfbf7d1d51900b7be55","ref":"","in":"body","required":true,"desc":"Accepts two possible values: 'cash' or 'card'","default":"","type":"string","name":"paymentType"},{"_id":"58efbdfbf7d1d51900b7be54","ref":"","in":"body","required":true,"desc":"Accepts two possible values: 'delivery' or 'pickup'","default":"","type":"string","name":"deliveryType"},{"_id":"58efbdfbf7d1d51900b7be53","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"userFirstName"},{"_id":"58efbdfbf7d1d51900b7be52","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"userLastName"},{"_id":"58efbdfbf7d1d51900b7be51","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"userEmail"},{"_id":"58efbdfbf7d1d51900b7be50","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"userPhone"},{"_id":"58efbdfbf7d1d51900b7be4f","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"sessionToken"},{"_id":"58efbdfbf7d1d51900b7be4e","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"deliveryAddress"},{"_id":"58efbdfbf7d1d51900b7be4d","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"deliveryCity"},{"_id":"58efbdfbf7d1d51900b7be4c","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"deliveryState"},{"_id":"59526f41f544fe0015385ca5","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"deliveryZipCode"},{"_id":"59526f41f544fe0015385ca4","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"tip"},{"_id":"59526f41f544fe0015385ca3","ref":"","in":"body","required":false,"desc":"","default":"on_card","type":"string","name":"tipType"},{"_id":"59526f41f544fe0015385ca2","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"additionalComments"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"meta-data\": {\n\t\t\"code\": 200,\n\t\t\"message\": \"OK\"\n\t},\n\t\"order\": {\n\t\t\"order_id\": \"12345\",\n\t\t\"order_type\": \"delivery\",\n\t\t\"payment_type\": \"cash\",\n\t\t\"location_id\": \"123\",\n\t\t\"delivery_time\": \"ASAP (35-45m)\",\n\t\t\"order_summary\": {\n\t\t\t\"number_of_items\": 2,\n\t\t\t\"price\": \"17.58\",\n\t\t\t\"delivery_fee\": \"2.00\",\n\t\t\t\"sales_tax\": \"1.23\",\n\t\t\t\"tip\": \"3.08\",\n\t\t\t\"tip_type\": \"on_card\",\n\t\t\t\"total_price\": \"20.81\",\n\t\t\t\"items\": [\n\t\t\t\t{\n\t\t\t\t\t\"menu_item_id\": \"1\",\n\t\t\t\t\t\"name\": \"Pizza\",\n\t\t\t\t\t\"price\": \"5.00\",\n\t\t\t\t\t\"description\": \"no pickles\",\n\t\t\t\t\t\"menu_item_options\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"option_type\": \"multi\",\n\t\t\t\t\t\t\t\"options\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"menu_item_option_id\": \"2\",\n\t\t\t\t\t\t\t\t\t\"name\": \"Ranch Dressing\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"menu_item_option_id\": \"5\",\n\t\t\t\t\t\t\t\t\t\"name\": \"Regular Italian Dressing\",\n\t\t\t\t\t\t\t\t\t\"price\": \"0.75\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"delivery_address\": {\n\t\t\t\t\"street_address\": \"11 Elkins St, Suite 230\",\n\t\t\t\t\"city\": \"Boston\",\n\t\t\t\t\"state\": \"MA\",\n\t\t\t\t\"zip\": \"02127\"\n\t\t\t}\n\t\t}\n\t}\n}","name":""},{"status":400,"language":"json","code":"{\n\t\"meta-data\": {\n\t\t\"code\": 400,\n\t\t\"message\": \"Error in request. Session token is required.\"\n\t}\n}","name":""}]},"settings":"","url":"/v:version/carts/:cartId/checkout"},"createdAt":"2017-04-13T15:24:53.481Z","isReference":false,"link_external":false,"slug":"checkout","__v":2,"category":"58ef53812c4ffc390008af3d","excerpt":"Send an order to the restaurant","order":9,"title":"Checkout","version":"5569f8596637291700e426ea","githubsync":"","hidden":false,"project":"556785630145bc23008e3bb3","sync_unique":"","user":"5655ddfda66be71700968e03","parentDoc":null,"childrenPages":[]}

postCheckout

Send an order to the restaurant

Path Params

cartId:
required
string
Cart ID

Body Params

paymentType:
required
string
Accepts two possible values: 'cash' or 'card'
deliveryType:
required
string
Accepts two possible values: 'delivery' or 'pickup'
userFirstName:
required
string
userLastName:
required
string
userEmail:
required
string
userPhone:
required
string
sessionToken:
required
string
deliveryAddress:
string
deliveryCity:
string
deliveryState:
string
deliveryZipCode:
string
tip:
string
tipType:
stringon_card
additionalComments:
string

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

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format