Products v1
All endpoints related to Products v1
Products v1 endpoints are depreciated but do still work, it is HIGHLY recommended to update your applications to the v2 endpoints
Products v1 support will be depreciated from the wrapper at some point.
Supported Endpoints
getAllProducts(): Returns a list of all the listings created.getProduct(id): Retrieves a listing by the entered ID.createProduct(fields): Creates a listing and returns the created listing.updateProduct(id, fields): Updates a listing by the entered ID.deleteProduct(id): Deletes a listing by the entered ID.
Products v1
Products v1 endpoints are depreciated but do still work, it is HIGHLY recommended to update your applications to the v2 endpoints
Products v1 support will be depreciated from the wrapper at some point.
getAllProducts()
getAllProducts()getProduct()
getProduct()id
string
✔️
ID of a Product
createProduct()
createProduct()fields
object
✔️
Product's field
title
string
✔️
The product's title.
description
string
✔️
The product's description.
image
object/null
❌
An image binary which will be visible when someone views your product.
order
int/null
❌
The product's order in which it is sorted on your storefront.
visibility
string
✔️
Either "PUBLIC", "HIDDEN", or "PRIVATE" - depending on whether you want this product to be visible.
deliverable
object
✔️
The product's deliverable which will be sent to the customer. Consists of three pieces of nested data, being "delivery_text", "type", and "data"
price
object
✔️
The product's price in nested format. Consists of two variables "PRICE" (in cents) and "CURRENCY".
humble
boolean
❌
Whether you want to allow the customer to pay more than the product's price. ( ͡° ͜ʖ ͡°)
payment_methods
array of string
✔️
Items Enum: "COINBASE" "PAYDASH" "PAYPAL" "STRIPE". The product's payment methods in array format.
additional_information
array
❌
Additional info that can be requested from the customer during the checkout process.
bulk_discount
array
❌
An array of discounts when a customer purchases more than a specified quantity.
minimum_purchase_quantity
int
✔️
The minimum amount a customer is able to purchase.
maximum_purchase_quantity
int/null
❌
The maximum amount a customer is able to purchase.
webhook
string/null
❌
A webhook URL that will receive updates when orders are placed.
warranty
object/null
❌
The warranty time in which a customer is able to request a refund.
locked
boolean
❌
Whether this product is locked by the admins or moderators.
section
int/null
❌
The ID of a section to associate with this product. Use null to disassociate a section.
updateProduct()
updateProduct()id
string
✔️
ID of the product you want to update
fields
object
✔️
Product's field
title
string
✔️
The product's title.
description
string
✔️
The product's description.
image
object/null
❌
An image binary which will be visible when someone views your product.
order
int/null
❌
The product's order in which it is sorted on your storefront.
visibility
string
✔️
Either "PUBLIC", "HIDDEN", or "PRIVATE" - depending on whether you want this product to be visible.
deliverable
object
✔️
The product's deliverable which will be sent to the customer. Consists of three pieces of nested data, being "delivery_text", "type", and "data"
price
object
✔️
The product's price in nested format. Consists of two variables "PRICE" (in cents) and "CURRENCY".
humble
boolean
❌
Whether you want to allow the customer to pay more than the product's price. ( ͡° ͜ʖ ͡°)
payment_methods
array of string
✔️
Items Enum: "COINBASE" "PAYDASH" "PAYPAL" "STRIPE". The product's payment methods in array format.
additional_information
array
❌
Additional info that can be requested from the customer during the checkout process.
bulk_discount
array
❌
An array of discounts when a customer purchases more than a specified quantity.
minimum_purchase_quantity
int
✔️
The minimum amount a customer is able to purchase.
maximum_purchase_quantity
int/null
❌
The maximum amount a customer is able to purchase.
webhook
string/null
❌
A webhook URL that will receive updates when orders are placed.
warranty
object/null
❌
The warranty time in which a customer is able to request a refund.
locked
boolean
❌
Whether this product is locked by the admins or moderators.
section
int/null
❌
The ID of a section to associate with this product. Use null to disassociate a section.
deleteProduct()
deleteProduct()id
string
✔️
ID of a Product
Last updated