Categories
getFetching Categories
get
https://yorshop.yordadev.network/v1/category
This endpoint allows you to fetch a specific category or all categories.
Request
Response
Request
Headers
Authorization
required
string
Your shop's Client Credential Token
Query Parameters
scope
required
array
Array of Boolean values for scope of fetch
expanded
required
boolean
Include additional information on category(s)
products
required
boolean
Include all products in category(s)
category_id
optional
string
The category_id to a specific category to be fetched
Response
200: OK
postCreating a Category
post
https://yorshop.yordadev.network/v1/category
This endpoint allows you to create a new category.
Request
Response
Request
Headers
Authorization
required
string
Your shop's Client Credential Token
Form Data Parameters
name
required
string
The category's name
description
required
string
A short description of the category
enabled
required
boolean
meta_keywords
required
string
meta_description
required
string
Response
200: OK
putUpdate a Category
put
https://yorshop.yordadev.network/v1/category
This endpoint allows you to update a category.
Request
Response
Request
Headers
Authorization
required
string
Your shop's Client Credential Token
Query Parameters
category_id
required
string
name
required
string
description
required
string
enabled
required
boolean
meta_keywords
required
string
meta_description
required
string
Response
200: OK
deleteDestroying a Category
delete
https://yorshop.yordadev.network/v1/category
This endpoint allows you to destroy a category.
Request
Response
Request
Headers
Authorization
required
string
Your shop's Client Credential Token
Query Parameters
category_id
required
string
The id of the category to be destroyed
Response
200: OK
Last updated 5 months ago