Transfer

Get Transfers

GET https://open-api.zortout.com/v4/Transfer/GetTransfers

Get list of transfer.

Query Parameters

Name	Type	Description
transferdateafter	String	Transfer Date After ..... (yyyy-MM-dd)
transferdatebefore	String	Transfer Date Before ..... (yyyy-MM-dd)
limit	Int	Limit per page (Max = 500)
page	Int	Page (Default = 1)
transferType	String	Transfer Type - Transfer - Initial - Adjust - Assembly - Disassembly - Reserve
keyword	String	Keyword to search
warehousecode	String	Warehouse Code
updatedafter	String	Updated Date After ..... (yyyy-MM-dd)
updatedbefore	String	Updated Date Before ..... (yyyy-MM-dd)
createdafter	String	Created Date After ..... (yyyy-MM-dd)
createdbefore	String	Created Date Before ..... (yyyy-MM-dd)

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret
transferidlist	String	Transfer ID List Ex. 1234,5678
numberlist	String	List Of Transfer Number Ex. “TF-001,TF-002,TF-003”

Response

Parameter	Type	Description/Example
res	Response	Response Code 200- Success
list	Transfer (Array)	Transfer List (Array)
count	Int	Total transfer number by filter

Transfer (Array)	Type	Description/Example
id	Int	Transfer ID
transferType	String	Transfer Type (Transfer, Initial, Adjust, Assembly, Disassembly, Reserve)
number	String	Transfer Number
status	String	Status (Pending, Success, Partial Transfer)
transferdate	Date	Transfer Date
transferdateString	String	Transfer Date Text (yyyy-MM-dd)
reference	String	Reference
description	String	Description
fromwarehousecode	String	From Warehouse (Code)
towarehousecode	String	To Warehouse (Code)
list	TransferProduct (Array)	Product List
createdatetime	Datetime	Created Datetime
createdatetimeString	String	Created Datetime Text (yyyy-MM-dd HH:mm)
updatedatetime	Datetime	Updated Datetime
updatedatetimeString	String	Updated Datetime Text (yyyy-MM-dd HH:mm)
tag	String (Array)	Tag List (Array)
uniquenumber	String	Unique Number

TransferProduct (Array)	Type	Description/Example
productid	Int	Product ID
sku	String	Product Sku
name	String	Product Name
number	Double	Product Quantity
unittext	String	Unit

Get Transfer Detail

GET https://open-api.zortout.com/v4/Transfer/GetTransferDetail

Get transfer detail

Query Parameters

Name	Type	Description
id*	Int	Transfer ID

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Response

Parameter	Type	Description/Example
id	Int	Transfer ID
transferType	String	Transfer Type (Transfer, Initial, Adjust, Assembly, Disassembly, Reserve)
number	String	Transfer Number
status	String	Status (Pending, Success, Partial Transfer)
transferdate	Date	Transfer Date
transferdateString	String	Transfer Date Text (yyyy-MM-dd)
reference	String	Reference
description	String	Description
fromwarehousecode	String	From Warehouse (Code)
towarehousecode	String	To Warehouse (Code)
list	TransferProduct (Array)	Product List
createdatetime	Datetime	Created Datetime
createdatetimeString	String	Created Datetime Text (yyyy-MM-dd HH:mm)
updatedatetime	Datetime	Updated Datetime
updatedatetimeString	String	Updated Datetime Text (yyyy-MM-dd HH:mm)
tag	String (Array)	Tag List (Array)
uniquenumber	String	Unique Number

TransferProduct (Array)	Type	Description/Example
productid	Int	Product ID
sku	String	Product Sku
name	String	Product Name
number	Double	Product Quantity
unittext	String	Unit

Get Movement Transfer Detail

GET https://open-api.zortout.com/v4/Transfer/GetMovementTransferDetail

Get movement list of products according to each transfer.

Query Parameters

Name	Type	Description
id*	Int	Transfer ID

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Response

MovementTransfer (Array)	Type	Description/Example
id	Int	ID
list	TransferProduct (Array)	Movement List
actionDate	Date (Array)	List of action date
actionDateString	String (Array)	List of action date text (yyyy-MM-dd)
transferid	Int	Transfer ID

TransferProduct (Array)	Type	Description/Example
productid	Int	Product ID
sku	String	Product Sku
name	String	Product Name
number	Double	Product Quantity
unittext	String	Unit

Get Movement Transfers

GET https://open-api.zortout.com/v4/Transfer/GetMovementTransfers

Get movement list of products for transfers.

Query Parameters

Name	Type	Description
dateafter*	String	Date After ..... (yyyy-MM-dd)
limit	Int	Limit per page (Max = 500)
page	Int	Page (Default = 1)
warehousecode	String	Warehouse Code
datebefore*	String	Date Before ..... (yyyy-MM-dd)

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Response

Parameter	Type	Description/Example
res	Response	Response Code 200- Success
list	MovementTransfer (Array)	Movement Transfer List (Array)
count	Int	Total movement order number by filter

MovementTransfer (Array)	Type	Description/Example
id	Int	ID
list	TransferProduct (Array)	Movement List
actionDate	Date (Array)	List of action date
actionDateString	String (Array)	List of action date text (yyyy-MM-dd)
transferid	Int	Transfer ID

TransferProduct (Array)	Type	Description/Example
productid	Int	Product ID
sku	String	Product Sku
name	String	Product Name
number	Double	Product Quantity
unittext	String	Unit

Add Transfer

POST https://open-api.zortout.com/v4/Transfer/AddTransfer

Add transfer.

Query Parameters

Name	Type	Description
uniquenumber	String	Unique Number. This value is unique and used to prevent duplicate transaction.

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Request Body

Name	Type	Description
number*	String	Transfer Number
towarehousecode*	String	To Warehouse (Code)
fromwarehousecode*	String	From Warehouse (Code)
description	String	Description
transferdate	String	Transfer Date Ex. “2021-09-15”
status	String	Status (Pending,Success) Default - Pending
list	TransferProduct (Array)	Product List
∟ number	Double	Product Quantity
∟ name	String	Product Name
∟ sku	String	Product Sku
tag	String (Array)	Tag List (Array)
reference	String	Reference

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description
detail	Detail	Detail

Detail	Type	Description/Example
id	Int	Transfer ID

Ex. Request JSON

{
  "number": "TF-0001",
  "status": "Success",
  "transferdate": "2021-01- 25",
  "fromwarehousecode": "W0001",
  "towarehousecode": "W0002",
  "list": [
    {
      "sku": "P0001",
      "name": "Product1",
      "number": "5"
    },
    {
      "sku": "P0002",
      "name": "Product2",
      "number": "3"
    }
  ]
}

Update Transfer Status

POST https://open-api.zortout.com/v4/Transfer/UpdateTransferStatus

Update status of transfer.

Query Parameters

Name	Type	Description
id	Int	Transfer ID *Must have either id or number
number	String	Transfer Number Require if id = 0 or null *Must have either id or number

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Update Partial Transfer

POST https://open-api.zortout.com/v4/Transfer/UpdatePartialTransfer

Update partial product of transfer

Query Parameters

Name	Type	Description
id	Int	Transfer ID *Must have either id or number
number	String	Transfer Number Require if id = 0 or null *Must have either id or number

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Request Body

Name	Type	Description
	TransferProduct (Array)	Product List
∟ productid	Int	Product ID *Must have either productid or sku
∟ sku	String	Product Sku Require if productid = 0 or null *Must have either productid or sku
∟ number*	Double	Product Quantity

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Ex. Request JSON

[
    {
      "sku": "P0001",
      "number": 24
    },
    {
      "productid": 1234,
      "number": 25
    }
]

Edit Transfer

POST https://open-api.zortout.com/v4/Transfer/EditTransfer

Edit transfer.

Query Parameters

Name	Type	Description
id	Int	Transfer ID *Must have either id or number
number	String	Transfer Number Require if id = 0 or null *Must have either id or number

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Request Body

Name	Type	Description
number	String	Transfer Number
∟ number	String	Product Quantity
∟ name	String	Product Name
∟ sku	String	Product Sku
list	TransferProduct (Array)	Product List
description	String	Description
transferdate	String	Transfer Date Ex. “2021-09-15”

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Ex. Request JSON

{
  "number": "TF-0001",
  "transferdate": "2021-01- 25",
  "list": [
    {
      "sku": "P0001",
      "name": "Product1",
      "number": "5"
    },
    {
      "sku": "P0002",
      "name": "Product2",
      "number": "3"
    }
  ]
}

Void Transfer

POST https://open-api.zortout.com/v4/Transfer/VoidTransfer

Void transfer.

Query Parameters

Name	Type	Description
id	Int	Transfer ID *Must have either id or number
number	String	Transfer Number Require if id = 0 or null *Must have either id or number

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description