Creates a simple product in the inventory

Request

Path Params

storeid

string

required

ID of the store location where the product is being added

Header Params

sessiontoken

string

required

Session token for authentication

Body Params application/json

Product details to be added

productCategory

string

required

The category of the product.

Example:

Electronics

subcategory

string

optional

The subcategory of the product.

Example:

Smartphones

itemDescription

string

required

A detailed description of the product.

Example:

Latest model smartphone with 128GB storage

quantity

number <double>

optional

The available quantity of the product in stock.

Example:

100

costPrice

number <double>

optional

The cost price of the product.

Example:

500

sellingPrice

number <double>

required

The selling price of the product.

Example:

700

bulkPrice

number <double>

optional

The price of the product when purchased in bulk.

Example:

600

qtyPerBulk

number <double>

optional

The quantity per bulk unit.

Example:

10

barcode

string

optional

The barcode of the product.

Example:

123456789012

productBrand

string

optional

The brand of the product.

Example:

BrandX

color

string

optional

The color of the product.

Example:

Black

size

string

optional

The size of the product.

Example:

Large

expireDate

string <date-time>

optional

The expiration date of the product. Note: Expire date must be in the future for the sumbit to work

memberPrice

number <double>

optional

The price of the product for members.

Example:

650

supplierNo

string

optional

The supplier number associated with the product.

Example:

SUP12345

storeId

string

optional

The ID of the store where the product is located.

Example:

STORE001

productType

string

required

The type of the product. Possible values: raw_material, whole_item, service.

Example:

whole_item

photoData

array[string <byte>]

optional

The binary array representing the picture of an item

Example

{
  "productCategory": "Electronics",
  "subcategory": "Smartphones",
  "itemDescription": "Latest model smartphone with 128GB storage",
  "quantity": 100,
  "costPrice": 500,
  "sellingPrice": 700,
  "bulkPrice": 600,
  "qtyPerBulk": 10,
  "barcode": "123456789012",
  "productBrand": "BrandX",
  "color": "Black",
  "size": "Large",
  "expireDate": "2019-08-24T14:15:22Z",
  "memberPrice": 650,
  "supplierNo": "SUP12345",
  "storeId": "STORE001",
  "productType": "whole_item",
  "photoData": [
    "string"
  ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://gateway.storeharmony.com/cloudapi/app//stock' \
--header 'sessiontoken;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productCategory": "Electronics",
    "subcategory": "Smartphones",
    "itemDescription": "Latest model smartphone with 128GB storage",
    "quantity": 100,
    "costPrice": 500,
    "sellingPrice": 700,
    "bulkPrice": 600,
    "qtyPerBulk": 10,
    "barcode": "123456789012",
    "productBrand": "BrandX",
    "color": "Black",
    "size": "Large",
    "expireDate": "2019-08-24T14:15:22Z",
    "memberPrice": 650,
    "supplierNo": "SUP12345",
    "storeId": "STORE001",
    "productType": "whole_item",
    "photoData": [
        "string"
    ]
}'

Responses

🟢200OK

*/*

Product created successfully.

Body

itemId

string

optional

slug

string

optional

itemName

string

optional

itemBarcode

string

optional

itemForm

string

optional

itemPictureId1

string

optional

itemPictureId2

string

optional