Products

post
Creating a Product

https://yorshop.yordadev.network/v1/product
This endpoint allows you to create a product.
Request
Response
Request
Headers
Authorization
required
string
Your shop's Client Credential Token
Form Data Parameters
category_id
required
string
The id to the category to which the product belongs
tax_id
optional
string
The id to a tax rate to be applied to this product at checkout and override any cart tax.
name
required
string
The products name
description
required
string
A description of the product
commodity_type
required
string
The product is a Physical or Digital commodity type
enabled
required
boolean
True or False
Response
200: OK

get
Fetching Product(s)

https://yorshop.yordadev.network/v1/product
This endpoint allows you to fetch a single product or all product.
Request
Response
Request
Headers
Authorization
required
string
Query Parameters
product_id
optional
string
The id of the product to fetch
scope
required
array
Array of boolean values defining the scope
expanded
required
boolean
scope[expanded]
media
required
boolean
scope[media]
Response
200: OK

put
Updating a Product

https://yorshop.yordadev.network/v1/product
This endpoint allows you to update your product.
Request
Response
Request
Headers
Authorization
required
string
Your shop's Client Credential Token
Query Parameters
product_id
optional
string
The id to the product to be updated
tax_id
optional
string
The id of the tax rate to be applied to this product at time of checkout and override any tax applied at time of checkout.
name
required
string
The name of the product
description
required
string
Short description of product
commodity_type
required
string
Physical or Digital
enabled
required
boolean
True or False
Response
200: OK

delete
Destroying Product

https://yorshop.yordadev.network/v1/product
This endpoint allows you to destroy a product.
Request
Response
Request
Headers
Authorization
required
string
Your shop's Client Credential Token
Query Parameters
product_id
required
string
The id to the product to be destroyed
Response
200: OK