View a stock transfer

curl --request GET \
  --url https://api.exowpee.com/v1/catalog/transfers/{transfer} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.exowpee.com/v1/catalog/transfers/{transfer}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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>"
      }
    }
  ]
}

GET

catalog

transfers

{transfer}

View a stock transfer

curl --request GET \
  --url https://api.exowpee.com/v1/catalog/transfers/{transfer} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.exowpee.com/v1/catalog/transfers/{transfer}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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>"
      }
    }
  ]
}

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

A transfer is visible to the company that owns it and, once it is no longer a draft, to a company that holds a location of one of its step groups.
Costs (route leg costs, segment costs and totals) are shown only to the owner company.

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.

Response

200 - application/json

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

View a stock transfer

Authorizations

Path Parameters

Response