Creates a new Inventory-IN request ready to be Submitted in a subsequent step
curl --request POST \
--url https://api.example.com/api/v1/Transfers/INs \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"supplierId": "<string>",
"referenceNumber": "<string>",
"deliveryMethodCode": "<string>",
"expectedDate": "2023-11-07T05:31:56Z",
"warehouseCode": "<string>",
"pickupSiteId": 123,
"lineItems": [
{
"supplierSku": "<string>",
"subInventoryCode": "<string>",
"qty": 123
}
]
}
'import requests
url = "https://api.example.com/api/v1/Transfers/INs"
payload = {
"supplierId": "<string>",
"referenceNumber": "<string>",
"deliveryMethodCode": "<string>",
"expectedDate": "2023-11-07T05:31:56Z",
"warehouseCode": "<string>",
"pickupSiteId": 123,
"lineItems": [
{
"supplierSku": "<string>",
"subInventoryCode": "<string>",
"qty": 123
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
supplierId: '<string>',
referenceNumber: '<string>',
deliveryMethodCode: '<string>',
expectedDate: '2023-11-07T05:31:56Z',
warehouseCode: '<string>',
pickupSiteId: 123,
lineItems: [{supplierSku: '<string>', subInventoryCode: '<string>', qty: 123}]
})
};
fetch('https://api.example.com/api/v1/Transfers/INs', 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/INs",
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([
'supplierId' => '<string>',
'referenceNumber' => '<string>',
'deliveryMethodCode' => '<string>',
'expectedDate' => '2023-11-07T05:31:56Z',
'warehouseCode' => '<string>',
'pickupSiteId' => 123,
'lineItems' => [
[
'supplierSku' => '<string>',
'subInventoryCode' => '<string>',
'qty' => 123
]
]
]),
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/INs"
payload := strings.NewReader("{\n \"supplierId\": \"<string>\",\n \"referenceNumber\": \"<string>\",\n \"deliveryMethodCode\": \"<string>\",\n \"expectedDate\": \"2023-11-07T05:31:56Z\",\n \"warehouseCode\": \"<string>\",\n \"pickupSiteId\": 123,\n \"lineItems\": [\n {\n \"supplierSku\": \"<string>\",\n \"subInventoryCode\": \"<string>\",\n \"qty\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.example.com/api/v1/Transfers/INs")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"supplierId\": \"<string>\",\n \"referenceNumber\": \"<string>\",\n \"deliveryMethodCode\": \"<string>\",\n \"expectedDate\": \"2023-11-07T05:31:56Z\",\n \"warehouseCode\": \"<string>\",\n \"pickupSiteId\": 123,\n \"lineItems\": [\n {\n \"supplierSku\": \"<string>\",\n \"subInventoryCode\": \"<string>\",\n \"qty\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/Transfers/INs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"supplierId\": \"<string>\",\n \"referenceNumber\": \"<string>\",\n \"deliveryMethodCode\": \"<string>\",\n \"expectedDate\": \"2023-11-07T05:31:56Z\",\n \"warehouseCode\": \"<string>\",\n \"pickupSiteId\": 123,\n \"lineItems\": [\n {\n \"supplierSku\": \"<string>\",\n \"subInventoryCode\": \"<string>\",\n \"qty\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"isSuccess": true,
"message": "<string>",
"payload": [
"<string>"
]
}Creates a new Inventory-IN request ready to be Submitted in a subsequent step
POST
/
api
/
v1
/
Transfers
/
INs
Creates a new Inventory-IN request ready to be Submitted in a subsequent step
curl --request POST \
--url https://api.example.com/api/v1/Transfers/INs \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"supplierId": "<string>",
"referenceNumber": "<string>",
"deliveryMethodCode": "<string>",
"expectedDate": "2023-11-07T05:31:56Z",
"warehouseCode": "<string>",
"pickupSiteId": 123,
"lineItems": [
{
"supplierSku": "<string>",
"subInventoryCode": "<string>",
"qty": 123
}
]
}
'import requests
url = "https://api.example.com/api/v1/Transfers/INs"
payload = {
"supplierId": "<string>",
"referenceNumber": "<string>",
"deliveryMethodCode": "<string>",
"expectedDate": "2023-11-07T05:31:56Z",
"warehouseCode": "<string>",
"pickupSiteId": 123,
"lineItems": [
{
"supplierSku": "<string>",
"subInventoryCode": "<string>",
"qty": 123
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
supplierId: '<string>',
referenceNumber: '<string>',
deliveryMethodCode: '<string>',
expectedDate: '2023-11-07T05:31:56Z',
warehouseCode: '<string>',
pickupSiteId: 123,
lineItems: [{supplierSku: '<string>', subInventoryCode: '<string>', qty: 123}]
})
};
fetch('https://api.example.com/api/v1/Transfers/INs', 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/INs",
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([
'supplierId' => '<string>',
'referenceNumber' => '<string>',
'deliveryMethodCode' => '<string>',
'expectedDate' => '2023-11-07T05:31:56Z',
'warehouseCode' => '<string>',
'pickupSiteId' => 123,
'lineItems' => [
[
'supplierSku' => '<string>',
'subInventoryCode' => '<string>',
'qty' => 123
]
]
]),
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/INs"
payload := strings.NewReader("{\n \"supplierId\": \"<string>\",\n \"referenceNumber\": \"<string>\",\n \"deliveryMethodCode\": \"<string>\",\n \"expectedDate\": \"2023-11-07T05:31:56Z\",\n \"warehouseCode\": \"<string>\",\n \"pickupSiteId\": 123,\n \"lineItems\": [\n {\n \"supplierSku\": \"<string>\",\n \"subInventoryCode\": \"<string>\",\n \"qty\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.example.com/api/v1/Transfers/INs")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"supplierId\": \"<string>\",\n \"referenceNumber\": \"<string>\",\n \"deliveryMethodCode\": \"<string>\",\n \"expectedDate\": \"2023-11-07T05:31:56Z\",\n \"warehouseCode\": \"<string>\",\n \"pickupSiteId\": 123,\n \"lineItems\": [\n {\n \"supplierSku\": \"<string>\",\n \"subInventoryCode\": \"<string>\",\n \"qty\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/Transfers/INs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"supplierId\": \"<string>\",\n \"referenceNumber\": \"<string>\",\n \"deliveryMethodCode\": \"<string>\",\n \"expectedDate\": \"2023-11-07T05:31:56Z\",\n \"warehouseCode\": \"<string>\",\n \"pickupSiteId\": 123,\n \"lineItems\": [\n {\n \"supplierSku\": \"<string>\",\n \"subInventoryCode\": \"<string>\",\n \"qty\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"isSuccess": true,
"message": "<string>",
"payload": [
"<string>"
]
}Authorizations
Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'
Body
application/json
SupplierId is the unique ID for the owner of items in the system
Minimum string length:
2Create any ID you wish. This ID will be needed in the SUBMIT or DELETE phase
Minimum string length:
1The way this items is delivered (Code)
WD_PICKUP - If set, then PickupSiteId is required
CLIENT_DROPOFF - If set then PickupSiteId must be empty
Minimum string length:
1When is the item expected
The warehouse (Code)
"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - Dallas
If the DeliveryMethodCode is WD_PICKUP then PickupSiteId is required. To get this code, use the API Help page, and select the 'Seller'.
Show child attributes
Show child attributes
Was this page helpful?
Gets a list of inventory-in orders within the WineDirect fulfillment systemCancels an Inventory-IN request to be processed by WineDirect
⌘I