Warehouse Transactions

Get transactions

get

/warehouses/transactions/

This api is used to fetch warehouse transactions from OutSmart. Filters can be given by adding a key and values array to the URL. Adding a single filter: &key=key1&value=value1&operator=gt Adding multiple filters: &key[]=key1&value[]=value1&operator[]=eq&key[]=key2&value[]=value2&operator[]=gt

Following operators are allowed:

Operator	Description
li	Like (%)
eq	Equal (=)
ne	Not equal (!=)
gt	Greather than (>)
ge	Greather than or equal (>=)
lt	Less than (<)
le	Less than or equal (<=)
Transaction parameters. The invoice id of a transaction transaction can be empty if a transaction is not assigned to an invoice. Once it is assigned the balance of the invoice will be adjusted.

Parameter	Description	Type
wst_id	Warehouse Transaction Primary Key	int(11)
wst_cus_id	Customer ID	int(11)
wst_transaction_id	Transaction ID	varchar(255)
wst_article_code	Article code	varchar(255)
wst_article_description	Article description	varchar(255)
wst_wse_code	Warehouse code	varchar(55)
wst_wse_description	Warehouse description	varchar(255)
wst_amount	Transaction amount	decimal(20,5)
wst_type	Transaction type (1: In / 2: Out)	varchar(55)
wst_reference_type	Origin entity of transaction	varchar(55)
wst_reference	Origin record of transaction	varchar(255)
wst_order_nr	Work order number of transaction	varchar(255)
wst_object_code	Object code for transaction	varchar(255)
wst_remarks	Remarks for transaction	text
wst_status	Transaction status (PENDING/PROCESSED)	varchar(55)
wst_date	Transaction date	timestamp
wst_timestamp_create	Creation date of transaction	timestamp
wst_timestamp_mutate	Mutation date of transaction	timestamp
wst_timestamp_processed	Processed date of transaction	timestamp
wst_user_create	Transaction created by	varchar(255)
wst_user_mutate	Transaction mutated by	varchar(255)
wst_user_processed	Transaction processed by	varchar(255)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tokenstringOptionalExample: {{client_token}}

software_tokenstringOptionalExample: {{software_token}}

keystringOptionalExample: wst_transaction_id

operatorstringOptionalExample: eq

valuestringOptionalExample: 5ca081181e65ca6d9381085c379383b7

Responses

200

Get transactions

application/json

get/warehouses/transactions/

GET /warehouses/transactions/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Get transactions

{
  "code": 200,
  "messages": [],
  "response": [
    {
      "wst_id": "43",
      "wst_cus_id": "78",
      "wst_transaction_id": "40a21bf776a230f97d54f73a0f96c32b",
      "wst_article_code": "00001",
      "wst_article_description": "Omschrijving 1",
      "wst_wse_code": "1",
      "wst_wse_description": "Bus 1",
      "wst_amount": "-2.00000",
      "wst_type": "",
      "wst_reference_type": "ORDER",
      "wst_reference": "1942063",
      "wst_order_nr": null,
      "wst_obj_code": null,
      "wst_remarks": "",
      "wst_status": "PENDING",
      "wst_date": "2024-08-02 00:00:00",
      "wst_timestamp_create": "2024-08-02 09:58:01",
      "wst_timestamp_mutate": "2024-08-02 09:58:01",
      "wst_timestamp_processed": null,
      "wst_user_create": null,
      "wst_user_mutate": null,
      "wst_user_processed": null
    }
  ]
}

Add transactions

post

/warehouses/transactions/

Parameter	Description	Required	Type
wst_transaction_id	Transaction ID	N	varchar(255)
wst_article_code	Article code	Y	varchar(255)
wst_article_description	Article description	N	varchar(255)
wst_wse_code	Warehouse code	Y	varchar(55)
wst_wse_description	Warehouse description	N	varchar(255)
wst_amount	Transaction amount	Y	decimal(20,5)
wst_type	Transaction type (1: In / 2: Out)	N	varchar(55)
wst_reference_type	Origin entity of transaction	N	varchar(55)
wst_reference	Origin record of transaction	N	varchar(255)
wst_order_nr	Work order number of transaction	N	varchar(255)
wst_object_code	Object code for transaction	N	varchar(255)
wst_remarks	Remarks for transaction	N	text
wst_status	Transaction status (PENDING/PROCESSED)	Y	varchar(55)
wst_date	Transaction date (Y-M-D H:i:s)	N	timestamp

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tokenstringOptionalExample: {{client_token}}

software_tokenstringOptionalExample: {{software_token}}

Responses

200

Add transactions

application/json

post/warehouses/transactions/

POST /warehouses/transactions/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Add transactions

{
  "code": 200,
  "messages": [],
  "response": 1
}