Transfer

The Transfer API is where item transfers for venues originate. It pulls and shares data with our other cloud services such as Data Management and the Portal.

Security

jwt-bearer-token

apiKey	API Key
Name	Authorization
In	header

Endpoints

GET /transfer/schema

Summary

The schema of the transfer.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company to manage data for

Responses

Code	Description	Schema
200	Success	transfer_get_response_1
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

GET /transfer/{id}

Summary

Get the transfer detail.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company to manage data for
path	`id`	string	Yes	Transfer's document `_id` from the database
query	`get_updated_items`	boolean	No	Get updated items

Responses

Code	Description	Schema
200	Success	transfer_get_response_2
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

PATCH /transfer/{id}

Summary

Update the transfer.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company to manage data for
path	`id`	string	Yes	Transfer's document `_id` from the database
body	`body`	transfer_patch_body_7	Yes	The JSON formatted request

Responses

Code	Description	Schema
204	No content
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

GET /transfer

Summary

Get the transfer list.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company who owns the document.
query	`$filter`	string	No
query	`$top`	number	No	The maximum documents to return. For example, if `top` is 100, and `skip` is 0, the system returns documents 1 to 100
query	`$skip`	number	No	The documents to skip before returning. For example, if `top` is 100, and `skip` is 100, the system returns documents 101 to 200.
query	`$select`	string	No
query	`$orderby`	string	No

Responses

Code	Description	Schema
200	Success	transfer_get_response_3
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

POST /transfer

Summary

Create the transfer.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company to manage data for
body	`body`	transfer_post_body_8	Yes	The JSON formatted request

Responses

Code	Description	Schema
201	Success	transfer_post_response_8
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

PATCH /transfer/{id}/acknowledge

Summary

Acknowledgement to remove the Data Management sync result reminder information in the Transfer module.

Requirements

Remove fields updated_items/unavailable_items in the transfer document.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company to manage data for
path	`id`	string	Yes	`objectID`, the transfer's ID

Responses

Code	Description	Schema
204	No content
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

PATCH /transfer/bulk-change-status

Summary

Request a bulk change of the status of a given transfer.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
body	`body`	transfer_patch_body_5	Yes	The JSON formatted request

Responses

Code	Description	Schema
200	Success	transfer_patch_response_5
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

PATCH /transfer/dm-sync

Summary

Check inventory items for changes.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
body	`body`	transfer_patch_body_6	Yes	The JSON formatted request

Responses

Code	Description	Schema
200	Success	transfer_patch_response_6
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

POST /transfer/validate-change

Summary

Validate whether transfers can be changed.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
body	`body`	transfer_post_body_9	Yes	The JSON formatted request

Responses

Code	Description	Schema
200	Success	transfer_post_response_9_item
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

Data Models

transfer_get_response_1

Field Name	Type	Description
`transfer_get_response_1`	object	The definition of the transfer schema

transfer_get_response_2

Field Name	Type	Description
`_id`	string
`transaction_id`	string
`site_id`	string	The transfer from site identifier (ID)
`site_name`	string	The transfer from site name
`store_number`	string	The transfer store number from
`site_id_to`	string	The transfer to site ID
`site_name_to`	string	The transfer to site name
`site_department_code_to`	string	The transfer to site department code
`store_number_to`	string	The transfer store number to
`type`	string	The type of transaction
`transfer_type`	string	The type of transfer
`status`	string	The status of transaction
`inventory_items`	[ transfer_get_response_2_inventory_items ]	The reference schema
`status_history`	[ transfer_get_response_2_status_history ]	The status changed history
`transaction_date`	date/time
`total_cost`	number
`request_cost`	number	The request cost of `inventory_items`
`received_cost`	number	The received cost of `inventory_items`
`reversed_cost`	number	The reversed cost of `inventory_items`
`updated_items`	object
`unavailable_items`	object
`transfer_group_entity_id`	string	The transfer group entity ID

transfer_get_response_2_inventory_items

Field Name	Type	Description
`transfer_get_response_2_inventory_items`	object

transfer_get_response_2_status_history

Field Name	Type	Description
`transfer_get_response_2_status_history`	object

transfer_get_response_3

Field Name	Type	Description
`items`	[ transfer_get_response_3_items ]
`total`	number
`page_count`	number
`current_page`	number
`page_size`	number

transfer_get_response_3_items

Field Name	Type	Description
`_id`	string
`type`	string	The type of transaction
`transfer_type`	string	The type of transfer
`site_id`	string	The transfer from site identifier (ID)
`site_id_to`	string	The transfer to site ID
`site_name`	string	The transfer from site name
`site_name_to`	string	The transfer to site name
`site_department_code_to`	string	The transfer to site department code
`store_number`	string	The transfer store number from
`store_number_to`	string	The transfer store number to
`transaction_date`	date/time
`inventory_items`	[transfer_get_response_3_items_inventory_items]
`total_cost`	number	The total cost of `inventory_items`
`request_cost`	number	The request cost of `inventory_items`
`received_cost`	number	The received cost of `inventory_items`
`reversed_cost`	number	The reversed cost of `inventory_items`
`status`	string	The status of transaction
`transfer_group_entity_id`	string	The transfer group entity ID

transfer_get_response_3_items_inventory_items

Field Name	Type	Description
`transfer_get_response_3_items_inventory_items`	object

transfer_patch_body_5

Field Name	Type	Required	Description
`transfer_ids`	[string]	Yes	A list of the transfer identifiers (IDs)
`to_status`	string	Yes	The `to_status` to change. Enum: `pending`, `completed`, `closed`, `rejected`, `canceled`, `void`
`is_sync`	boolean	Yes	The flag that indicates whether to return results synchronously

transfer_patch_response_5

Field Name	Type	Description
`_id`	string	`objectId`, the task's identifier (ID)
`company_id`	string	`objectId`, the company's ID
`type`	string	The task type of bulk-change-status
`status`	string	The task status including `pending`, `running`, `failed`, and `completed`
`error_message`	string	The error message if the task fails
`sub_tasks`	transfer_patch_response_5_sub_tasks
`created_at`	date/time
`updated_at`	date/time

transfer_patch_response_5_sub_tasks

Field Name	Type	Description
`_id`	string	`objectId`, the task's identifier (ID)
`company_id`	string	`objectId`, the company's ID
`type`	string	The task type of bulk-change-status
`status`	string	The task status including `pending`, `running`, `failed`, and `completed`
`error_message`	string	The error message if the task fails
`value`	transfer_patch_response_5_sub_tasks_value
`created_at`	date/time
`updated_at`	date/time

transfer_patch_response_5_sub_tasks_value

Field Name	Type	Description
`transfer_id`	string	The transfer document identifier (ID)
`transfer_status`	string	The transfer status after task execution

transfer_patch_body_6

Field Name	Type	Required	Description
`transfer_ids`	[string]	Yes	A list of transfer identifiers (IDs)
`is_sync`	boolean	No	The flag that indicates whether to return results synchronously

transfer_patch_response_6

Field Name	Type	Description
`_id`	string	`objectId`, the task's identifier (ID)
`company_id`	string	`objectId`, the company's ID
`type`	string	The transfer-dm-sync type
`status`	string	The transfer-dm-sync status including `pending`, `running`, `failed`, and `completed`
`error_message`	string	The transfer-dm-sync error message
`sub_tasks`	[transfer_patch_response_6_sub_tasks]
`created_at`	date/time
`updated_at`	date/time

transfer_patch_response_6_sub_tasks

Field Name	Type	Description
`_id`	string	`objectId`, the task's identifier (ID)
`company_id`	string	`objectId`, the company's ID
`type`	string	The transfer-dm-sync type
`status`	string	The transfer-dm-sync status including `pending`, `running`, `failed`, and `completed`
`error_message`	string	The transfer-dm-sync error message
`value`	transfer_patch_response_6_sub_tasks_value
`created_at`	date/time
`updated_at`	date/time

transfer_patch_response_6_sub_tasks_value

Field Name	Type	Description
`transfer_id`	string	The transfer document identifier (ID)
`is_acknowledge`	boolean	The flag that indicates whether to call the acknowledge

transfer_patch_body_7

Field Name	Type	Description
`transaction_id`	string	The transaction identifier (ID)
`event_id`	string
`site_id`	string	The transfer site ID (from)
`site_id_to`	string	The transfer site ID (to)
`type`	string	The type is transfer. Enum: `transfer`
`transfer_type`	string	The type of transfer
`status`	string	The transfer status
`inventory_items`	[transfer_patch_body_7_inventory_items]	The inventory items to be transferred
`transaction_date`	date/time	The date of the transfer

transfer_patch_body_7_inventory_items

Field Name	Type	Required
`_id`	string	No
`item_entity_id`	string	Yes
`measure_entity_id`	string	Yes
`initial_count`	number	No
`count`	number	No

transfer_post_body_8

Field Name	Type	Required	Description
`transaction_id`	string	No	The transaction identifier (ID)
`event_id`	string	No
`site_id`	string	Yes	The transfer site ID (from)
`site_id_to`	string	Yes	The transfer site ID (to)
`type`	string	No	The type is transfer. Enum: `transfer`
`transfer_type`	string	No	The type of transfer
`status`	string	No	The transfer status
`inventory_items`	[transfer_post_body_8_inventory_items]	No	The inventory items to be transferred
`transaction_date`	date/time	No	The date of the transfer
`transfer_group_entity_id`	string	No	The transfer group entity ID

transfer_post_body_8_inventory_items

Field Name	Type	Required
`_id`	string	No
`item_entity_id`	string	Yes
`measure_entity_id`	string	Yes
`initial_count`	number	Yes

transfer_post_response_8

Field Name	Type	Description
`_id`	string
`transaction_id`	string
`site_id`	string	The transfer from site identifier (ID)
`site_name`	string	The transfer from site name
`store_number`	string	The transfer store number from
`site_id_to`	string	The transfer to site ID
`site_name_to`	string	The transfer to site name
`site_department_code_to`	string	The transfer to site department code
`store_number_to`	string	The transfer store number to
`type`	string	The type of transaction
`status`	string	The status of transaction
`inventory_items`	transfer_post_response_8_inventory_items
`transaction_date`	date/time
`total_cost`	number
`request_cost`	number
`received_cost`	number
`reversed_cost`	number
`transfer_group_entity_id`	string	The transfer group entity ID
`company_id`	string	The company ID of the user
`created_at`	date/time	The date of the creation
`created_by`	string	The `created_by` user ID
`updated_at`	date/time	The date of the update
`updated_by`	string	The `updated_by` user ID

transfer_post_response_8_inventory_items

Field Name	Type	Description
`transfer_post_response_8_inventory_items`	object

transfer_post_body_9

Field Name	Type	Required	Description
`_id`	[string]	Yes	The transfer document identifier (ID) list
`_change`	transfer_post_body_9__change	Yes

transfer_post_body_9__change

Field Name	Type	Description
`status`	string	The transfer status. Enum: `void`

Field Name

Type

Description

status

string

The transfer status.

Enum: void

transfer_post_response_9_item

Field Name	Type	Description
`_id`	string	The transfer document identifier (ID)
`allowed`	boolean

Transfer

Security

Endpoints

GET /transfer/schema

GET /transfer/{id}

PATCH /transfer/{id}

GET /transfer

POST /transfer

PATCH /transfer/{id}/acknowledge

PATCH /transfer/bulk-change-status

PATCH /transfer/dm-sync

POST /transfer/validate-change

Data Models

transfer_get_response_1

transfer_get_response_2

transfer_get_response_2_inventory_items

transfer_get_response_2_status_history

transfer_get_response_3

transfer_get_response_3_items

transfer_get_response_3_items_inventory_items

transfer_patch_body_5

transfer_patch_response_5

transfer_patch_response_5_sub_tasks

transfer_patch_response_5_sub_tasks_value

transfer_patch_body_6

transfer_patch_response_6

transfer_patch_response_6_sub_tasks

transfer_patch_response_6_sub_tasks_value

transfer_patch_body_7

transfer_patch_body_7_inventory_items

transfer_post_body_8

transfer_post_body_8_inventory_items

transfer_post_response_8

transfer_post_response_8_inventory_items

transfer_post_body_9

transfer_post_body_9__change

transfer_post_response_9_item

Search results