Skip to end of banner

Go to start of banner

POST warehouse_transactions/stock_out

Skip to end of metadata

Created by Former user on Jul 06, 2017

Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

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:

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

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

A set of stock out items objects

The items that should be removed from the warehouse through this stock out 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_out_item parameter object data

Name

Type

Description

installed_item_identifier

(semi-optional)

String

An existing installed item that should be moved from 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 moved from 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

warehouse_transaction_batch_number

(semi-optional)

String

The batch number related to one or more warehouse transactions. All of the transactions' physical goods (traceable or non-traceable) they will be retrieved and included in the stock out transaction, if they still exist in the from warehouse (for traceable physical goods) or enough quantity exists (for non traceable physical goods).

Available from R14.2.0

quantity

(mandatory on conditions)

Number

The quantity of the non traceable physical goods that should be moved from the warehouse. This is available and mandatory only if a non traceable physical good is specified in the product_identifier parameter

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

Example 1

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": "DRAFT",
        "number": "11",
        "id": "48BB342AFB3AF5BE12E75CB4A7D3672F",
        "batch_number": null
    }
}

No labels