Page Comparison

Table of Contents

maxLevel	2

...

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:

Include Page

	V4:warehouse_identifier
	V4:warehouse_identifier

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:

Include Page

	V4:contact_information_identifier
	V4:contact_information_identifier

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

Anchor
stock-in referred parameters
stock-in referred parameters
Referred Parameter Objects

...

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 POSTEDPOSTED
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

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "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:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "life_cycle_state": "DRAFT",
        "number": "10",
        "id": "F2A0BC1B924C4E2E28B70AE695837B80",
        "batch_number": null
    }
}

...

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:

Include Page

	V4:warehouse_identifier
	V4:warehouse_identifier

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.

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

Anchor
stock-out referred parameters
stock-out referred parameters
Referred Parameter Objects

...

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 POSTEDcan 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

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "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:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "life_cycle_state": "DRAFT",
        "number": "11",
        "id": "48BB342AFB3AF5BE12E75CB4A7D3672F",
        "batch_number": null
    }
}

...

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:

Include Page

	V4:warehouse_identifier
	V4:warehouse_identifier

to_warehouse_identifier

(mandatory)

Warehouse identifier

The warehouse in which the items will be added into. The allowed warehouse identifier fields are the following:

Include Page

	V4:warehouse_identifier
	V4:warehouse_identifier

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.

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

Anchor
stock-movement referred parameters
stock-movement referred parameters
Referred Parameter Objects

...

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:

Include Page

	V4:warehouse_transaction_identifier
	V4:warehouse_transaction_identifier

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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

Versions Compared

Old Version 23

New Version 24

Key

Anchor
stock-in referred parameters
stock-in referred parameters
Referred Parameter Objects

Examples

Anchor
stock-out referred parameters
stock-out referred parameters
Referred Parameter Objects

Examples

Anchor
stock-movement referred parameters
stock-movement referred parameters
Referred Parameter Objects

Page Comparison

Versions Compared

Old Version 23

New Version 24

Key

Anchorstock-in referred parametersstock-in referred parametersReferred Parameter Objects

Examples

Anchorstock-out referred parametersstock-out referred parametersReferred Parameter Objects

Examples

Anchorstock-movement referred parametersstock-movement referred parametersReferred Parameter Objects

Anchor
stock-in referred parameters
stock-in referred parameters
Referred Parameter Objects

Anchor
stock-out referred parameters
stock-out referred parameters
Referred Parameter Objects

Anchor
stock-movement referred parameters
stock-movement referred parameters
Referred Parameter Objects