Resource URL
https://oms.sokochan.com/api/1.0/products
Parameter(s)
Name |
Description |
skus (optional) |
List of sku separated by comma. example ?skus=1001,1002 |
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?skus=1001,1002&limit=100&offset=0"
{
"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:
Name |
Description |
products[] |
Array of product object |
paging |
Paging object |
Paging Object
Name |
Description |
paging.total |
Total number of items |
paging.limit |
Number of items per page |
paging.offset |
Result set offset |
Product Object
Name |
Description |
Type |
Length |
item_code |
Product code |
string |
20 |
sku |
Product SKU |
string |
60 |
number |
Product number |
string |
20 |
name |
Product name |
string |
100 |
description
|
Product description |
string |
250 |
width
|
Product width |
decimal |
10,2 |
height
|
Product height |
decimal |
10,2 |
length
|
Product length |
decimal |
10,2 |
weight
|
Product weight |
decimal |
10,2 |
cost
|
Cost price |
decimal |
8,2 |
selling_price
|
Selling price |
decimal |
8,2 |
ean
|
EAN number |
string |
13 |
enable |
Product enable in OMS
|
number |
1 |
inventory.in_stock |
Quantity of item in stock |
number |
11 |
inventory.on_order |
Quantity of ordered item |
number |
11 |
inventory.available |
Quantity of available item |
number |
11 |