Create an inter-warehouse Transfer.
curl --request PUT \
--url https://api.example.com/api/v1/Transfers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"supplierId": "<string>",
"fromWarehouseCode": "<string>",
"toWarehouseCode": "<string>",
"supplierReferenceNumber": "<string>",
"inventories": [
{
"toSubInventoryCode": "<string>",
"fromSubInventoryCode": "<string>",
"qtyTransferOut": 123,
"sku": "<string>"
}
]
}
'import requests
url = "https://api.example.com/api/v1/Transfers"
payload = {
"supplierId": "<string>",
"fromWarehouseCode": "<string>",
"toWarehouseCode": "<string>",
"supplierReferenceNumber": "<string>",
"inventories": [
{
"toSubInventoryCode": "<string>",
"fromSubInventoryCode": "<string>",
"qtyTransferOut": 123,
"sku": "<string>"
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
supplierId: '<string>',
fromWarehouseCode: '<string>',
toWarehouseCode: '<string>',
supplierReferenceNumber: '<string>',
inventories: [
{
toSubInventoryCode: '<string>',
fromSubInventoryCode: '<string>',
qtyTransferOut: 123,
sku: '<string>'
}
]
})
};
fetch('https://api.example.com/api/v1/Transfers', 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.example.com/api/v1/Transfers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'supplierId' => '<string>',
'fromWarehouseCode' => '<string>',
'toWarehouseCode' => '<string>',
'supplierReferenceNumber' => '<string>',
'inventories' => [
[
'toSubInventoryCode' => '<string>',
'fromSubInventoryCode' => '<string>',
'qtyTransferOut' => 123,
'sku' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.example.com/api/v1/Transfers"
payload := strings.NewReader("{\n \"supplierId\": \"<string>\",\n \"fromWarehouseCode\": \"<string>\",\n \"toWarehouseCode\": \"<string>\",\n \"supplierReferenceNumber\": \"<string>\",\n \"inventories\": [\n {\n \"toSubInventoryCode\": \"<string>\",\n \"fromSubInventoryCode\": \"<string>\",\n \"qtyTransferOut\": 123,\n \"sku\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.put("https://api.example.com/api/v1/Transfers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"supplierId\": \"<string>\",\n \"fromWarehouseCode\": \"<string>\",\n \"toWarehouseCode\": \"<string>\",\n \"supplierReferenceNumber\": \"<string>\",\n \"inventories\": [\n {\n \"toSubInventoryCode\": \"<string>\",\n \"fromSubInventoryCode\": \"<string>\",\n \"qtyTransferOut\": 123,\n \"sku\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/Transfers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"supplierId\": \"<string>\",\n \"fromWarehouseCode\": \"<string>\",\n \"toWarehouseCode\": \"<string>\",\n \"supplierReferenceNumber\": \"<string>\",\n \"inventories\": [\n {\n \"toSubInventoryCode\": \"<string>\",\n \"fromSubInventoryCode\": \"<string>\",\n \"qtyTransferOut\": 123,\n \"sku\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"isSuccess": true,
"message": "<string>",
"payload": {
"headerId": "123",
"referenceNumber": "<string>",
"supplierReferenceNumber": "<string>",
"fromWarehouseCode": "GLW, WDI, PSO, SMA, SHW",
"fromWarehouseName": "Glenwillow, Green Island, Paso Robles, Santa Maria, Willamette Valley",
"toWarehouseCode": "GLW, WDI, PSO, SMA, SHW",
"toWarehouseName": "Glenwillow, Green Island, Paso Robles, Santa Maria, Willamette Valley",
"statusCode": "<string>",
"statusCodeName": "<string>",
"supplierId": "<string>",
"submittedDate": "2023-11-07T05:31:56Z",
"closedDate": "2023-11-07T05:31:56Z",
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"expectedDate": "2023-11-07T05:31:56Z",
"inventories": [
{
"lineId": "<string>",
"inventoryItemId": "<string>",
"headerId": "<string>",
"lineNumber": "<string>",
"toSubInventoryCode": "<string>",
"toSubInventoryName": "<string>",
"fromSubInventoryCode": "<string>",
"fromSubInventoryName": "<string>",
"qtyTransferIn": 123,
"qtyTransferOut": 123,
"qtyReceived": 123,
"qtyShipped": 123,
"sku": "<string>",
"wineDirectSku": "<string>",
"description": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z"
}
]
}
}Create an inter-warehouse Transfer.
PUT
/
api
/
v1
/
Transfers
Create an inter-warehouse Transfer.
curl --request PUT \
--url https://api.example.com/api/v1/Transfers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"supplierId": "<string>",
"fromWarehouseCode": "<string>",
"toWarehouseCode": "<string>",
"supplierReferenceNumber": "<string>",
"inventories": [
{
"toSubInventoryCode": "<string>",
"fromSubInventoryCode": "<string>",
"qtyTransferOut": 123,
"sku": "<string>"
}
]
}
'import requests
url = "https://api.example.com/api/v1/Transfers"
payload = {
"supplierId": "<string>",
"fromWarehouseCode": "<string>",
"toWarehouseCode": "<string>",
"supplierReferenceNumber": "<string>",
"inventories": [
{
"toSubInventoryCode": "<string>",
"fromSubInventoryCode": "<string>",
"qtyTransferOut": 123,
"sku": "<string>"
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
supplierId: '<string>',
fromWarehouseCode: '<string>',
toWarehouseCode: '<string>',
supplierReferenceNumber: '<string>',
inventories: [
{
toSubInventoryCode: '<string>',
fromSubInventoryCode: '<string>',
qtyTransferOut: 123,
sku: '<string>'
}
]
})
};
fetch('https://api.example.com/api/v1/Transfers', 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.example.com/api/v1/Transfers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'supplierId' => '<string>',
'fromWarehouseCode' => '<string>',
'toWarehouseCode' => '<string>',
'supplierReferenceNumber' => '<string>',
'inventories' => [
[
'toSubInventoryCode' => '<string>',
'fromSubInventoryCode' => '<string>',
'qtyTransferOut' => 123,
'sku' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.example.com/api/v1/Transfers"
payload := strings.NewReader("{\n \"supplierId\": \"<string>\",\n \"fromWarehouseCode\": \"<string>\",\n \"toWarehouseCode\": \"<string>\",\n \"supplierReferenceNumber\": \"<string>\",\n \"inventories\": [\n {\n \"toSubInventoryCode\": \"<string>\",\n \"fromSubInventoryCode\": \"<string>\",\n \"qtyTransferOut\": 123,\n \"sku\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.put("https://api.example.com/api/v1/Transfers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"supplierId\": \"<string>\",\n \"fromWarehouseCode\": \"<string>\",\n \"toWarehouseCode\": \"<string>\",\n \"supplierReferenceNumber\": \"<string>\",\n \"inventories\": [\n {\n \"toSubInventoryCode\": \"<string>\",\n \"fromSubInventoryCode\": \"<string>\",\n \"qtyTransferOut\": 123,\n \"sku\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/Transfers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"supplierId\": \"<string>\",\n \"fromWarehouseCode\": \"<string>\",\n \"toWarehouseCode\": \"<string>\",\n \"supplierReferenceNumber\": \"<string>\",\n \"inventories\": [\n {\n \"toSubInventoryCode\": \"<string>\",\n \"fromSubInventoryCode\": \"<string>\",\n \"qtyTransferOut\": 123,\n \"sku\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"isSuccess": true,
"message": "<string>",
"payload": {
"headerId": "123",
"referenceNumber": "<string>",
"supplierReferenceNumber": "<string>",
"fromWarehouseCode": "GLW, WDI, PSO, SMA, SHW",
"fromWarehouseName": "Glenwillow, Green Island, Paso Robles, Santa Maria, Willamette Valley",
"toWarehouseCode": "GLW, WDI, PSO, SMA, SHW",
"toWarehouseName": "Glenwillow, Green Island, Paso Robles, Santa Maria, Willamette Valley",
"statusCode": "<string>",
"statusCodeName": "<string>",
"supplierId": "<string>",
"submittedDate": "2023-11-07T05:31:56Z",
"closedDate": "2023-11-07T05:31:56Z",
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"expectedDate": "2023-11-07T05:31:56Z",
"inventories": [
{
"lineId": "<string>",
"inventoryItemId": "<string>",
"headerId": "<string>",
"lineNumber": "<string>",
"toSubInventoryCode": "<string>",
"toSubInventoryName": "<string>",
"fromSubInventoryCode": "<string>",
"fromSubInventoryName": "<string>",
"qtyTransferIn": 123,
"qtyTransferOut": 123,
"qtyReceived": 123,
"qtyShipped": 123,
"sku": "<string>",
"wineDirectSku": "<string>",
"description": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z"
}
]
}
}Authorizations
Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'
Body
application/json
The Transfer to create
Defines a transfer to create
SupplierId is the unique ID for the owner of items in the system
Minimum string length:
2The warehouse (Code)
"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - Dallas
Minimum string length:
1The warehouse (Code)
"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - Dallas
Minimum string length:
1The Supplier Transfer Reference Number.
Minimum string length:
1Inventory Items in the transfer
Show child attributes
Show child attributes
Response
200 - application/json
OK
Was this page helpful?
Query the Inter-Center Transfer system for transfersGets a list of inventory-in orders within the WineDirect fulfillment system
⌘I