Upbooks API

GetAllProductCategories

GET

https://api.upbooks.io/api/v1/productcategory

ProductCategory

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:

title

sortOrder

number <double>

optional

Default:

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Responses

🟢200Ok

application/json

Body

data

array [array]

required

object (IProductCategoryDocumentJSON)

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",
                "title": "string",
                "thumbnail": "string",
                "description": "string"
            }
        ]
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}

🟢200Success

Modified at 2024-04-10 09:17:40

CancelPlatformPayment

AddProductCategory