Add - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Body Params application/json

name

string

required

branchType

enum<string>

required

Allowed values:

Head OfficeRetail StoreFranchiseWarehouseDistribution CenterOnline StorePop-up StoreFlagship StoreSpecialty StoreOutlet StoreCorporate OfficeRegional OfficeInternational BranchLocal Branch

address

object (ICommonAddress)

required

locationName

string | null

optional

street1

string | null

optional

street2

string | null

optional

pincode

string | null

optional

city

string | null

optional

state

string | null

optional

country

string | null

optional

contact

object (IContact)

required

isPrimary

boolean

optional

salutation

optional

firstName

string | null

optional

lastName

string | null

optional

email

string | null

optional

workPhone

string | null

optional

mobilePhone

string | null

optional

designation

string | null

optional

department

string | null

optional

wareHouseStatus

enum<string>

required

Allowed values:

activeinactive

Example

{
    "name": "string",
    "branchType": "Head Office",
    "address": {
        "locationName": "string",
        "street1": "string",
        "street2": "string",
        "pincode": "string",
        "city": "string",
        "state": "string",
        "country": "string"
    },
    "contact": {
        "isPrimary": true,
        "salutation": "Mr.",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "workPhone": "string",
        "mobilePhone": "string",
        "designation": "string",
        "department": "string"
    },
    "wareHouseStatus": "active"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.upbooks.io/api/v1/warehouse' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "branchType": "Head Office",
    "address": {
        "locationName": "string",
        "street1": "string",
        "street2": "string",
        "pincode": "string",
        "city": "string",
        "state": "string",
        "country": "string"
    },
    "contact": {
        "isPrimary": true,
        "salutation": "Mr.",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "workPhone": "string",
        "mobilePhone": "string",
        "designation": "string",
        "department": "string"
    },
    "wareHouseStatus": "active"
}'

Responses

🟢200Ok

application/json

Body

data

object (WarehouseDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

name

string

required

branchType

enum<string>

required

Allowed values:

Head OfficeRetail StoreFranchiseWarehouseDistribution CenterOnline StorePop-up StoreFlagship StoreSpecialty StoreOutlet StoreCorporate OfficeRegional OfficeInternational BranchLocal Branch

address

object (ICommonAddress)

required

contact

object (IContact)

required

wareHouseStatus

enum<string>

required

Allowed values:

activeinactive

warehouseId

string

required

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",
        "branchType": "Head Office",
        "address": {
            "locationName": "string",
            "street1": "string",
            "street2": "string",
            "pincode": "string",
            "city": "string",
            "state": "string",
            "country": "string"
        },
        "contact": {
            "isPrimary": true,
            "salutation": "Mr.",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "workPhone": "string",
            "mobilePhone": "string",
            "designation": "string",
            "department": "string"
        },
        "wareHouseStatus": "active",
        "warehouseId": "string"
    },
    "message": "string"
}

🟢200Success