Available from CRM.COM R14.5.0
This method is creating a new stock adjustment warehouse transaction
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
warehouse_identifier (mandatory) | Warehouse identifier | The warehouse for which the non-traceable physical goods will be adjusted. 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 adjustment items objects | The items of which their balance will be adjusted through this stock adjustment 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
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 |
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
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"warehouse_identifier":{"name":"Main Warehouse"},
"batch_number":"0001",
"life_cycle_state":"POSTED",
"items_set":
[
{
"product_identifier":{"code":"Antenna"},
"counted_balance":414
}
]
}
Response:
{
"data": {
"number": "2598",
"batch_number": "0001",
"id": "00FD0FD284FE4E32AB3D15E3E701DDA8",
"life_cycle_state": "POSTED"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}