Get All Products - Product Guide

GET

/

v1

/

products

Headers

X-BUSINESS-API-KEY

string

required

Query Parameters

statuses

enum<string>[]

Available options:

draft,

published

categories

string[]

source

enum<string>[]

Available options:

shopify,

wooCommerce

inventory

enum<string>[]

Available options:

in_stock,

out_of_stock

location_ids

string[]

channels

enum<string>[]

Available options:

pos,

invoice,

online_store

keywords

string[]

page

number

default: 1

per_page

number

default: 10

Response

200 - application/json

data

object[]

data.id

string

required

data.business_id

string

required

data.category_id

string[]

required

data.name

string

required

data.headline

string | null

data.description

string

required

data.currency

string

required

data.price

number

required

data.price_display

string

required

data.price_stored

integer

required

data.tax_id

string | null

data.is_manageable

integer

required

data.is_pinned

boolean

required

data.status

string

required

data.product_weight

integer | null

Weight in gram

data.delivery_method_required

boolean

data.has_variations

boolean

required

data.is_shopify

boolean

required

data.product_url

string

required

data.variations_count

integer

required

data.variations

object[]

required

data.variation_key_1

string | null

data.variation_key_2

string | null

data.variation_key_3

string | null

data.images

object[]

data.is_published

boolean

required

data.created_at

string

required

data.updated_at

string

required

data.starts_at

string | null

data.ends_at

string | null

links

object

meta

object

Was this page helpful?

Delete Order Create a Product