API Overview Resources Schemas

Virtual Warehouse

Operations with virtual warehouse

Insert a virtual warehouse from a physical warehouse id.

POST /orgs/{orgId}/pwarehouse/{pWarehouseId}/vwarehouse

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
pWarehouseId	path	integer	true	Physical warehouse id
body	body	CreateVirtualWarehouseDto	true	Information needed to insert a virtual warehouse

Request body - instance of CreateVirtualWarehouseDto

1
2
3
4


{
  "name": "name",
  "receptorId": 10
}

Name	Type	Required	Description
name	string	false	none
receptorId	integer	false	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10



curl -X POST https://logistics-stock.sta.masstack.com/v1/orgs/yoigo/pwarehouse/1/vwarehouse \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'name': 'name',
  'receptorId': 10
}" 

Responses

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

Get a virtual warehouse from physical warehouse id.

Get all virtual warehouse related to physical warehouse id.

GET /orgs/{orgId}/pwarehouse/{pWarehouseId}/vwarehouse

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
pWarehouseId	path	integer	true	Physical warehouse id

Request example

1
2
3
4
5



curl -X GET https://logistics-stock.sta.masstack.com/v1/orgs/yoigo/pwarehouse/1/vwarehouse \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

Get a concrete virtual warehouse from physical warehouse id.

GET /orgs/{orgId}/pwarehouse/{pWarehouseId}/vwarehouse/{vWarehouseId}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
pWarehouseId	path	integer	true	Physical warehouse id
vWarehouseId	path	integer	true	Virtual warehouse id

Request example

1
2
3
4
5



curl -X GET https://logistics-stock.sta.masstack.com/v1/orgs/yoigo/pwarehouse/1/vwarehouse/1 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

Search virtual warehouse.

Search virtual warehouse from multiple parameters.

POST /orgs/{orgId}/vwarehouse/search

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
body	body	VirtualWarehouseDto	true	Information needed to insert a virtual warehouse

Request body - instance of VirtualWarehouseDto

1
2
3
4
5


{
  "vwarehouseId": 15,
  "name": "name",
  "receptorId": 1
}

Name	Type	Required	Description
vwarehouseId	integer	false	none
name	string	false	none
receptorId	integer	false	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11



curl -X POST https://logistics-stock.sta.masstack.com/v1/orgs/yoigo/vwarehouse/search \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'vwarehouseId': 15,
  'name': 'name',
  'receptorId': 1
}" 

Responses

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

200 - instance of VirtualWarehouseDto

Custom schema example

1
2
3
4
5
6
7


[
  {
    "vwarehouseId": 15,
    "name": "name",
    "receptorId": 1
  }
]

Name	Type	Required	Description
vwarehouseId	integer	false	none
name	string	false	none
receptorId	integer	false	none

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