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: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the warehouse | name (semi-optional) | String | The name of the warehouse | alternative_code (semi-optional) | String | The alternative code of the warehouse |
|
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:Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the contact information | id_number (semi-optional) | String | The ID number of the contact information Applicable only for contact information that represent PERSON | passport_number (semi-optional) | String | The passport number of the contact information Applicable only for contact information that represent PERSON | social_security_number (semi-optional) | String | The social security number of the contact information Applicable only for contact information that represent PERSON | vat_registration_number (semi-optional) | String | The VAT registration number of the contact information Applicable only for contact information that represent COMPANY | registration_number (semi-optional) | String | The registration number of the contact information Applicable only for contact information that represent COMPANY |
|
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. |
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Referred Parameter Objects
stock_in_item parameter object data
| | |
|---|
installed_item_identifier
(semi-optional) | String | An existing installed item that should be added in the warehouse. The allowed installed item identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the installed item | serial_number (semi-optional) | String | The serial number of the installed item | alternative_code (semi-optional) | String | The alternative code of a installed item |
|
product_identifier
(semi-optional) | String | A non traceable physical good that should be added in the warehouse. The allowed physical good product identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product | code (semi-optional) | String | The code of the product | alternative_code (semi-optional) | String | The alternative code of the product |
|
quantity
(mandatory on conditions) | Number | The quantity of the non traceable physical goods that should be added in the warehouse.. This is available and mandatory only if a non traceable physical good is specified in the product_identifier parameter
|
| unit_cost | Number | The unit cost of the item to be added |
installed_item (semi-optional) | Installed item object | A new installed item that should be created and added in the warehouse. |
Referred Parameter Objects
installed_item parameter object data
Name | Type | Description |
serial_number (mandatory) | String | The serial number of the installed item to be created |
alternative_code (mandatory) | String | The alternative code of the installed item to be created |
product_identifier (mandatory) | Products identifier | The product that will be related with the installed item. The allowed product identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product | code (semi-optional) | String | The code of the product | alternative_code (semi-optional) | String | The alternative code of the product |
|
category_identifier (optional) | Installed item category identifier | The installed item category that will be related with the installed item. The allowed installed item category identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the installed item category | name (semi-optional) | String | The name of the installed item category | code (semi-optional) | String | The code of the installed item category |
|
state (mandatory) | String | The state of the installed item to be created, which can be EFFECTIVE or NOT_EFFECTIVE |
notes (optional) | String | Notes for the installed item 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 |
components_set (mandatory and applicable on conditions) | Set of Installed Item Components | The components that should be added on the installed item that will be created. This information is applicable and mandatory if the installed item that will be created has a product type classified as fixed product bundle |
Referred Parameter Objects
installed_item_component parameter object data
Name | Type | Description |
serial_number (mandatory) | String | The serial number of the installed item to be created |
alternative_code (mandatory) | String | The alternative code of the installed item to be created |
product_identifier (mandatory) | Products identifier | The product that will be related with the installed item. The allowed product identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product | code (semi-optional) | String | The code of the product | alternative_code (semi-optional) | String | The alternative code of the product |
|
category_identifier (optional) | Installed item category identifier | The installed item category that will be related with the installed item. The allowed installed item category identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the installed item category | name (semi-optional) | String | The name of the installed item category | code (semi-optional) | String | The code of the installed item category |
|
state (mandatory) | String | The state of the installed item to be created, which can be EFFECTIVE or NOT_EFFECTIVE |
notes (optional) | String | Notes for the installed item 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 |
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 |
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Examples
Example 1
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": "10",
"id": "F2A0BC1B924C4E2E28B70AE695837B80",
"batch_number": null
}
}
Example 2
HTTP Method: POST
Request:
Body:
{
"token":"3FDEA28E7C61447DA2C5BE42CAE24A67",
"warehouse_identifier":{
"name":"Admin Group - WHS New Items"
},
"life_cycle_state":"POSTED",
"items_set":[
{
"installed_item":{
"serial_number":"DEC000000969",
"product_identifier":{
"code":"Decoders 1"
},
"state":"EFFECTIVE",
"components_set":[
{
"serial_number":"SM000000969",
"product_identifier":{
"code":"Smartcard 1"
},
"state":"EFFECTIVE"
}
]
},
"unit_cost":80
}
]
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"life_cycle_state": "POSTED",
"number": "760",
"id": "6C7D44A92A874B509D16EBDB1D6E1B13"
}
}