Skip to content
/ boodoc Public

This repo will hold the documentation for the BooConnect APP.

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

Omnile/boodoc

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
css
css
 
 
images
images
 
 
js
js
 
 
source
source
 
 
README.md
README.md
 
 
collection.json
collection.json
 
 
index.html
index.html
 
 

Repository files navigation

title language_tabs includes search toc_footers
BooConnect API Reference
bash
javascript
errors
true
<a href="#">Some footer message comes here.</a>

Info

Here's tsshe complete documentaiton of the avialable API Endpoints. Get Postman Collection

Authentication

BooConnect uses API keys to allow access to the API. A new api key will be granted when loed in and thereafter, the server will expect a stateless call with the api key set as an authorization bearer.

The BooConnect server expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: meowmeowmeow

#Account

Account Endpoints

Get Account.

Get the data of the authenticated user

Example request:

curl -X GET "http://booconnect.run/api/v1/account" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/account",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/account

HEAD api/v1/account

Update Account

Update account information

Example request:

curl -X POST "http://booconnect.run/api/v1/account" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/account",
    "method": "POST",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/v1/account

Update Account

Update the authenticated user account

Example request:

curl -X PUT "http://booconnect.run/api/v1/account/{account}" \
-H "Accept: application/json" \
    -d "firstname"="aut" \
    -d "lastname"="aut" \
    -d "password"="aut" \
    -d "username"="aut" \
    -d "gender"="aut" \
    -d "phone"="aut" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/account/{account}",
    "method": "PUT",
    "data": {
        "firstname": "aut",
        "lastname": "aut",
        "password": "aut",
        "username": "aut",
        "gender": "aut",
        "phone": "aut"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT api/v1/account/{account}

PATCH api/v1/account/{account}

Parameters

Parameter | Type | Status | Description ---------|-------|-------|-------|----------- firstname | string | required | Maximum: 255 lastname | string | required | Maximum: 255 password | string | required | Minimum: 6 username | string | required | Minimum: 4 gender | string | required | Minimum: 4 phone | string | required | Minimum: 4

#Cart

Shopping cart endpoints

Get Cart Items

List items in the shopping cart

Example request:

curl -X GET "http://booconnect.run/api/v1/cart" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/cart",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

[]

HTTP Request

GET api/v1/cart

HEAD api/v1/cart

Add Cart Item.

Add and item to the shopping cart

Example request:

curl -X POST "http://booconnect.run/api/v1/cart" \
-H "Accept: application/json" \
    -d "item_id"="dolorum" \
    -d "qty"="1332598056" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/cart",
    "method": "POST",
    "data": {
        "item_id": "dolorum",
        "qty": 1332598056
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/v1/cart

Parameters

Parameter | Type | Status | Description ---------|-------|-------|-------|----------- item_id | string | required | Maximum: 255 qty | numeric | required | Minimum: 1

Update Cart Item Quantity

Update a specific cart Item.

Example request:

curl -X PUT "http://booconnect.run/api/v1/cart/{cart}" \
-H "Accept: application/json" \
    -d "row_id"="error" \
    -d "qty"="1213516256" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/cart/{cart}",
    "method": "PUT",
    "data": {
        "row_id": "error",
        "qty": 1213516256
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT api/v1/cart/{cart}

PATCH api/v1/cart/{cart}

Parameters

Parameter | Type | Status | Description ---------|-------|-------|-------|----------- row_id | string | required | qty | numeric | required | Minimum: 1

Remove Cart Item

Remove an item from the shopping cart.

Example request:

curl -X DELETE "http://booconnect.run/api/v1/cart/{cart}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/cart/{cart}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE api/v1/cart/{cart}

#Items

Items sold in restaurants registered on BooConnect

Query All Items

Get a list of paginated items.

Example request:

curl -X GET "http://booconnect.run/api/v1/items" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/items",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "name": "Kaden",
            "restaurant_id": 1,
            "image": "https:\/\/lorempixel.com\/150\/150\/food\/?50010",
            "description": "Non nulla facilis cumque voluptas.",
            "price": 2,
            "user_id": 1,
            "measurement": "plate",
            "quantity": 2,
            "deleted_at": null,
            "created_at": "2018-03-07 23:50:50",
            "updated_at": "2018-03-07 23:50:50",
            "formatted_price": "GHC 2.00",
            "cart": [],
            "qty": 0,
            "in_cart": false
        },
        {
            "id": 2,
            "name": "Crawford",
            "restaurant_id": 1,
            "image": "https:\/\/lorempixel.com\/150\/150\/food\/?60423",
            "description": "Magni quia dolore non et voluptas facilis.",
            "price": 1,
            "user_id": 1,
            "measurement": "bowl",
            "quantity": 2,
            "deleted_at": null,
            "created_at": "2018-03-07 23:50:50",
            "updated_at": "2018-03-07 23:50:50",
            "formatted_price": "GHC 1.00",
            "cart": [],
            "qty": 0,
            "in_cart": false
        }
    ],
    "first_page_url": "http:\/\/localhost\/api\/v1\/items?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http:\/\/localhost\/api\/v1\/items?page=1",
    "next_page_url": null,
    "path": "http:\/\/localhost\/api\/v1\/items",
    "per_page": 20,
    "prev_page_url": null,
    "to": 2,
    "total": 2
}

HTTP Request

GET api/v1/items

HEAD api/v1/items

Get Single Item

This will return a single item with it's attributes and set of pictures.

Example request:

curl -X GET "http://booconnect.run/api/v1/items/{item}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/items/{item}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "id": 1,
    "name": "Kaden",
    "restaurant_id": 1,
    "image": "https:\/\/lorempixel.com\/150\/150\/food\/?50010",
    "description": "Non nulla facilis cumque voluptas.",
    "price": 2,
    "user_id": 1,
    "measurement": "plate",
    "quantity": 2,
    "deleted_at": null,
    "created_at": "2018-03-07 23:50:50",
    "updated_at": "2018-03-07 23:50:50",
    "formatted_price": "GHC 2.00",
    "cart": [],
    "qty": 0,
    "in_cart": false,
    "pictures": null,
    "rating": []
}

HTTP Request

GET api/v1/items/{item}

HEAD api/v1/items/{item}

#Orders

Orders resource endpoints

List all orders

Display a paginated list of all orders.

Example request:

curl -X GET "http://booconnect.run/api/v1/orders" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/orders",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/orders

HEAD api/v1/orders

Show the form for creating a new resource.

Example request:

curl -X GET "http://booconnect.run/api/v1/orders/create" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/orders/create",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/orders/create

HEAD api/v1/orders/create

Cancel an order

A user can cancel an order within the first NUMBER minuites after making the order.

Example request:

curl -X DELETE "http://booconnect.run/api/v1/orders/{order}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/orders/{order}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE api/v1/orders/{order}

#Rating

Rating resource endpoints

List all ratings

List ratings related to either an item or restaurant

Example request:

curl -X GET "http://booconnect.run/api/v1/ratings" \
-H "Accept: application/json" \
    -d "rateable_type"="item" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/ratings",
    "method": "GET",
    "data": {
        "rateable_type": "item"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "message": "The given data was invalid.",
    "errors": {
        "rateable_type": [
            "The rateable type field is required."
        ]
    }
}

HTTP Request

GET api/v1/ratings

HEAD api/v1/ratings

Parameters

Parameter | Type | Status | Description ---------|-------|-------|-------|----------- rateable_type | string | required | item or restaurant

Add Rating

Add rating to an item or restaurant

Example request:

curl -X POST "http://booconnect.run/api/v1/ratings" \
-H "Accept: application/json" \
    -d "rating"="2" \
    -d "rateable_id"="30647" \
    -d "rateable_type"="item" \
    -d "comment"="dignissimos" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/ratings",
    "method": "POST",
    "data": {
        "rating": 2,
        "rateable_id": 30647,
        "rateable_type": "item",
        "comment": "dignissimos"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/v1/ratings

Parameters

Parameter | Type | Status | Description ---------|-------|-------|-------|----------- rating | numeric | required | Minimum: 1 Maximum: 5 rateable_id | numeric | required | rateable_type | string | optional | item or restaurant comment | string | optional |

Get Rating

Get a single rating review

Example request:

curl -X GET "http://booconnect.run/api/v1/ratings/{rating}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/ratings/{rating}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "id": 1,
    "rating": 2,
    "user_id": 2,
    "comment": "Ipsam incidunt odit facere non.",
    "rateable_id": 2,
    "rateable_type": "",
    "deleted_at": null,
    "created_at": "2018-03-07 23:50:50",
    "updated_at": "2018-03-07 23:50:50"
}

HTTP Request

GET api/v1/ratings/{rating}

HEAD api/v1/ratings/{rating}

Delete a rating review

Delete a rating for either an item or restaurant

Example request:

curl -X DELETE "http://booconnect.run/api/v1/ratings/{rating}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/ratings/{rating}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE api/v1/ratings/{rating}

#Restaurant

Lists restaurants registered on booconnect

Query Restaurants.

Get a paginated result of all restaurants

Example request:

curl -X GET "http://booconnect.run/api/v1/restaurants" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/restaurants",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "name": "Klein Ltd",
            "phone": "(681) 872-3523",
            "registration_no": "28939",
            "first_name": "Eleonore",
            "last_name": "Kunde",
            "user_id": "1",
            "image": "https:\/\/lorempixel.com\/150\/150\/nightlife\/?12938",
            "cover": "https:\/\/lorempixel.com\/500\/150\/technics\/?50408",
            "place": "Bednarfort",
            "city": "New Donato",
            "state": "Michigan",
            "country": "Saint Kitts and Nevis",
            "address": "19260 Rippin Pine",
            "website": "lakin.com",
            "description": "Exercitationem enim voluptatem non dolorem.",
            "phone_verified": 0,
            "email_verified": 1,
            "deleted_at": null,
            "created_at": "2018-03-07 23:50:50",
            "updated_at": "2018-03-07 23:50:50"
        },
        {
            "id": 2,
            "name": "Funk, Green and Ondricka",
            "phone": "642.964.6438",
            "registration_no": "41307",
            "first_name": "Ricardo",
            "last_name": "Cummerata",
            "user_id": "2",
            "image": "https:\/\/lorempixel.com\/150\/150\/nightlife\/?94190",
            "cover": "https:\/\/lorempixel.com\/500\/150\/technics\/?58087",
            "place": "Kadinborough",
            "city": "Dannieberg",
            "state": "West Virginia",
            "country": "Oman",
            "address": "26064 Nova Place Apt. 562",
            "website": "schowalter.com",
            "description": "Voluptate expedita sed quo ut illum ipsa.",
            "phone_verified": 1,
            "email_verified": 1,
            "deleted_at": null,
            "created_at": "2018-03-07 23:50:50",
            "updated_at": "2018-03-07 23:50:50"
        }
    ],
    "first_page_url": "http:\/\/localhost\/api\/v1\/restaurants?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http:\/\/localhost\/api\/v1\/restaurants?page=1",
    "next_page_url": null,
    "path": "http:\/\/localhost\/api\/v1\/restaurants",
    "per_page": 20,
    "prev_page_url": null,
    "to": 2,
    "total": 2
}

HTTP Request

GET api/v1/restaurants

HEAD api/v1/restaurants

Get Restaurant

A restaurant resource with pagination of it's items

Example request:

curl -X GET "http://booconnect.run/api/v1/restaurants/{restaurant}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/restaurants/{restaurant}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "id": 1,
    "name": "Klein Ltd",
    "phone": "(681) 872-3523",
    "registration_no": "28939",
    "first_name": "Eleonore",
    "last_name": "Kunde",
    "user_id": "1",
    "image": "https:\/\/lorempixel.com\/150\/150\/nightlife\/?12938",
    "cover": "https:\/\/lorempixel.com\/500\/150\/technics\/?50408",
    "place": "Bednarfort",
    "city": "New Donato",
    "state": "Michigan",
    "country": "Saint Kitts and Nevis",
    "address": "19260 Rippin Pine",
    "website": "lakin.com",
    "description": "Exercitationem enim voluptatem non dolorem.",
    "phone_verified": 0,
    "email_verified": 1,
    "deleted_at": null,
    "created_at": "2018-03-07 23:50:50",
    "updated_at": "2018-03-07 23:50:50",
    "items": {
        "current_page": 1,
        "data": [
            {
                "id": 1,
                "name": "Kaden",
                "restaurant_id": 1,
                "image": "https:\/\/lorempixel.com\/150\/150\/food\/?50010",
                "description": "Non nulla facilis cumque voluptas.",
                "price": 2,
                "user_id": 1,
                "measurement": "plate",
                "quantity": 2,
                "deleted_at": null,
                "created_at": "2018-03-07 23:50:50",
                "updated_at": "2018-03-07 23:50:50",
                "formatted_price": "GHC 2.00",
                "cart": [],
                "qty": 0,
                "in_cart": false
            },
            {
                "id": 2,
                "name": "Crawford",
                "restaurant_id": 1,
                "image": "https:\/\/lorempixel.com\/150\/150\/food\/?60423",
                "description": "Magni quia dolore non et voluptas facilis.",
                "price": 1,
                "user_id": 1,
                "measurement": "bowl",
                "quantity": 2,
                "deleted_at": null,
                "created_at": "2018-03-07 23:50:50",
                "updated_at": "2018-03-07 23:50:50",
                "formatted_price": "GHC 1.00",
                "cart": [],
                "qty": 0,
                "in_cart": false
            }
        ],
        "first_page_url": "http:\/\/localhost\/api\/v1\/restaurants\/1?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http:\/\/localhost\/api\/v1\/restaurants\/1?page=1",
        "next_page_url": null,
        "path": "http:\/\/localhost\/api\/v1\/restaurants\/1",
        "per_page": 20,
        "prev_page_url": null,
        "to": 2,
        "total": 2
    }
}

HTTP Request

GET api/v1/restaurants/{restaurant}

HEAD api/v1/restaurants/{restaurant}

#Search

Search for either Restaurants or Items

Search

This will allow the clients to seach for items, restaurants or a combination of both.

Example request:

curl -X GET "http://booconnect.run/api/v1/search" \
-H "Accept: application/json" \
    -d "query"="aut" \
    -d "type"="items" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/search",
    "method": "GET",
    "data": {
        "query": "aut",
        "type": "items"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "message": "The given data was invalid.",
    "errors": {
        "query": [
            "The query field is required."
        ]
    }
}

HTTP Request

GET api/v1/search

HEAD api/v1/search

Parameters

Parameter | Type | Status | Description ---------|-------|-------|-------|----------- query | string | required | Maximum: 255 type | string | optional | items or resturants

#Verify

phone verification endpoints

Get Status

Get verification status on authenticated user

Example request:

curl -X GET "http://booconnect.run/api/v1/verify" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/verify",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/verify

HEAD api/v1/verify

Verify OTP Code

Verify the OTP code that was sent to the authenticated user.

Example request:

curl -X POST "http://booconnect.run/api/v1/verify" \
-H "Accept: application/json" \
    -d "phone"="938" \
    -d "token"="938" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/verify",
    "method": "POST",
    "data": {
        "phone": 938,
        "token": 938
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/v1/verify

Parameters

Parameter | Type | Status | Description ---------|-------|-------|-------|----------- phone | numeric | required | token | numeric | required | Valid user token

Show the form for editing the specified resource.

Example request:

curl -X GET "http://booconnect.run/api/v1/verify/{verify}/edit" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/verify/{verify}/edit",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/verify/{verify}/edit

HEAD api/v1/verify/{verify}/edit

Send Verification Code

A temporary verification code will be sent to the user. This code will expire after 5 minuites.

Example request:

curl -X PUT "http://booconnect.run/api/v1/verify/{verify}" \
-H "Accept: application/json" \
    -d "phone"="4903" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/verify/{verify}",
    "method": "PUT",
    "data": {
        "phone": 4903
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT api/v1/verify/{verify}

PATCH api/v1/verify/{verify}

Parameters

Parameter | Type | Status | Description ---------|-------|-------|-------|----------- phone | numeric | required |

#Wishlist

Item-Wishlist resource endpoints

Get Items

Get paginated list of items on wishlist

Example request:

curl -X GET "http://booconnect.run/api/v1/wishlist" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/wishlist",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/wishlist

HEAD api/v1/wishlist

Add Wishlist item

Add an item to wishlist

Example request:

curl -X POST "http://booconnect.run/api/v1/wishlist" \
-H "Accept: application/json" \
    -d "item_id"="1715927" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/wishlist",
    "method": "POST",
    "data": {
        "item_id": 1715927
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/v1/wishlist

Parameters

Parameter | Type | Status | Description ---------|-------|-------|-------|----------- item_id | numeric | required | Valid item id

Remove Item

Remove an item from the set of items on tieh wishlist.

Example request:

curl -X DELETE "http://booconnect.run/api/v1/wishlist/{wishlist}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/wishlist/{wishlist}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE api/v1/wishlist/{wishlist}

#zZ TODO: -- Pending Endpoints

Checkout resource endpoints

Display a listing of the resource.

Example request:

curl -X GET "http://booconnect.run/api/v1/checkout" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/checkout",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/checkout

HEAD api/v1/checkout

Show the form for creating a new resource.

Example request:

curl -X GET "http://booconnect.run/api/v1/checkout/create" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/checkout/create",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/checkout/create

HEAD api/v1/checkout/create

Store a newly created resource in storage.

Example request:

curl -X POST "http://booconnect.run/api/v1/checkout" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/checkout",
    "method": "POST",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/v1/checkout

Display the specified resource.

Example request:

curl -X GET "http://booconnect.run/api/v1/checkout/{checkout}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/checkout/{checkout}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/checkout/{checkout}

HEAD api/v1/checkout/{checkout}

Show the form for editing the specified resource.

Example request:

curl -X GET "http://booconnect.run/api/v1/checkout/{checkout}/edit" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/checkout/{checkout}/edit",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/checkout/{checkout}/edit

HEAD api/v1/checkout/{checkout}/edit

Update the specified resource in storage.

Example request:

curl -X PUT "http://booconnect.run/api/v1/checkout/{checkout}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/checkout/{checkout}",
    "method": "PUT",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT api/v1/checkout/{checkout}

PATCH api/v1/checkout/{checkout}

Remove the specified resource from storage.

Example request:

curl -X DELETE "http://booconnect.run/api/v1/checkout/{checkout}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://booconnect.run/api/v1/checkout/{checkout}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE api/v1/checkout/{checkout}

About

This repo will hold the documentation for the BooConnect APP.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

3 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages