Start a transfer

curl --request POST \
  --url https://api.exowpee.com/v1/catalog/transfers/{transfer}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "started_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.exowpee.com/v1/catalog/transfers/{transfer}/start"

payload = { "started_at": "2023-11-07T05:31:56Z" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({started_at: '2023-11-07T05:31:56Z'})
};

fetch('https://api.exowpee.com/v1/catalog/transfers/{transfer}/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.exowpee.com/v1/catalog/transfers/{transfer}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'started_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.exowpee.com/v1/catalog/transfers/{transfer}/start"

	payload := strings.NewReader("{\n  \"started_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.exowpee.com/v1/catalog/transfers/{transfer}/start")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"started_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.exowpee.com/v1/catalog/transfers/{transfer}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"started_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "trip_id": "<string>",
  "company_id": "<string>",
  "organization_id": "<string>",
  "motif": "<string>",
  "type": "<string>",
  "status": "<string>",
  "cost_distribution_method": "<string>",
  "creator_user_id": "<string>",
  "pilot_user_id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "in_transit": "<array>",
  "steps": [
    {
      "id": "<string>",
      "transfer_id": "<string>",
      "position": 123,
      "location_group_id": "<string>",
      "status": "<string>",
      "operations_executed_at": "2023-11-07T05:31:56Z",
      "approved_by_company_id": "<string>",
      "approved_by_user_id": "<string>",
      "approved_at": "2023-11-07T05:31:56Z",
      "completed_by_company_id": "<string>",
      "completed_by_user_id": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "location_group": {
        "id": "<string>",
        "name": "<string>"
      },
      "receipts": [
        {
          "id": "<string>",
          "transfer_step_id": "<string>",
          "transfer_line_id": "<string>",
          "asset_id": "<string>",
          "quantity": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "asset_name": "<string>"
        }
      ],
      "dispatches": [
        {
          "id": "<string>",
          "transfer_step_id": "<string>",
          "transfer_segment_id": "<string>",
          "transfer_line_id": "<string>",
          "position": 123,
          "asset_id": "<string>",
          "group_id": "<string>",
          "vendor_name": "<string>",
          "quantity": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "asset_name": "<string>"
        }
      ]
    }
  ],
  "route_legs": [
    {
      "id": "<string>",
      "transfer_id": "<string>",
      "from_step_id": "<string>",
      "to_step_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "cost_total_minor": 123,
      "costs": [
        {
          "id": "<string>",
          "transfer_route_leg_id": "<string>",
          "company_id": "<string>",
          "creator_user_id": "<string>",
          "label": "<string>",
          "amount": 123,
          "amount_minor": 123,
          "allocated_at": "2023-11-07T05:31:56Z",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "from_step": {
        "id": "<string>",
        "transfer_id": "<string>",
        "position": 123,
        "location_group_id": "<string>",
        "status": "<string>",
        "operations_executed_at": "2023-11-07T05:31:56Z",
        "approved_by_company_id": "<string>",
        "approved_by_user_id": "<string>",
        "approved_at": "2023-11-07T05:31:56Z",
        "completed_by_company_id": "<string>",
        "completed_by_user_id": "<string>",
        "completed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "location_group": {
          "id": "<string>",
          "name": "<string>"
        },
        "receipts": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_line_id": "<string>",
            "asset_id": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ],
        "dispatches": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_segment_id": "<string>",
            "transfer_line_id": "<string>",
            "position": 123,
            "asset_id": "<string>",
            "group_id": "<string>",
            "vendor_name": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ]
      },
      "to_step": {
        "id": "<string>",
        "transfer_id": "<string>",
        "position": 123,
        "location_group_id": "<string>",
        "status": "<string>",
        "operations_executed_at": "2023-11-07T05:31:56Z",
        "approved_by_company_id": "<string>",
        "approved_by_user_id": "<string>",
        "approved_at": "2023-11-07T05:31:56Z",
        "completed_by_company_id": "<string>",
        "completed_by_user_id": "<string>",
        "completed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "location_group": {
          "id": "<string>",
          "name": "<string>"
        },
        "receipts": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_line_id": "<string>",
            "asset_id": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ],
        "dispatches": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_segment_id": "<string>",
            "transfer_line_id": "<string>",
            "position": 123,
            "asset_id": "<string>",
            "group_id": "<string>",
            "vendor_name": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ]
      }
    }
  ],
  "segments": [
    {
      "id": "<string>",
      "transfer_id": "<string>",
      "from_step_id": "<string>",
      "to_step_id": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "route_leg_ids": "<array>",
      "cost_total_minor": 123,
      "from_step": {
        "id": "<string>",
        "transfer_id": "<string>",
        "position": 123,
        "location_group_id": "<string>",
        "status": "<string>",
        "operations_executed_at": "2023-11-07T05:31:56Z",
        "approved_by_company_id": "<string>",
        "approved_by_user_id": "<string>",
        "approved_at": "2023-11-07T05:31:56Z",
        "completed_by_company_id": "<string>",
        "completed_by_user_id": "<string>",
        "completed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "location_group": {
          "id": "<string>",
          "name": "<string>"
        },
        "receipts": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_line_id": "<string>",
            "asset_id": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ],
        "dispatches": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_segment_id": "<string>",
            "transfer_line_id": "<string>",
            "position": 123,
            "asset_id": "<string>",
            "group_id": "<string>",
            "vendor_name": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ]
      },
      "to_step": {
        "id": "<string>",
        "transfer_id": "<string>",
        "position": 123,
        "location_group_id": "<string>",
        "status": "<string>",
        "operations_executed_at": "2023-11-07T05:31:56Z",
        "approved_by_company_id": "<string>",
        "approved_by_user_id": "<string>",
        "approved_at": "2023-11-07T05:31:56Z",
        "completed_by_company_id": "<string>",
        "completed_by_user_id": "<string>",
        "completed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "location_group": {
          "id": "<string>",
          "name": "<string>"
        },
        "receipts": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_line_id": "<string>",
            "asset_id": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ],
        "dispatches": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_segment_id": "<string>",
            "transfer_line_id": "<string>",
            "position": 123,
            "asset_id": "<string>",
            "group_id": "<string>",
            "vendor_name": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ]
      },
      "costs": [
        {
          "id": "<string>",
          "transfer_segment_id": "<string>",
          "transfer_route_leg_cost_id": "<string>",
          "company_id": "<string>",
          "creator_user_id": "<string>",
          "label": "<string>",
          "amount": 123,
          "amount_minor": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "lines": [
        {
          "id": "<string>",
          "transfer_id": "<string>",
          "transfer_segment_id": "<string>",
          "stockable_id": "<string>",
          "stockable_unit_id": "<string>",
          "base_quantity": 123,
          "remaining_quantity": 123,
          "in_transit_quantity": 123,
          "created_by_company_id": "<string>",
          "creator_user_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "resolutions": [
            {
              "id": "<string>",
              "transfer_id": "<string>",
              "transfer_line_id": "<string>",
              "transfer_step_id": "<string>",
              "type": "<string>",
              "quantity": 123,
              "reason": "<string>",
              "company_id": "<string>",
              "creator_user_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ],
          "dispatches": [
            {
              "id": "<string>",
              "transfer_step_id": "<string>",
              "transfer_segment_id": "<string>",
              "transfer_line_id": "<string>",
              "position": 123,
              "asset_id": "<string>",
              "group_id": "<string>",
              "vendor_name": "<string>",
              "quantity": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "asset_name": "<string>"
            }
          ],
          "stockable": {
            "id": "<string>",
            "title": "<string>"
          },
          "stockable_unit": {
            "id": "<string>",
            "name": "<string>"
          }
        }
      ]
    }
  ],
  "vehicles": [
    {
      "id": "<string>",
      "transfer_id": "<string>",
      "asset_id": "<string>",
      "driver_label": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "asset": {
        "id": "<string>",
        "name": "<string>",
        "type": "<string>"
      }
    }
  ]
}

{
  "message": "<string>",
  "errors": {}
}

POST

catalog

transfers

{transfer}

start

Start a transfer

curl --request POST \
  --url https://api.exowpee.com/v1/catalog/transfers/{transfer}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "started_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.exowpee.com/v1/catalog/transfers/{transfer}/start"

payload = { "started_at": "2023-11-07T05:31:56Z" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({started_at: '2023-11-07T05:31:56Z'})
};

fetch('https://api.exowpee.com/v1/catalog/transfers/{transfer}/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.exowpee.com/v1/catalog/transfers/{transfer}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'started_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.exowpee.com/v1/catalog/transfers/{transfer}/start"

	payload := strings.NewReader("{\n  \"started_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.exowpee.com/v1/catalog/transfers/{transfer}/start")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"started_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.exowpee.com/v1/catalog/transfers/{transfer}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"started_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "trip_id": "<string>",
  "company_id": "<string>",
  "organization_id": "<string>",
  "motif": "<string>",
  "type": "<string>",
  "status": "<string>",
  "cost_distribution_method": "<string>",
  "creator_user_id": "<string>",
  "pilot_user_id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "in_transit": "<array>",
  "steps": [
    {
      "id": "<string>",
      "transfer_id": "<string>",
      "position": 123,
      "location_group_id": "<string>",
      "status": "<string>",
      "operations_executed_at": "2023-11-07T05:31:56Z",
      "approved_by_company_id": "<string>",
      "approved_by_user_id": "<string>",
      "approved_at": "2023-11-07T05:31:56Z",
      "completed_by_company_id": "<string>",
      "completed_by_user_id": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "location_group": {
        "id": "<string>",
        "name": "<string>"
      },
      "receipts": [
        {
          "id": "<string>",
          "transfer_step_id": "<string>",
          "transfer_line_id": "<string>",
          "asset_id": "<string>",
          "quantity": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "asset_name": "<string>"
        }
      ],
      "dispatches": [
        {
          "id": "<string>",
          "transfer_step_id": "<string>",
          "transfer_segment_id": "<string>",
          "transfer_line_id": "<string>",
          "position": 123,
          "asset_id": "<string>",
          "group_id": "<string>",
          "vendor_name": "<string>",
          "quantity": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "asset_name": "<string>"
        }
      ]
    }
  ],
  "route_legs": [
    {
      "id": "<string>",
      "transfer_id": "<string>",
      "from_step_id": "<string>",
      "to_step_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "cost_total_minor": 123,
      "costs": [
        {
          "id": "<string>",
          "transfer_route_leg_id": "<string>",
          "company_id": "<string>",
          "creator_user_id": "<string>",
          "label": "<string>",
          "amount": 123,
          "amount_minor": 123,
          "allocated_at": "2023-11-07T05:31:56Z",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "from_step": {
        "id": "<string>",
        "transfer_id": "<string>",
        "position": 123,
        "location_group_id": "<string>",
        "status": "<string>",
        "operations_executed_at": "2023-11-07T05:31:56Z",
        "approved_by_company_id": "<string>",
        "approved_by_user_id": "<string>",
        "approved_at": "2023-11-07T05:31:56Z",
        "completed_by_company_id": "<string>",
        "completed_by_user_id": "<string>",
        "completed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "location_group": {
          "id": "<string>",
          "name": "<string>"
        },
        "receipts": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_line_id": "<string>",
            "asset_id": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ],
        "dispatches": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_segment_id": "<string>",
            "transfer_line_id": "<string>",
            "position": 123,
            "asset_id": "<string>",
            "group_id": "<string>",
            "vendor_name": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ]
      },
      "to_step": {
        "id": "<string>",
        "transfer_id": "<string>",
        "position": 123,
        "location_group_id": "<string>",
        "status": "<string>",
        "operations_executed_at": "2023-11-07T05:31:56Z",
        "approved_by_company_id": "<string>",
        "approved_by_user_id": "<string>",
        "approved_at": "2023-11-07T05:31:56Z",
        "completed_by_company_id": "<string>",
        "completed_by_user_id": "<string>",
        "completed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "location_group": {
          "id": "<string>",
          "name": "<string>"
        },
        "receipts": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_line_id": "<string>",
            "asset_id": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ],
        "dispatches": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_segment_id": "<string>",
            "transfer_line_id": "<string>",
            "position": 123,
            "asset_id": "<string>",
            "group_id": "<string>",
            "vendor_name": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ]
      }
    }
  ],
  "segments": [
    {
      "id": "<string>",
      "transfer_id": "<string>",
      "from_step_id": "<string>",
      "to_step_id": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "route_leg_ids": "<array>",
      "cost_total_minor": 123,
      "from_step": {
        "id": "<string>",
        "transfer_id": "<string>",
        "position": 123,
        "location_group_id": "<string>",
        "status": "<string>",
        "operations_executed_at": "2023-11-07T05:31:56Z",
        "approved_by_company_id": "<string>",
        "approved_by_user_id": "<string>",
        "approved_at": "2023-11-07T05:31:56Z",
        "completed_by_company_id": "<string>",
        "completed_by_user_id": "<string>",
        "completed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "location_group": {
          "id": "<string>",
          "name": "<string>"
        },
        "receipts": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_line_id": "<string>",
            "asset_id": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ],
        "dispatches": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_segment_id": "<string>",
            "transfer_line_id": "<string>",
            "position": 123,
            "asset_id": "<string>",
            "group_id": "<string>",
            "vendor_name": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ]
      },
      "to_step": {
        "id": "<string>",
        "transfer_id": "<string>",
        "position": 123,
        "location_group_id": "<string>",
        "status": "<string>",
        "operations_executed_at": "2023-11-07T05:31:56Z",
        "approved_by_company_id": "<string>",
        "approved_by_user_id": "<string>",
        "approved_at": "2023-11-07T05:31:56Z",
        "completed_by_company_id": "<string>",
        "completed_by_user_id": "<string>",
        "completed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "location_group": {
          "id": "<string>",
          "name": "<string>"
        },
        "receipts": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_line_id": "<string>",
            "asset_id": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ],
        "dispatches": [
          {
            "id": "<string>",
            "transfer_step_id": "<string>",
            "transfer_segment_id": "<string>",
            "transfer_line_id": "<string>",
            "position": 123,
            "asset_id": "<string>",
            "group_id": "<string>",
            "vendor_name": "<string>",
            "quantity": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "asset_name": "<string>"
          }
        ]
      },
      "costs": [
        {
          "id": "<string>",
          "transfer_segment_id": "<string>",
          "transfer_route_leg_cost_id": "<string>",
          "company_id": "<string>",
          "creator_user_id": "<string>",
          "label": "<string>",
          "amount": 123,
          "amount_minor": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "lines": [
        {
          "id": "<string>",
          "transfer_id": "<string>",
          "transfer_segment_id": "<string>",
          "stockable_id": "<string>",
          "stockable_unit_id": "<string>",
          "base_quantity": 123,
          "remaining_quantity": 123,
          "in_transit_quantity": 123,
          "created_by_company_id": "<string>",
          "creator_user_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "resolutions": [
            {
              "id": "<string>",
              "transfer_id": "<string>",
              "transfer_line_id": "<string>",
              "transfer_step_id": "<string>",
              "type": "<string>",
              "quantity": 123,
              "reason": "<string>",
              "company_id": "<string>",
              "creator_user_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ],
          "dispatches": [
            {
              "id": "<string>",
              "transfer_step_id": "<string>",
              "transfer_segment_id": "<string>",
              "transfer_line_id": "<string>",
              "position": 123,
              "asset_id": "<string>",
              "group_id": "<string>",
              "vendor_name": "<string>",
              "quantity": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "asset_name": "<string>"
            }
          ],
          "stockable": {
            "id": "<string>",
            "title": "<string>"
          },
          "stockable_unit": {
            "id": "<string>",
            "name": "<string>"
          }
        }
      ]
    }
  ],
  "vehicles": [
    {
      "id": "<string>",
      "transfer_id": "<string>",
      "asset_id": "<string>",
      "driver_label": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "asset": {
        "id": "<string>",
        "name": "<string>",
        "type": "<string>"
      }
    }
  ]
}

{
  "message": "<string>",
  "errors": {}
}

Company space For: Stock keeper, Manager · Permission: transfers.execute Conditions

Only the company that owns the transfer can do this.
Only a draft transfer can be started.
The transfer needs at least two steps and exactly one route leg between each pair of consecutive steps.
Every line must refer to a stock item tracked in inventory.
The first step must be accessible to the current company: it must hold a location of the step’s group.
started_at, when sent, must be a valid date.

What else happens

The transfer becomes running, started_at is set (now by default) and the current member is recorded as pilot.
The first step becomes current, with approver company, member and time recorded.
Pending route leg costs are allocated to the goods of eligible segments.
Stock is withdrawn (stock out, strict tracking, operation type transfer) from the dispatch locations of the first step for the lines leaving it; withdrawals are recorded on the lines and the segment gets its start time. Stock in is done for segments arriving at that step, if any.
The step is marked as operations executed, so they are not repeated.

Part of Plan and run stock transfers.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

transfer

string

required

Identifier of the transfer.

Body

application/json

started_at

string<date-time> | null

Start date and time, ISO 8601. Optional; defaults to the time of the call.

Response

TransferResource

string

required

Identifier of the transfer.

trip_id

string | null

required

Identifier of the trip template it was created from; null otherwise.

company_id

string

required

Identifier of the company the record belongs to.

organization_id

string

required

Identifier of the organization the record belongs to.

motif

string

required

Reason of the transfer, free text.

type

string

required

Legacy classification, simple or complex. New transfers are complex.

status

string

required

draft (being planned), running, finished or cancelled. Finished and cancelled are final.

cost_distribution_method

string

required

How route costs are spread over the goods: average or prorata. Fixed at creation.

creator_user_id

string | null

required

Member who created the transfer.

pilot_user_id

string | null

required

Member who started the transfer; null until it starts.

started_at

string<date-time> | null

required

When the transfer was started, ISO 8601; null for a draft.

finished_at

string<date-time> | null

required

When it was finished or cancelled, ISO 8601; null until then.

created_at

string<date-time>

required

Date and time the record was created (ISO 8601, UTC).

updated_at

string<date-time>

required

Date and time the record was last changed (ISO 8601, UTC).

in_transit

array

Goods currently in transit: one entry per stock item with stockable_id and the quantity in the reference unit of the item.

steps

TransferStepResource · object[]

Steps of the route, in the loaded detail view.

Show child attributes

route_legs

TransferRouteLegResource · object[]

Route legs between consecutive steps, with costs for the owner company.

Show child attributes

segments

TransferSegmentResource · object[]

Segments carrying lines of goods between two steps.

Show child attributes

vehicles

TransferVehicleResource · object[]

Vehicles assigned to the transfer.

Show child attributes

Platform access and team

Set up your organization and companies

Products, prices and taxes

Stock and logistics

Buy from suppliers

Sell at the counter and on order

Customers, credit and promotions

Keep the books day to day

Follow payments to the bank

Close periods and the fiscal year

Reports, statements and tax filings

Analyze costs and results by activity

Start a transfer

Authorizations

Path Parameters

Body

Response