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”

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

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

Parameter

Type

Description/Example

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

MovementTransfer (Array)

Type

Description/Example

Int

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

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

Int

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

Parameter

Type

Description/Example

resCode

String

Response Code 200- Success

resDesc

String

Response Description

detail

Detail

Type

Description/Example

Int

Transfer ID

{
  "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

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

actionDate

String

Date of product transfer. (yyyy-MM-dd)

Headers

Name

Type

Description

storename*

String

Store Name

apikey*

String

API Key

apisecret*

String

API Secret

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

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

actiondate

String

Date of product transfer. (yyyy-MM-dd)

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

Parameter

Type

Description/Example

resCode

String

Response Code 200- Success

resDesc

String

Response Description

Edit Transfer

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

Edit transfer.

Query Parameters

Name

Type

Description

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”

Parameter

Type

Description/Example

resCode

String

Response Code 200- Success

resDesc

String

Response Description

{
  "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

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

Parameter

Type

Description/Example

resCode

String

Response Code 200- Success

resDesc

String

Response Description

PreviousReturn Purchase Order NextQuotation

Last updated 4 months ago

hashtagGet Transfers

hashtagQuery Parameters

hashtagHeaders

hashtagGet Transfer Detail

hashtagQuery Parameters

hashtagHeaders

hashtagGet Movement Transfer Detail

hashtagQuery Parameters

hashtagHeaders

hashtagGet Movement Transfers

hashtagQuery Parameters

hashtagHeaders

hashtagAdd Transfer

hashtagQuery Parameters

hashtagHeaders

hashtagRequest Body

hashtagUpdate Transfer Status

hashtagQuery Parameters

hashtagHeaders

hashtagUpdate Partial Transfer

hashtagQuery Parameters

hashtagHeaders

hashtagRequest Body

hashtagEdit Transfer

hashtagQuery Parameters

hashtagHeaders

hashtagRequest Body

hashtagVoid Transfer

hashtagQuery Parameters

hashtagHeaders

Get Transfers

Query Parameters

Headers

Get Transfer Detail

Query Parameters

Headers

Get Movement Transfer Detail

Query Parameters

Headers

Get Movement Transfers

Query Parameters

Headers

Add Transfer

Query Parameters

Headers

Request Body

Update Transfer Status

Query Parameters

Headers

Update Partial Transfer

Query Parameters

Headers

Request Body

Edit Transfer

Query Parameters

Headers

Request Body

Void Transfer

Query Parameters

Headers