API Overview Resources Schemas

Stock

Operations with stock

Get stock by date.

GET /orgs/{orgId}/stock

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
date	query	string	true	Date
references	query	string	false	References separated by comma
vwarehouseIds	query	string	false	Virtual warehouse ids separated by comma

Request example

1
2
3
4
5



curl -X GET https://logistics-stock.sta.masstack.com/v1/orgs/yoigo/stock?date='2022-09-24'&references='REF1,REF2'&vwarehouseIds='1,2'?date=2022-09-24 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Success	[StockDto]
400	Bad Request	Bad Request	Error400
404	Not Found	Not found	Error404
500	Internal Server Error	Internal Server Error	Error500

200 - instance of StockDto

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


[
  {
    "stockId": 1,
    "productId": 10,
    "vwarehouseId": 56,
    "totalAmount": 25,
    "availableAmount": 100,
    "reservedAmount": 45,
    "stockDate": "2022-02-20",
    "reference": "reference1",
    "prepickingOrders": 10
  }
]

Name	Type	Required	Description
stockId	integer	false	none
productId	integer	false	none
vwarehouseId	integer	false	none
totalAmount	integer	false	none
availableAmount	integer	false	none
reservedAmount	integer	false	none
stockDate	string	false	none
reference	string	false	none
prepickingOrders	integer	false	none

Insert a stock's item.

POST /orgs/{orgId}/stock

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
body	body	CreateStockDto	true	Information needed to insert a stock’s item

Request body - instance of CreateStockDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "stockId": 1,
  "productId": 10,
  "vwarehouseId": 56,
  "totalAmount": 25,
  "availableAmount": 100,
  "reservedAmount": 45,
  "stockDate": "2022-02-20",
  "reference": "reference1",
  "prepickingOrders": 10
}

Name	Type	Required	Description
stockId	integer	false	none
productId	integer	false	none
vwarehouseId	integer	false	none
totalAmount	integer	false	none
availableAmount	integer	false	none
reservedAmount	integer	false	none
stockDate	string	false	none
reference	string	false	none
prepickingOrders	integer	false	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17



curl -X POST https://logistics-stock.sta.masstack.com/v1/orgs/yoigo/stock \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'stockId': 1,
  'productId': 10,
  'vwarehouseId': 56,
  'totalAmount': 25,
  'availableAmount': 100,
  'reservedAmount': 45,
  'stockDate': '2022-02-20',
  'reference': 'reference1',
  'prepickingOrders': 10
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Success	StockDto
400	Bad Request	Bad Request	Error400
404	Not Found	Not found	Error404
500	Internal Server Error	Internal Server Error	Error500

Endpoints

Base products

Products

Characteristics

Delivery commitment

Inputs

Input Types

Outputs

Output Types

Stock

Physical Warehouse

Virtual Warehouse

Returns

Devices

Providers

Logistic Operators

Commercial Brands

Commercial Distributions

Status