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.

...

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": "33610",
        "id": "C8D9AECE85C160AEB18B6FE0148A12FFF2A0BC1B924C4E2E28B70AE695837B80",
        "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.

...

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": "POSTEDDRAFT",
        "number": "29111",
        "id": "BDDB284AD8E12E9753D838C126F33D7048BB342AFB3AF5BE12E75CB4A7D3672F",
        "batch_number": "bn00090221"null
    }
}

POST warehouse_transactions/stock_movement

...

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.

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

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

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "status": {
    "message": null,
    "description": null,
    "code": "OK"
  },
  "data": {
    "life_cycle_state": "POSTED",
    "number": "3418",
    "id": "0315BF181670C8A00E014058D12FC0C0BC4BB1E60B06623A25FAA563DD8103E1",
    "batch_number": "BNSTOCKOUT009null"
  }
}

POST warehouse_transactions/post

...

Versions Compared

Old Version 20

New Version 21

Key

POST warehouse_transactions/stock_movement

POST warehouse_transactions/post

Page Comparison

Versions Compared

Old Version 20

New Version 21

Key

POST warehouse_transactions/stock_movement

POST warehouse_transactions/post