POST warehouse_transactions/stock_in
This method is creating a new stock in warehouse transaction
Resource URL
Parameters
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:
| |||||||||||||||||||||
life_cycle_state (mandatory) | String | The stated of the transaction which can be DRAFT or POSTED | |||||||||||||||||||||
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_float_5 (optional) | Float | User Defined Field of type Float | |||||||||||||||||||||
udf_float_6 (optional) | Float | User Defined Field of type Float | |||||||||||||||||||||
udf_float_7 (optional) | Float | User Defined Field of type Float | |||||||||||||||||||||
udf_float_8 (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. |
Referred Parameter Objects
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 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 |
life_cycle_state | String | The stated of the transaction which can be DRAFT or POSTED |
Examples
HTTP Method: POST
Request:
Body:
{
"token":"47995B93A94E35C992956091325A3D92",
"warehouse_identifier":{"name":"Central Warehouse"},
"life_cycle_state":"DRAFT",
"supplier_identifier":{"id_number":"984783"},
"description":"Stock in transaction of a broken TV to the Central Warehouse",
"items_set":
[
{
"installed_item_identifier":{"serial_number":"T1M001000000001"},
"alternative_code":"T1M001000000001",
"unit_cost":80
},
{
"product_identifier":{"code":"Universal Remote Controls"},
"quantity":50
}
]
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"life_cycle_state": "DRAFT",
"number": "336",
"id": "C8D9AECE85C160AEB18B6FE0148A12FF",
"batch_number": null
}
}
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:
| ||||||||||||
life_cycle_state (mandatory) | String | The stated of the transaction which can be DRAFT or POSTED | ||||||||||||
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_5 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_6 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_7 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_8 (optional) | Float | User Defined Field of type Float | ||||||||||||
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. |
Referred Parameter Objects
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 |
life_cycle_state | String | The stated of the transaction which can be DRAFT or POSTED |
Examples
HTTP Method: POST
Request:
Body:
{
"token":"9A30B8EAB0A28E012329162912CC0736",
"warehouse_identifier":{"name":"Central Warehouse"},
"life_cycle_state":"DRAFT",
"supplier_identifier":{"id_number":"984783"},
"description":"Stock out transaction of a broken TV from Central Warehouse",
"items_set":
[
{
"installed_item_identifier":{"serial_number":"T1M001000000001"},
"alternative_code":"T1M001000000001",
"unit_cost":80
},
{
"product_identifier":{"code":"Universal Remote Controls"},
"quantity":50
}
]
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"life_cycle_state": "POSTED",
"number": "291",
"id": "BDDB284AD8E12E9753D838C126F33D70",
"batch_number": "bn00090221"
}
}
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:
| ||||||||||||
life_cycle_state (mandatory) | String | The stated of the transaction which can be DRAFT or POSTED | ||||||||||||
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_5 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_6 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_7 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_8 (optional) | Float | User Defined Field of type Float | ||||||||||||
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. |
Referred Parameter Objects
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 |
life_cycle_state | String | The stated of the transaction which can be DRAFT or POSTED |
Examples
HTTP Method: POST
Request:
Body:
{
"token":"17C740BDB131F9709BD8BD605DCC0373",
"from_warehouse_identifier":{"name":"Installation Group-WHS New Items"},
"to_warehouse_identifier":{"name":"Sales Branch 1 - WHS New Items"},
"life_cycle_state":"POSTED",
"items_set":
[
{
"installed_item_identifier": { "serial_number":"cv2000000001" }
}
]
}
Response:
{
"status": {
"message": null,
"description": null,
"code": "OK"
},
"data": {
"life_cycle_state": "POSTED",
"number": "341",
"id": "0315BF181670C8A00E014058D12FC0C0",
"batch_number": "BNSTOCKOUT009"
}
}
POST warehouse_transactions/post
This method is posting a warehouse transaction which is in a draft state
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
| warehouse_transaction_identifier | Warehouse transaction identifier | The warehouse transaction that should be posted. Only warehouse transactions is draft state can be specified. The allowed warehouse transaction identifier fields are the following:
|
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 |
life_cycle_state | String | The stated of the transaction which can be DRAFT or POSTED |
Examples
HTTP Method: POST
Request:
Body:
{
"token":"363D92A1BAA5BF4EABECD87CDB691EA0",
"warehouse_transaction_identifier":{"batch_number":"bn010009090"}
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"life_cycle_state": "POSTED",
"number": "290",
"id": "F8A4A7B509DCFBE4AE969EF23C91602C",
"batch_number": "bn010009090"
}
}