This GraphQL API was modelled after a simple version of the Shopify API. The project is currently not deployed, as it is expensive to run. If you would like to see it running, please reach out to me and I would be more than happy to host it for a couple days.
Noteable Features:
To start using the API right away, use the interactive GraphiQL environment hosted at http://35.224.16.95/.
If you prefer to use another API client such as Insomnia, please use the following settings:
"X-Hasura-Access-Key" : "ab654f89"Once you’ve chosen a client, you can test out the API by running the following query:
query {
shop {
name
products {
name
quantity
value
}
}
}
A successful query should return a similar looking response:
{
"data": {
"shop": [
{
"name": "Toronto Farmers' Market",
"products": [
{
"quantity": 115,
"value": 0.5,
"name": "Tomatoes"
},
{
"quantity": 49,
"value": 5,
"name": "Pumpkins"
}
]
}
]
}
}
Let’s start off by creating a shop. Your shop id is what you will use to reference your shop later.
mutation new_shop {
insert_shop(
objects: [
{
name: "Nofrills"
}
]
) {
returning {
id
name
}
}
}
Awesome! Let’s check out our newly created shop by running the following query:
query {
shop(where: {name: {_eq: "Nofrills"}}) {
id
name
products {
id
name
quantity
value
}
}
}
A successful query should return a similar looking response:
{
"data": {
"shop": [
{
"name": "Nofrills",
"id": 9,
"products": []
}
]
}
}
Looks like we have a shop, but now we need some products!
Now that we have a shop, let’s add some products. Use your shop id from the previous query to ensure the new products end up in your shop.
mutation new_products {
insert_product(
objects: [
{
name: "Cucumbers",
quantity: 30,
value: 0.15,
shop_id: 9
},
{
name: "Apples",
quantity: 50,
value: 0.85,
shop_id: 9
},
]
) {
returning {
id
name
quantity
value
shop_id
}
}
}
Let’s run that query again to check out the new products.
query {
shop(where: {name: {_eq: "Nofrills"}}) {
id,
name,
products {
id
name
quantity
value
}
}
}
A successful query should return a similar looking response:
{
"data": {
"shop": [
{
"name": "Nofrills",
"id": 9,
"products": [
{
"quantity": 30,
"value": 0.15,
"name": "Cucumbers",
"id": 18
},
{
"quantity": 50,
"value": 0.85,
"name": "Apples",
"id": 19
}
]
}
]
}
}
Great! Now that our store has some products, our customers can place orders.
We’ve got a store and products. Let’s place our first order. Use your shop id from the previous query.
mutation new_order {
insert_order(
objects: [
{
shop_id: 9
}
]
) {
returning {
id
shop_id
}
}
}
We’ve created our first order, let’s check it out.
query {
order(where: {shop: {name: {_eq: "Nofrills"}}}) {
id
shop_id
line_items {
product {
name
}
quantity
value
}
}
}
A successful query should return a similar looking response:
{
"data": {
"order": [
{
"line_items": [],
"shop_id": 9,
"id": 9
}
]
}
}
Hmmmm, looks like we’re missing some line items. Let’s add some.
Let’s go ahead and add some line items to our new order. Use your order id and product ids from the previous queries to ensure the correct products end up in your order.
mutation new_line_items {
insert_line_item(
objects: [
{
order_id: 9,
product_id: 18,
quantity: 5
},
{
order_id: 9,
product_id: 19,
quantity: 5
}
]
) {
returning {
product_id
quantity
value
order_id
}
}
}
Let’s run that query again to check out the order with our new line items.
query {
order(where: {shop: {name: {_eq: "Nofrills"}}}) {
id
shop_id
line_items {
product {
name
}
quantity
value
}
}
}
A successful query should return a similar looking response:
{
"data": {
"order": [
{
"line_items": [
{
"quantity": 5,
"value": 0.75,
"product": {
"name": "Cucumbers"
}
},
{
"quantity": 5,
"value": 4.25,
"product": {
"name": "Apples"
}
}
],
"shop_id": 9,
"id": 9
}
]
}
}
Great! You now know how to: