Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel2

POST warehouse_transactions/stock_in

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:

...

life_cycle_state

(mandatory)

...

String

...

batch_number

(optional)

...

supplier_identifier

(optional)

...

description

(optional)

...

udf_string_1

(optional)

...

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

...

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

idString

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

StringThe 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

Examples

...

titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "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
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "life_cycle_state": "DRAFT",
        "number": "10",
        "id": "F2A0BC1B924C4E2E28B70AE695837B80",
        "batch_number": null
    }
}

...

titleExample 2

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "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:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "life_cycle_state": "POSTED",
        "number": "760",
        "id": "6C7D44A92A874B509D16EBDB1D6E1B13"
    }
}

POST warehouse_transactions/stock_out

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:

...

life_cycle_state

(mandatory)

...

String

...

batch_number

(optional)

...

description

(optional)

...

udf_string_1

(optional)

...

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

...

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

idString

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

StringThe 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

Examples

...

titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "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
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "life_cycle_state": "DRAFT",
        "number": "11",
        "id": "48BB342AFB3AF5BE12E75CB4A7D3672F",
        "batch_number": null
    }
}

 

POST warehouse_transactions/stock_movement

This method is creating a new stock movement warehouse transaction

Resource URL

Parameters

...

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:

...

to_warehouse_identifier

(mandatory)

...

Warehouse identifier

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

...

life_cycle_state

(mandatory)

...

String

...

batch_number

(optional)

...

description

(optional)

...

udf_string_1

(optional)

...

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

...

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

idString

The ID of the stock movement warehouse transaction that was created

number

String

The number of the stock movement warehouse transaction that was created

 

batch_number

StringThe batch_number of the stock movement warehouse transaction that was created

life_cycle_state

String

 The stated of the transaction which can be DRAFT or POSTED

Examples

...

titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "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
themeConfluence
languagejavascript
linenumberstrue
{
  "status": {
    "message": null,
    "description": null,
    "code": "OK"
  },
  "data": {
    "life_cycle_state": "POSTED",
    "number": "8",
    "id": "BC4BB1E60B06623A25FAA563DD8103E1",
    "batch_number": null
  }
}

 

POST warehouse_transactions/post

This method is posting a warehouse transaction which is in a draft state

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

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:

...

 

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

idString

The ID of the stock movement warehouse transaction that was created

number

String

The number of the stock movement warehouse transaction that was created

batch_number

StringThe batch_number of the stock movement warehouse transaction that was created

life_cycle_state

String

 The stated of the transaction which can be DRAFT or POSTED

Examples

HTTP Method: POST

 

Request:

Body:

Expand
titleExample 1
Code Block
themeConfluence
languagejavascript
linenumberstrue
{
	"token":"363D92A1BAA5BF4EABECD87CDB691EA0",
    "warehouse_transaction_identifier":{"batch_number":"bn010009090"}
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{ "status": { "message": null, "description": null, "code": "OK" }, "data": { "life_cycle_state": "POSTED", "number": "290", "id": "F8A4A7B509DCFBE4AE969EF23C91602C", "batch_number": "bn010009090" } } Panel
nameblue

Child pages (Children Display)
alltrue
excerpttrue