| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
warehouse_identifier (mandatory) | Warehouse identifier | The warehouse in which the items will be added into. The allowed warehouse identifier fields are the following:
| ||||||
batch_number (optional) | String | A reference number which is entered to keep track of the warehouse transaction source | ||||||
supplier_identifier (optional) | Contact information identifier | The supplier of the items to be added. Suppliers refer to contact information. The allowed contact information identifier fields are the following:
| ||||||
description (optional) | String | A description for the warehouse transaction to be created | ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||
| items_set | A set of stock in items objects | The items that should be added in the warehouse through this stock in transaction. |
...
Name | Type | Description |
| id | String | The ID of the stock in warehouse transaction that was created |
number | String | The number of the stock in warehouse transaction that was created
|
batch_number | String | The batch_number of the stock in warehouse transaction that was created |
Examples
Example 1
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
POST warehouse_transactions/stock_out
This method is creating a new stock out warehouse transaction
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
warehouse_identifier (mandatory) | Warehouse identifier | The warehouse from which the items will be removed from. The allowed warehouse identifier fields are the following:
| ||||||
batch_number (optional) | String | A reference number which is entered to keep track of the warehouse transaction source | ||||||
description (optional) | String | A description for the warehouse transaction to be created | ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||
| items_set | A set of stock out items objects | The items that should be removed from the warehouse through this stock out transaction. |
Anchor stock-out referred parameters stock-out referred parameters
Referred Parameter Objects
| stock-out referred parameters | |
| stock-out referred parameters |
| Include Page | ||||
|---|---|---|---|---|
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
| id | String | The ID of the stock out warehouse transaction that was created |
number | String | The number of the stock out warehouse transaction that was created
|
batch_number | String | The batch_number of the stock out warehouse transaction that was created |
Examples
Example 1
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
POST warehouse_transactions/stock_movement
This method is creating a new stock movement warehouse transaction
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
from_warehouse_identifier (mandatory) | Warehouse identifier | The warehouse from which the items will be removed from. The allowed warehouse identifier fields are the following:
| ||||||
to_warehouse_identifier (mandatory) | Warehouse identifier | The warehouse in which the items will be added into. The allowed warehouse identifier fields are the following:
| ||||||
batch_number (optional) | String | A reference number which is entered to keep track of the warehouse transaction source | ||||||
description (optional) | String | A description for the warehouse transaction to be created | ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||
| items_set | A set of stock movement items objects | The items that should be moved from one warehouse to another through this stock movement transaction. |
Anchor stock-movement referred parameters stock-movement referred parameters
Referred Parameter Objects
| stock-movement referred parameters | |
| stock-movement referred parameters |
| Include Page | ||||
|---|---|---|---|---|
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
| id | String | The ID of the stock movement warehouse transaction that was created |
number | String | The number of the stock movement warehouse transaction that was created
|
batch_number | String | The batch_number of the stock movement warehouse transaction that was created |
Examples
Example 1
HTTP Method: POST
Request:
...