Get list of product

Get list of product


Resource URL

https://oms.sokochan.com/api/1.0/products


Parameter(s)

Name Description
limit Number of items per page (max 100)
offset Result set offset
curl -X GET -H "Authorization: Basic ZnJlZDpmcmVk="\
"https://oms.sokochan.com/api/1.0/products"
{
  "products": [
    {
      "item_code": "04300021",
      "sku": null,
      "ean": null,
      "number": "JPT0301-L",
      "name": "Crush on me - Navy blue/L",
      "width": 0,
      "height": 0,
      "length": 0,
      "weight": 0,
      "cost": 0,
      "selling_price": 0,
      "description": "",
      "enable": 1,
      "inventory": {
        "in_stock": 15,
        "on_order": 0,
        "available": 15
      }
    },
    {
      "item_code": "04300022",
      "sku": null,
      "ean": null,
      "number": "JPT0302-S",
      "name": "Crush on me - Black/S",
      "width": 0,
      "height": 0,
      "length": 0,
      "weight": 0,
      "cost": 0,
      "selling_price": 0,
      "description": "",
      "enable": 1,
      "inventory": {
        "in_stock": 2,
        "on_order": 0,
        "available": 2
      }
    },
    {
    	.............
    },
  "paging": {
    "limit": 20,
    "offset": 20,
    "total": 40
  }
}
		

Documentation

The fields of the result have the following type and meaning:

NameDescription
products[]Array of product object
pagingPaging object

Paging Object

NameDescription
paging.totalTotal number of items
paging.limitNumber of items per page
paging.offsetResult set offset

Product Object

NameDescriptionTypeLength
item_codeProduct code string20
skuProduct SKUstring60
numberProduct numberstring20
nameProduct namestring100
description
Product descriptionstring250
width
Product widthdecimal10,2
height
Product heightdecimal10,2
length
Product lengthdecimal10,2
weight
Product weightdecimal10,2
cost
Cost pricedecimal8,2
selling_price
Selling pricedecimal8,2
ean
EAN numberstring13
enableProduct enable in OMS
  • 1 = enable
  • 0 = disable
number1
inventory.in_stockQuantity of item in stocknumber11
inventory.on_orderQuantity of ordered itemnumber11
inventory.availableQuantity of available itemnumber11