Skip to main content
PUT
Create or replace a transfer route

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Body

application/json
source_warehouse_id
integer
required

Active warehouse (location) the transfer ships from

Example:

22

destination_warehouse_id
integer
required

Active warehouse (location) the transfer ships to; must differ from the source

Example:

2

source_mode
enum<string>
required
Available options:
worked,
automated
Example:

"automated"

destination_mode
enum<string>
required
Available options:
worked,
automated
Example:

"worked"

channel_id
integer | null

Existing channel used to fulfill the source side. Omit or send null to clear it.

Example:

null

Response

Existing route replaced

data
object