GET /reservations.json

Get a list of reservation models.

get
Reservations

https://api.reserveinstore.com/api/v1/reservations.json
Fetches a list of reservations made by customers to the store.
Request
Response
Request
Headers
secret_key
required
string
Your store's secret API key.
public_key
required
string
Your store's public API key.
Query Parameters
customer_name
optional
string
Filter by all or part of the customer name.
customer_email
optional
string
Filter by all or part of the customer email.
customer_phone
optional
string
Filter by all or part of the customer phone.
location_id
optional
integer
Filter by the location ID. This is the Reserve In-store location ID not the platform (shopify) location ID. (see /locations endpoint)
fulfilled
optional
boolean
Filter by fulfilled or not fulfilled (Example: true)
page
optional
integer
Page # if showing more than 250 results. (defaults to page 1)
Response
200: OK
[
{
"id": 1,
"location_id": 3, // Internal Reserve In-store location ID (not the Platform/Shopify one - see /locations endpoint)
"customer": {
"name": "John Doe",
"email": "john.doe@example.com",
"phone": "1231231231231",
"instructions": "I'll be there on Monday by 3pm."
},
"cart": {
"items": [
{
"product_id": "9423387917", // Shopify/platform product ID.
"variant_id": "34639503181" // Shopify/platform variant ID.
}
]
},
"fulfilled": false, // True if the reservation has already been fulfilled, false if not.
"created_at": "2019-05-10T18:37:48.260Z",
"updated_at": "2019-05-10T22:11:50.739Z"
}
]