Transfer Order - Create

Create a new transfer order to move inventory between warehouses.

POST /transfer_order/create

Transfer Order - Create

cURL

curl --request POST \
  --url https://api.skulabs.com/transfer_order/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "item_id": "507f1f77bcf86cd799439011",
      "quantity": 123,
      "source_location_id": "507f1f77bcf86cd799439011",
      "destination_location_id": "507f1f77bcf86cd799439011"
    }
  ],
  "source_warehouse_id": "507f1f77bcf86cd799439011",
  "destination_warehouse_id": "507f1f77bcf86cd799439011",
  "number": 123,
  "notes": "<string>"
}
'

import requests

url = "https://api.skulabs.com/transfer_order/create"

payload = {
    "items": [
        {
            "item_id": "507f1f77bcf86cd799439011",
            "quantity": 123,
            "source_location_id": "507f1f77bcf86cd799439011",
            "destination_location_id": "507f1f77bcf86cd799439011"
        }
    ],
    "source_warehouse_id": "507f1f77bcf86cd799439011",
    "destination_warehouse_id": "507f1f77bcf86cd799439011",
    "number": 123,
    "notes": "<string>"
}
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({
    items: [
      {
        item_id: '507f1f77bcf86cd799439011',
        quantity: 123,
        source_location_id: '507f1f77bcf86cd799439011',
        destination_location_id: '507f1f77bcf86cd799439011'
      }
    ],
    source_warehouse_id: '507f1f77bcf86cd799439011',
    destination_warehouse_id: '507f1f77bcf86cd799439011',
    number: 123,
    notes: '<string>'
  })
};

fetch('https://api.skulabs.com/transfer_order/create', 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.skulabs.com/transfer_order/create",
  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([
    'items' => [
        [
                'item_id' => '507f1f77bcf86cd799439011',
                'quantity' => 123,
                'source_location_id' => '507f1f77bcf86cd799439011',
                'destination_location_id' => '507f1f77bcf86cd799439011'
        ]
    ],
    'source_warehouse_id' => '507f1f77bcf86cd799439011',
    'destination_warehouse_id' => '507f1f77bcf86cd799439011',
    'number' => 123,
    'notes' => '<string>'
  ]),
  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.skulabs.com/transfer_order/create"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"item_id\": \"507f1f77bcf86cd799439011\",\n      \"quantity\": 123,\n      \"source_location_id\": \"507f1f77bcf86cd799439011\",\n      \"destination_location_id\": \"507f1f77bcf86cd799439011\"\n    }\n  ],\n  \"source_warehouse_id\": \"507f1f77bcf86cd799439011\",\n  \"destination_warehouse_id\": \"507f1f77bcf86cd799439011\",\n  \"number\": 123,\n  \"notes\": \"<string>\"\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.skulabs.com/transfer_order/create")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"item_id\": \"507f1f77bcf86cd799439011\",\n      \"quantity\": 123,\n      \"source_location_id\": \"507f1f77bcf86cd799439011\",\n      \"destination_location_id\": \"507f1f77bcf86cd799439011\"\n    }\n  ],\n  \"source_warehouse_id\": \"507f1f77bcf86cd799439011\",\n  \"destination_warehouse_id\": \"507f1f77bcf86cd799439011\",\n  \"number\": 123,\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.skulabs.com/transfer_order/create")

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  \"items\": [\n    {\n      \"item_id\": \"507f1f77bcf86cd799439011\",\n      \"quantity\": 123,\n      \"source_location_id\": \"507f1f77bcf86cd799439011\",\n      \"destination_location_id\": \"507f1f77bcf86cd799439011\"\n    }\n  ],\n  \"source_warehouse_id\": \"507f1f77bcf86cd799439011\",\n  \"destination_warehouse_id\": \"507f1f77bcf86cd799439011\",\n  \"number\": 123,\n  \"notes\": \"<string>\"\n}"

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

200

{
  "success": true,
  "_id": "507f1f77bcf86cd799439011"
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

items · object[] · required

Items to include in the transfer order

Show child attributes

source_warehouse_id · string · required

Source warehouse ID

Example:

"507f1f77bcf86cd799439011"

destination_warehouse_id · string · required

Destination warehouse ID

Example:

"507f1f77bcf86cd799439011"

number · number | null

Transfer order number (auto-generated if null)

notes · string | null

Transfer order notes

Response

200

application/json

Transfer order created

success · boolean · required

Whether the operation succeeded

_id · string · required

ID of the created resource

Example:

"507f1f77bcf86cd799439011"