GetProductList - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

searchText

string

optional

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

sortBy

string

optional

Default:

name

sortOrder

number <double>

optional

Default:

1

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.upbooks.io/api/v1/product?searchText' \
--header 'pageNo;' \
--header 'pageSize;' \
--header 'sortBy;' \
--header 'sortOrder;' \
--header 'ORGANIZATION-ID: 00000'

Responses

🟢200Ok

application/json

Body

data

array[object (ProductDocumentJSON) {16}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

name

string

required

amount

number <double> | null

optional

currency

optional

brand

optional

thumbnail

string | null

optional

hsnCode

string | null

optional

unit

optional

productCategories

array[object (IProductCategoriesArray) {4}] | null

optional

inventory

object

required

isDeleted

boolean

optional

taxes

array[object (ITaxNamePercentage) {3}] | null

optional

totalCount

number <double>

optional

filteredCount

number <double>

optional

message

string

optional

Example

{
    "data": [
        {
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "__v": 0,
            "_id": "string",
            "organizationId": "string",
            "name": "string",
            "amount": 0,
            "currency": {
                "name": "string",
                "symbol": "string"
            },
            "brand": {
                "id": "string",
                "name": "string",
                "picture": "string",
                "slug": "string"
            },
            "thumbnail": "string",
            "hsnCode": "string",
            "unit": "mm",
            "productCategories": [
                {
                    "id": "string",
                    "title": "string",
                    "thumbnail": "string",
                    "description": "string"
                }
            ],
            "inventory": {
                "stockStatus": "not-configured",
                "description": "string",
                "maxStorageCapacity": 0,
                "threshold": 0,
                "sku": "string",
                "stockQuantity": 0,
                "enabled": true
            },
            "isDeleted": true,
            "taxes": [
                {
                    "id": "string",
                    "name": "string",
                    "percentage": 0
                }
            ]
        }
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}

🟢200Success