list_transfers

POST /list_transfers

To get the TOTAL COUNT of list of transfers for multiple search criteria.

Use this method with only_counted = 'Y' FIRST to determine how many total records there are for the given criteria.

After you call this method with only_counted = 'Y', then call again this method with only_counted = 'N', and pass the required paging parameters.

			{
				"api_credentials": {
					"token": "XXXXX"
				},
				"filter_define": {
					"only_counted": "Y",
					"page_number": 1,
					"page_size": 100,
					"transfer_type":"open",
					"is_date_selection": false,
					"date_type":"issued",
					"from_date":"2017-01-01",
					"to_date":"2017-07-31",
					"from_stores_selection":"",
					"to_stores_selection":"",
					"reason_selection":"",
					"status_selection":"",
					"codes_selection":"",
					"code_type":"main"
				}
			}
		

To get a list of transfers for multiple search criteria.

			{
				"api_credentials": {
					"token": "XXXXX"
				},
				"filter_define": {
					"only_counted": "N",
					"page_number": 1,
					"page_size": 100,
					"transfer_type":"open",
					"is_date_selection": false,
					"date_type":"issued",
					"from_date":"2017-01-01",
					"to_date":"2017-07-31",
					"from_stores_selection":"",
					"to_stores_selection":"",
					"reason_selection":"",
					"status_selection":"",
					"codes_selection":"",
					"code_type":"main",
					"sorting_by": "IssuedDate",
					"sorting_type": "descending"
				}
			}
		

field	type	description
api_credentials
token	string	Credentials provided by Powersoft that allow access to the API
filter_define
only_counted	string	'Y' = brings only the total of transfers found based on user filter criteria. 'N' = brings the list of the transfers found based on user filter criteria
page_number	integer	The page number in the entire list. eg Page 1.
page_size	integer	The number of transfers to return. eg 10 transfers
transfer_type	string	'open' = Only the pending transfers. 'closed' = Only the completed transfers. 'all' = All the transfers
is_date_selection	boolean	If the search is by date
date_type	string	For which date the filter criteria is applied. 'issued' = search by the issued date. 'closed' = search by the completion date.
from_date	date	From date.
to_date	date	To date.
from_stores_selection	string	A comma separated list of 365 stores codes FROM where the stock was transferred (eg '001,401,...'). If the value is empty then no search criteria by from stores is applied.
to_stores_selection	string	A comma separated list of 365 stores codes where the stock was transferred TO (eg '001,401,...'). If the value is empty then no search criteria by to stores is applied.
reason_selection	string	A comma separated list of 365 reasons codes (eg 'ERROR,NT...'). If the value is empty then no search criteria by reason is applied.
status_selection	string	A comma separated list of 365 transfer status codes (eg 'TBD,APPROVED,...'). If the value is empty then no search criteria by transfer status is applied.
codes_selection	string	A comma separated list of transfers codes (eg '004000008,100000121,...'). If the value is empty then no search criteria by code is applied.
code_type	string	For which code the code_selection filter criteria is applied. 'main' - the search is applied by 365 transfer code. 'secondary' - the search is applied by your system code
sorting_by	string	The field the list is ordered by.Only 'IssuedDate', 'CompletedDate', 'PickingDate', 'FromStoreCode', 'ToStoreCode', 'TransferCode', 'TransferReason', 'TransferStatus' values are allowed. If it is not provided the default value is 'IssuedDate'.
sorting_type	string	Type of sorting for the resulted list. Only 'ascending', 'descending' values are allowed. If it is not provided the default value is 'descending'."

Returns

TOTAL COUNT of list of transfers for multiple search criteria (only_counted='Y').

			{
				"api_response": {
					"response_code": "1",
					"response_msg": "OK",
					"response_id": ""
				},
				"total_count_list_transfers": 2,
				"list_transfers": null
			}
		

List of transfers for multiple search criteria (only_counted='N').

			{
				"api_response": {
					"response_code": "1",
					"response_msg": "OK",
					"response_id": ""
				},
				"total_count_list_transfers": 2,
				"list_transfers": [
					{
						"transfer_header": {
							"transfer_secondary_code": "",
							"transfer_code_365": "001000038",
							"from_store_code_365": "001",
							"to_store_code_365": "100",
							"transfer_reason_code_365": "NT",
							"transfer_reason_name": "NORMAL TRANSFER",
							"transfer_is_completed": false,
							"transfer_issued_date_utc0": "2014-06-25 09:39:09",
							"transfer_completed_date_utc0": "",
							"transfer_comments": "",
							"transfer_status_id_365": 14,
							"transfer_status_code_365": "APPROVED",
							"transfer_status_name": "Approved",
							"transfer_status_html_colour_code": "#33FF80",
							"allow_acccept_transfer": true
						},
						"list_transfer_details": [
							{
								"line_number": 1,
								"item_code_365": "DRESS321-AQUA-M",
								"item_name": "dres321",
								"line_quantity": 20,
			                    "line_picked_quantity": 2
							}
						]
					},
					{
						"transfer_header": {
							"transfer_secondary_code": "",
							"transfer_code_365": "001000039",
							"from_store_code_365": "001",
							"to_store_code_365": "100",
							"transfer_reason_code_365": "NT",
							"transfer_reason_name": "NORMAL TRANSFER",
							"transfer_is_completed": false,
							"transfer_issued_date_utc0": "2014-06-25 09:41:16",
							"transfer_completed_date_utc0": "",
							"transfer_comments": "",
							"transfer_status_id_365": 14,
							"transfer_status_code_365": "APPROVED",
							"transfer_status_name": "Approved",
							"transfer_status_html_colour_code": "#33FF80",
							"allow_acccept_transfer": true
						},
						"list_transfer_details": [
							{
								"line_number": 1,
								"item_code_365": "COKE",
								"item_name": "coca cola",
								"line_quantity": 5,
			                    "line_picked_quantity": 5
							}
						]
					}
				]
			}
		

---