Upbooks API

UpdateProduct

PUT

https://api.upbooks.io/api/v1/product/{id}

Product

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

string

required

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Body Params application/json

name

string

required

amount

number <double> | null

optional

currency

optional

Any of

ICommonCurrency

number | null

name

string

required

symbol

string

required

thumbnail

string | null

optional

hsnCode

string | null

optional

unit

optional

Any of

UnitEnum

number | null

Allowed values:

mmkgnos

brand

optional

Any of

IBrandProduct

number | null

string

required

name

string

required

picture

string

optional

slug

string

optional

productCategories

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

optional

string

optional

title

string

required

thumbnail

string | null

optional

description

string | null

optional

inventory

object

optional

stockStatus

enum<string>

optional

Allowed values:

not-configuredin-stocklow-stockout-of-stock

description

string

optional

maxStorageCapacity

number <double>

optional

threshold

number <double>

optional

sku

string

optional

stockQuantity

number <double>

optional

enabled

boolean

optional

taxes

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

optional

string | null

optional

name

string | null

optional

percentage

number <double> | null

optional

fileImportData

optional

Any of

IFileImportData

number | null

fileImportId

string

required

rowId

string

required

Example

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.upbooks.io/api/v1/product/' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200Ok

application/json

Body

data

object (ProductDocumentJSON)

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

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
      }
    ]
  },
  "message": "string"
}

🟢200Success

Modified at 2024-04-10 09:06:54

GetProductDetail

DeleteProduct