Create inventory transfer - Fabric
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
cURL
cURL
curl --request POST \
--url https://api.fabric.inc/v3/shipments/inventory-transfer \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-fabric-channel-id: <x-fabric-channel-id>' \
--header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
--data '
{
"shipFrom": {
"locationNumber": "WH334",
"locationName": "Store1",
"locationType": "STORE"
},
"shipTo": {
"locationNumber": "WH334",
"locationName": "Store1",
"locationType": "STORE",
"shipToAddress": {
"addressLine1": "254 House number",
"addressLine2": "888 Broadway",
"addressLine3": "17th street",
"addressLine4": "Pearl",
"city": "New York",
"country": "USA",
"latitude": 134.13413,
"longitude": 757.0435,
"postalCode": "1003",
"state": "NY",
"type": "home"
},
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"
},
"shipmentNumber": "78974156816152",
"transferNumber": "112345678912340",
"attributes": {
"attribute1": "value"
},
"cartons": [\
{\
"attributes": {\
"attribute1": "value"\
},\
"cartonNumber": "1",\
"cartonType": "Package",\
"estimatedDeliveryDate": "2022-05-26T07:58:30.996Z",\
"estimatedShipmentDate": "2022-05-25T07:58:30.996Z",\
"items": [\
{\
"adjustments": [\
{\
"adjustmentQuantity": 2,\
"attributes": {\
"attribute1": "value"\
},\
"reasonCode": "DAMAGED",\
"subReasonCode": "DAMAGED"\
}\
],\
"attributes": {\
"attribute1": "value"\
},\
"channelId": "12",\
"deliveredQuantity": 2,\
"itemId": "100023",\
"lineItemId": "1",\
"packedQuantity": 2,\
"receivedQuantity": 2,\
"segment": "<string>",\
"shipmentLineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",\
"shippedQuantity": 2,\
"sku": "SKU0023",\
"stockedQuantity": 2,\
"uom": "EA",\
"vendorId": "vend12346667"\
}\
],\
"promisedDeliveryDate": "2022-05-26T07:58:30.996Z",\
"shipmentCarrier": "FEDEX",\
"shipmentMethod": "ground",\
"tracking": [\
{\
"event": "picked up",\
"eventId": "627963716b19511e8a3a631b",\
"eventRecordedAt": "2019-09-30T07:58:30.996Z",\
"location": "Reno, NV",\
"notes": {\
"description": "Shipment picked up"\
},\
"shipmentCarrier": "FEDEX"\
}\
],\
"trackingNumber": "1Z999AA10123456784",\
"trackingURL": "https://example.com/tracking",\
"weight": "500 gram"\
}\
],
"masterTrackingNumber": "TX112345678",
"poNumber": "1125",
"recipient": [\
{\
"email": "support@example.inc",\
"name": {\
"firstName": "Alex",\
"lastName": "Doe",\
"middleName": "E"\
},\
"phone": {\
"number": "123-456-7890",\
"type": "MOBILE"\
}\
}\
],
"shippedAt": "2022-06-06T07:58:30.996Z",
"subtype": "COD",
"totalCartons": 2,
"transferId": "112345678912340",
"type": "TRANSFER",
"vendorId": "56"
}
'
import requests
url = "https://api.fabric.inc/v3/shipments/inventory-transfer"
payload = {
"shipFrom": {
"locationNumber": "WH334",
"locationName": "Store1",
"locationType": "STORE"
},
"shipTo": {
"locationNumber": "WH334",
"locationName": "Store1",
"locationType": "STORE",
"shipToAddress": {
"addressLine1": "254 House number",
"addressLine2": "888 Broadway",
"addressLine3": "17th street",
"addressLine4": "Pearl",
"city": "New York",
"country": "USA",
"latitude": 134.13413,
"longitude": 757.0435,
"postalCode": "1003",
"state": "NY",
"type": "home"
},
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"
},
"shipmentNumber": "78974156816152",
"transferNumber": "112345678912340",
"attributes": { "attribute1": "value" },
"cartons": [\
{\
"attributes": { "attribute1": "value" },\
"cartonNumber": "1",\
"cartonType": "Package",\
"estimatedDeliveryDate": "2022-05-26T07:58:30.996Z",\
"estimatedShipmentDate": "2022-05-25T07:58:30.996Z",\
"items": [\
{\
"adjustments": [\
{\
"adjustmentQuantity": 2,\
"attributes": { "attribute1": "value" },\
"reasonCode": "DAMAGED",\
"subReasonCode": "DAMAGED"\
}\
],\
"attributes": { "attribute1": "value" },\
"channelId": "12",\
"deliveredQuantity": 2,\
"itemId": "100023",\
"lineItemId": "1",\
"packedQuantity": 2,\
"receivedQuantity": 2,\
"segment": "<string>",\
"shipmentLineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",\
"shippedQuantity": 2,\
"sku": "SKU0023",\
"stockedQuantity": 2,\
"uom": "EA",\
"vendorId": "vend12346667"\
}\
],\
"promisedDeliveryDate": "2022-05-26T07:58:30.996Z",\
"shipmentCarrier": "FEDEX",\
"shipmentMethod": "ground",\
"tracking": [\
{\
"event": "picked up",\
"eventId": "627963716b19511e8a3a631b",\
"eventRecordedAt": "2019-09-30T07:58:30.996Z",\
"location": "Reno, NV",\
"notes": { "description": "Shipment picked up" },\
"shipmentCarrier": "FEDEX"\
}\
],\
"trackingNumber": "1Z999AA10123456784",\
"trackingURL": "https://example.com/tracking",\
"weight": "500 gram"\
}\
],
"masterTrackingNumber": "TX112345678",
"poNumber": "1125",
"recipient": [\
{\
"email": "support@example.inc",\
"name": {\
"firstName": "Alex",\
"lastName": "Doe",\
"middleName": "E"\
},\
"phone": {\
"number": "123-456-7890",\
"type": "MOBILE"\
}\
}\
],
"shippedAt": "2022-06-06T07:58:30.996Z",
"subtype": "COD",
"totalCartons": 2,
"transferId": "112345678912340",
"type": "TRANSFER",
"vendorId": "56"
}
headers = {
"x-fabric-tenant-id": "<x-fabric-tenant-id>",
"x-fabric-channel-id": "<x-fabric-channel-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
const options = {
method: 'POST',
headers: {
'x-fabric-tenant-id': '<x-fabric-tenant-id>',
'x-fabric-channel-id': '<x-fabric-channel-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
shipFrom: {locationNumber: 'WH334', locationName: 'Store1', locationType: 'STORE'},
shipTo: {
locationNumber: 'WH334',
locationName: 'Store1',
locationType: 'STORE',
shipToAddress: {
addressLine1: '254 House number',
addressLine2: '888 Broadway',
addressLine3: '17th street',
addressLine4: 'Pearl',
city: 'New York',
country: 'USA',
latitude: 134.13413,
longitude: 757.0435,
postalCode: '1003',
state: 'NY',
type: 'home'
},
shipToId: 'b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569'
},
shipmentNumber: '78974156816152',
transferNumber: '112345678912340',
attributes: {attribute1: 'value'},
cartons: [\
{\
attributes: {attribute1: 'value'},\
cartonNumber: '1',\
cartonType: 'Package',\
estimatedDeliveryDate: '2022-05-26T07:58:30.996Z',\
estimatedShipmentDate: '2022-05-25T07:58:30.996Z',\
items: [\
{\
adjustments: [\
{\
adjustmentQuantity: 2,\
attributes: {attribute1: 'value'},\
reasonCode: 'DAMAGED',\
subReasonCode: 'DAMAGED'\
}\
],\
attributes: {attribute1: 'value'},\
channelId: '12',\
deliveredQuantity: 2,\
itemId: '100023',\
lineItemId: '1',\
packedQuantity: 2,\
receivedQuantity: 2,\
segment: '<string>',\
shipmentLineItemId: 'b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569',\
shippedQuantity: 2,\
sku: 'SKU0023',\
stockedQuantity: 2,\
uom: 'EA',\
vendorId: 'vend12346667'\
}\
],\
promisedDeliveryDate: '2022-05-26T07:58:30.996Z',\
shipmentCarrier: 'FEDEX',\
shipmentMethod: 'ground',\
tracking: [\
{\
event: 'picked up',\
eventId: '627963716b19511e8a3a631b',\
eventRecordedAt: '2019-09-30T07:58:30.996Z',\
location: 'Reno, NV',\
notes: {description: 'Shipment picked up'},\
shipmentCarrier: 'FEDEX'\
}\
],\
trackingNumber: '1Z999AA10123456784',\
trackingURL: 'https://example.com/tracking',\
weight: '500 gram'\
}\
],
masterTrackingNumber: 'TX112345678',
poNumber: '1125',
recipient: [\
{\
email: 'support@example.inc',\
name: {firstName: 'Alex', lastName: 'Doe', middleName: 'E'},\
phone: {number: '123-456-7890', type: 'MOBILE'}\
}\
],
shippedAt: '2022-06-06T07:58:30.996Z',
subtype: 'COD',
totalCartons: 2,
transferId: '112345678912340',
type: 'TRANSFER',
vendorId: '56'
})
};
fetch('https://api.fabric.inc/v3/shipments/inventory-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.fabric.inc/v3/shipments/inventory-transfer",\
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([\
'shipFrom' => [\
'locationNumber' => 'WH334',\
'locationName' => 'Store1',\
'locationType' => 'STORE'\
],\
'shipTo' => [\
'locationNumber' => 'WH334',\
'locationName' => 'Store1',\
'locationType' => 'STORE',\
'shipToAddress' => [\
'addressLine1' => '254 House number',\
'addressLine2' => '888 Broadway',\
'addressLine3' => '17th street',\
'addressLine4' => 'Pearl',\
'city' => 'New York',\
'country' => 'USA',\
'latitude' => 134.13413,\
'longitude' => 757.0435,\
'postalCode' => '1003',\
'state' => 'NY',\
'type' => 'home'\
],\
'shipToId' => 'b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569'\
],\
'shipmentNumber' => '78974156816152',\
'transferNumber' => '112345678912340',\
'attributes' => [\
'attribute1' => 'value'\
],\
'cartons' => [\
[\
'attributes' => [\
'attribute1' => 'value'\
],\
'cartonNumber' => '1',\
'cartonType' => 'Package',\
'estimatedDeliveryDate' => '2022-05-26T07:58:30.996Z',\
'estimatedShipmentDate' => '2022-05-25T07:58:30.996Z',\
'items' => [\
[\
'adjustments' => [\
[\
'adjustmentQuantity' => 2,\
'attributes' => [\
'attribute1' => 'value'\
],\
'reasonCode' => 'DAMAGED',\
'subReasonCode' => 'DAMAGED'\
]\
],\
'attributes' => [\
'attribute1' => 'value'\
],\
'channelId' => '12',\
'deliveredQuantity' => 2,\
'itemId' => '100023',\
'lineItemId' => '1',\
'packedQuantity' => 2,\
'receivedQuantity' => 2,\
'segment' => '<string>',\
'shipmentLineItemId' => 'b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569',\
'shippedQuantity' => 2,\
'sku' => 'SKU0023',\
'stockedQuantity' => 2,\
'uom' => 'EA',\
'vendorId' => 'vend12346667'\
]\
],\
'promisedDeliveryDate' => '2022-05-26T07:58:30.996Z',\
'shipmentCarrier' => 'FEDEX',\
'shipmentMethod' => 'ground',\
'tracking' => [\
[\
'event' => 'picked up',\
'eventId' => '627963716b19511e8a3a631b',\
'eventRecordedAt' => '2019-09-30T07:58:30.996Z',\
'location' => 'Reno, NV',\
'notes' => [\
'description' => 'Shipment picked up'\
],\
'shipmentCarrier' => 'FEDEX'\
]\
],\
'trackingNumber' => '1Z999AA10123456784',\
'trackingURL' => 'https://example.com/tracking',\
'weight' => '500 gram'\
]\
],\
'masterTrackingNumber' => 'TX112345678',\
'poNumber' => '1125',\
'recipient' => [\
[\
'email' => 'support@example.inc',\
'name' => [\
'firstName' => 'Alex',\
'lastName' => 'Doe',\
'middleName' => 'E'\
],\
'phone' => [\
'number' => '123-456-7890',\
'type' => 'MOBILE'\
]\
]\
],\
'shippedAt' => '2022-06-06T07:58:30.996Z',\
'subtype' => 'COD',\
'totalCartons' => 2,\
'transferId' => '112345678912340',\
'type' => 'TRANSFER',\
'vendorId' => '56'\
]),\
CURLOPT_HTTPHEADER => [\
"Authorization: Bearer <token>",\
"Content-Type: application/json",\
"x-fabric-channel-id: <x-fabric-channel-id>",\
"x-fabric-tenant-id: <x-fabric-tenant-id>"\
],\
]);
$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.fabric.inc/v3/shipments/inventory-transfer"
payload := strings.NewReader("{\n \"shipFrom\": {\n \"locationNumber\": \"WH334\",\n \"locationName\": \"Store1\",\n \"locationType\": \"STORE\"\n },\n \"shipTo\": {\n \"locationNumber\": \"WH334\",\n \"locationName\": \"Store1\",\n \"locationType\": \"STORE\",\n \"shipToAddress\": {\n \"addressLine1\": \"254 House number\",\n \"addressLine2\": \"888 Broadway\",\n \"addressLine3\": \"17th street\",\n \"addressLine4\": \"Pearl\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"latitude\": 134.13413,\n \"longitude\": 757.0435,\n \"postalCode\": \"1003\",\n \"state\": \"NY\",\n \"type\": \"home\"\n },\n \"shipToId\": \"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569\"\n },\n \"shipmentNumber\": \"78974156816152\",\n \"transferNumber\": \"112345678912340\",\n \"attributes\": {\n \"attribute1\": \"value\"\n },\n \"cartons\": [\n {\n \"attributes\": {\n \"attribute1\": \"value\"\n },\n \"cartonNumber\": \"1\",\n \"cartonType\": \"Package\",\n \"estimatedDeliveryDate\": \"2022-05-26T07:58:30.996Z\",\n \"estimatedShipmentDate\": \"2022-05-25T07:58:30.996Z\",\n \"items\": [\n {\n \"adjustments\": [\n {\n \"adjustmentQuantity\": 2,\n \"attributes\": {\n \"attribute1\": \"value\"\n },\n \"reasonCode\": \"DAMAGED\",\n \"subReasonCode\": \"DAMAGED\"\n }\n ],\n \"attributes\": {\n \"attribute1\": \"value\"\n },\n \"channelId\": \"12\",\n \"deliveredQuantity\": 2,\n \"itemId\": \"100023\",\n \"lineItemId\": \"1\",\n \"packedQuantity\": 2,\n \"receivedQuantity\": 2,\n \"segment\": \"<string>\",\n \"shipmentLineItemId\": \"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569\",\n \"shippedQuantity\": 2,\n \"sku\": \"SKU0023\",\n \"stockedQuantity\": 2,\n \"uom\": \"EA\",\n \"vendorId\": \"vend12346667\"\n }\n ],\n \"promisedDeliveryDate\": \"2022-05-26T07:58:30.996Z\",\n \"shipmentCarrier\": \"FEDEX\",\n \"shipmentMethod\": \"ground\",\n \"tracking\": [\n {\n \"event\": \"picked up\",\n \"eventId\": \"627963716b19511e8a3a631b\",\n \"eventRecordedAt\": \"2019-09-30T07:58:30.996Z\",\n \"location\": \"Reno, NV\",\n \"notes\": {\n \"description\": \"Shipment picked up\"\n },\n \"shipmentCarrier\": \"FEDEX\"\n }\n ],\n \"trackingNumber\": \"1Z999AA10123456784\",\n \"trackingURL\": \"https://example.com/tracking\",\n \"weight\": \"500 gram\"\n }\n ],\n \"masterTrackingNumber\": \"TX112345678\",\n \"poNumber\": \"1125\",\n \"recipient\": [\n {\n \"email\": \"support@example.inc\",\n \"name\": {\n \"firstName\": \"Alex\",\n \"lastName\": \"Doe\",\n \"middleName\": \"E\"\n },\n \"phone\": {\n \"number\": \"123-456-7890\",\n \"type\": \"MOBILE\"\n }\n }\n ],\n \"shippedAt\": \"2022-06-06T07:58:30.996Z\",\n \"subtype\": \"COD\",\n \"totalCartons\": 2,\n \"transferId\": \"112345678912340\",\n \"type\": \"TRANSFER\",\n \"vendorId\": \"56\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-fabric-tenant-id", "<x-fabric-tenant-id>")
req.Header.Add("x-fabric-channel-id", "<x-fabric-channel-id>")
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.fabric.inc/v3/shipments/inventory-transfer")
.header("x-fabric-tenant-id", "<x-fabric-tenant-id>")
.header("x-fabric-channel-id", "<x-fabric-channel-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"shipFrom\": {\n \"locationNumber\": \"WH334\",\n \"locationName\": \"Store1\",\n \"locationType\": \"STORE\"\n },\n \"shipTo\": {\n \"locationNumber\": \"WH334\",\n \"locationName\": \"Store1\",\n \"locationType\": \"STORE\",\n \"shipToAddress\": {\n \"addressLine1\": \"254 House number\",\n \"addressLine2\": \"888 Broadway\",\n \"addressLine3\": \"17th street\",\n \"addressLine4\": \"Pearl\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"latitude\": 134.13413,\n \"longitude\": 757.0435,\n \"postalCode\": \"1003\",\n \"state\": \"NY\",\n \"type\": \"home\"\n },\n \"shipToId\": \"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569\"\n },\n \"shipmentNumber\": \"78974156816152\",\n \"transferNumber\": \"112345678912340\",\n \"attributes\": {\n \"attribute1\": \"value\"\n },\n \"cartons\": [\n {\n \"attributes\": {\n \"attribute1\": \"value\"\n },\n \"cartonNumber\": \"1\",\n \"cartonType\": \"Package\",\n \"estimatedDeliveryDate\": \"2022-05-26T07:58:30.996Z\",\n \"estimatedShipmentDate\": \"2022-05-25T07:58:30.996Z\",\n \"items\": [\n {\n \"adjustments\": [\n {\n \"adjustmentQuantity\": 2,\n \"attributes\": {\n \"attribute1\": \"value\"\n },\n \"reasonCode\": \"DAMAGED\",\n \"subReasonCode\": \"DAMAGED\"\n }\n ],\n \"attributes\": {\n \"attribute1\": \"value\"\n },\n \"channelId\": \"12\",\n \"deliveredQuantity\": 2,\n \"itemId\": \"100023\",\n \"lineItemId\": \"1\",\n \"packedQuantity\": 2,\n \"receivedQuantity\": 2,\n \"segment\": \"<string>\",\n \"shipmentLineItemId\": \"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569\",\n \"shippedQuantity\": 2,\n \"sku\": \"SKU0023\",\n \"stockedQuantity\": 2,\n \"uom\": \"EA\",\n \"vendorId\": \"vend12346667\"\n }\n ],\n \"promisedDeliveryDate\": \"2022-05-26T07:58:30.996Z\",\n \"shipmentCarrier\": \"FEDEX\",\n \"shipmentMethod\": \"ground\",\n \"tracking\": [\n {\n \"event\": \"picked up\",\n \"eventId\": \"627963716b19511e8a3a631b\",\n \"eventRecordedAt\": \"2019-09-30T07:58:30.996Z\",\n \"location\": \"Reno, NV\",\n \"notes\": {\n \"description\": \"Shipment picked up\"\n },\n \"shipmentCarrier\": \"FEDEX\"\n }\n ],\n \"trackingNumber\": \"1Z999AA10123456784\",\n \"trackingURL\": \"https://example.com/tracking\",\n \"weight\": \"500 gram\"\n }\n ],\n \"masterTrackingNumber\": \"TX112345678\",\n \"poNumber\": \"1125\",\n \"recipient\": [\n {\n \"email\": \"support@example.inc\",\n \"name\": {\n \"firstName\": \"Alex\",\n \"lastName\": \"Doe\",\n \"middleName\": \"E\"\n },\n \"phone\": {\n \"number\": \"123-456-7890\",\n \"type\": \"MOBILE\"\n }\n }\n ],\n \"shippedAt\": \"2022-06-06T07:58:30.996Z\",\n \"subtype\": \"COD\",\n \"totalCartons\": 2,\n \"transferId\": \"112345678912340\",\n \"type\": \"TRANSFER\",\n \"vendorId\": \"56\"\n}")
.asString();
require 'uri'
require 'net/http'
url = URI("https://api.fabric.inc/v3/shipments/inventory-transfer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-fabric-tenant-id"] = '<x-fabric-tenant-id>'
request["x-fabric-channel-id"] = '<x-fabric-channel-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"shipFrom\": {\n \"locationNumber\": \"WH334\",\n \"locationName\": \"Store1\",\n \"locationType\": \"STORE\"\n },\n \"shipTo\": {\n \"locationNumber\": \"WH334\",\n \"locationName\": \"Store1\",\n \"locationType\": \"STORE\",\n \"shipToAddress\": {\n \"addressLine1\": \"254 House number\",\n \"addressLine2\": \"888 Broadway\",\n \"addressLine3\": \"17th street\",\n \"addressLine4\": \"Pearl\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"latitude\": 134.13413,\n \"longitude\": 757.0435,\n \"postalCode\": \"1003\",\n \"state\": \"NY\",\n \"type\": \"home\"\n },\n \"shipToId\": \"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569\"\n },\n \"shipmentNumber\": \"78974156816152\",\n \"transferNumber\": \"112345678912340\",\n \"attributes\": {\n \"attribute1\": \"value\"\n },\n \"cartons\": [\n {\n \"attributes\": {\n \"attribute1\": \"value\"\n },\n \"cartonNumber\": \"1\",\n \"cartonType\": \"Package\",\n \"estimatedDeliveryDate\": \"2022-05-26T07:58:30.996Z\",\n \"estimatedShipmentDate\": \"2022-05-25T07:58:30.996Z\",\n \"items\": [\n {\n \"adjustments\": [\n {\n \"adjustmentQuantity\": 2,\n \"attributes\": {\n \"attribute1\": \"value\"\n },\n \"reasonCode\": \"DAMAGED\",\n \"subReasonCode\": \"DAMAGED\"\n }\n ],\n \"attributes\": {\n \"attribute1\": \"value\"\n },\n \"channelId\": \"12\",\n \"deliveredQuantity\": 2,\n \"itemId\": \"100023\",\n \"lineItemId\": \"1\",\n \"packedQuantity\": 2,\n \"receivedQuantity\": 2,\n \"segment\": \"<string>\",\n \"shipmentLineItemId\": \"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569\",\n \"shippedQuantity\": 2,\n \"sku\": \"SKU0023\",\n \"stockedQuantity\": 2,\n \"uom\": \"EA\",\n \"vendorId\": \"vend12346667\"\n }\n ],\n \"promisedDeliveryDate\": \"2022-05-26T07:58:30.996Z\",\n \"shipmentCarrier\": \"FEDEX\",\n \"shipmentMethod\": \"ground\",\n \"tracking\": [\n {\n \"event\": \"picked up\",\n \"eventId\": \"627963716b19511e8a3a631b\",\n \"eventRecordedAt\": \"2019-09-30T07:58:30.996Z\",\n \"location\": \"Reno, NV\",\n \"notes\": {\n \"description\": \"Shipment picked up\"\n },\n \"shipmentCarrier\": \"FEDEX\"\n }\n ],\n \"trackingNumber\": \"1Z999AA10123456784\",\n \"trackingURL\": \"https://example.com/tracking\",\n \"weight\": \"500 gram\"\n }\n ],\n \"masterTrackingNumber\": \"TX112345678\",\n \"poNumber\": \"1125\",\n \"recipient\": [\n {\n \"email\": \"support@example.inc\",\n \"name\": {\n \"firstName\": \"Alex\",\n \"lastName\": \"Doe\",\n \"middleName\": \"E\"\n },\n \"phone\": {\n \"number\": \"123-456-7890\",\n \"type\": \"MOBILE\"\n }\n }\n ],\n \"shippedAt\": \"2022-06-06T07:58:30.996Z\",\n \"subtype\": \"COD\",\n \"totalCartons\": 2,\n \"transferId\": \"112345678912340\",\n \"type\": \"TRANSFER\",\n \"vendorId\": \"56\"\n}"
response = http.request(request)
puts response.read_body
200
400
401
500
{
"shipFrom": {
"locationNumber": "WH334",
"locationName": "Store1",
"locationType": "STORE",
"shipFromAddress": {
"address1": "House No 129",
"address2": "10 Downing Street",
"address3": "Bakers Colony",
"address4": "Near ABC School",
"city": "Beaumont",
"country": "USA",
"email": "test@example.com",
"latitude": 35.294952,
"longitude": 32.294952,
"name": {
"first": "John",
"last": "Doe",
"middle": "M"
},
"phone": {
"number": "+10612345678",
"type": "MOBILE"
},
"postalCode": "77705",
"state": "TX",
"type": "residence"
}
},
"shipTo": {
"locationNumber": "WH334",
"locationName": "Store1",
"locationType": "STORE",
"shipToAddress": {
"addressLine1": "254 House number",
"addressLine2": "888 Broadway",
"addressLine3": "17th street",
"addressLine4": "Pearl",
"city": "New York",
"country": "USA",
"latitude": 134.13413,
"longitude": 757.0435,
"postalCode": "1003",
"state": "NY",
"type": "home"
},
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"
},
"shipmentNumber": "78974156816152",
"transferId": "112345678912340",
"transferNumber": "112345678912340",
"attributes": {
"attribute1": "value"
},
"auditLogs": [\
{\
"auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",\
"auditType": "CANCEL",\
"auditedAt": "2023-03-12T09:24:54.804Z",\
"employeeId": "6227",\
"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",\
"note": "Note",\
"reasonCode": "Scratched item",\
"source": "POS",\
"subReasonCode": "Scratched item",\
"updatedFields": [\
{\
"fieldName": "UOM",\
"fieldOriginalValue": "PK"\
}\
]\
}\
],
"cartons": [\
{\
"attributes": {\
"attribute1": "value"\
},\
"cartonNumber": "1",\
"cartonType": "Package",\
"estimatedDeliveryDate": "2022-05-26T07:58:30.996Z",\
"estimatedShipmentDate": "2022-05-25T07:58:30.996Z",\
"items": [\
{\
"adjustments": [\
{\
"adjustmentQuantity": 2,\
"attributes": {\
"attribute1": "value"\
},\
"reasonCode": "DAMAGED",\
"subReasonCode": "DAMAGED"\
}\
],\
"attributes": {\
"attribute1": "value"\
},\
"channelId": "12",\
"deliveredQuantity": 2,\
"itemId": "100023",\
"lineItemId": "1",\
"packedQuantity": 2,\
"receivedQuantity": 2,\
"segment": "<string>",\
"shipmentLineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",\
"shippedQuantity": 2,\
"sku": "SKU0023",\
"stockedQuantity": 2,\
"uom": "EA",\
"vendorId": "vend12346667"\
}\
],\
"promisedDeliveryDate": "2022-05-26T07:58:30.996Z",\
"shipmentCarrier": "FEDEX",\
"shipmentMethod": "ground",\
"tracking": [\
{\
"event": "picked up",\
"eventId": "627963716b19511e8a3a631b",\
"eventRecordedAt": "2019-09-30T07:58:30.996Z",\
"location": "Reno, NV",\
"notes": {\
"description": "Shipment picked up"\
},\
"shipmentCarrier": "FEDEX"\
}\
],\
"trackingNumber": "1Z999AA10123456784",\
"trackingURL": "https://example.com/tracking",\
"weight": "500 gram"\
}\
],
"createdAt": "2022-06-06T07:58:30.996Z",
"deliveredAt": "2022-06-06T07:58:30.996Z",
"masterTrackingNumber": "TX112345678",
"poNumber": "1125",
"receivedAt": "2022-06-06T07:58:30.996Z",
"recipient": [\
{\
"email": "support@example.inc",\
"name": {\
"firstName": "Alex",\
"lastName": "Doe",\
"middleName": "E"\
},\
"phone": {\
"number": "123-456-7890",\
"type": "MOBILE"\
}\
}\
],
"shipmentId": "627963716b19511e8a3a631b",
"shippedAt": "2022-06-06T07:58:30.996Z",
"statusCode": "TRANSFER_SHIPMENT_CREATED",
"stockReleaseTimeStamp": "2022-06-06T07:58:30.996Z",
"subtype": "COD",
"totalCartons": 2,
"type": "TRANSFER",
"updatedAt": "2022-06-06T07:58:30.996Z",
"vendorId": "56"
}
{
"errors": [\
{\
"message": "Invalid request",\
"type": "CLIENT_ERROR"\
}\
],
"message": "Bad request",
"type": "CLIENT_ERROR"
}
{
"message": "Unauthorized request",
"type": "CLIENT_ERROR"
}
{
"message": "Internal server error",
"type": "SERVER_ERROR"
}
POST
/
shipments
/
inventory-transfer
Try it
cURL
cURL
import requests
url = "https://api.fabric.inc/v3/shipments/inventory-transfer"
response = requests.post(url, json=payload, headers=headers)
print(response.text)
<?php
$curl = curl_init();
$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.fabric.inc/v3/shipments/inventory-transfer"
req, _ := http.NewRequest("POST", url, payload)
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.fabric.inc/v3/shipments/inventory-transfer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
response = http.request(request)
puts response.read_body
200
400
401
500
{
"errors": [\
{\
"message": "Invalid request",\
"type": "CLIENT_ERROR"\
}\
],
"message": "Bad request",
"type": "CLIENT_ERROR"
}
{
"message": "Unauthorized request",
"type": "CLIENT_ERROR"
}
{
"message": "Internal server error",
"type": "SERVER_ERROR"
}
Authorizations
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
x-fabric-tenant-id
string
required
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
x-fabric-channel-id
string
required
x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
x-fabric-request-id
string
Unique request ID
Body
application/json
An object containing information and properties of the transfer shipment request.
shipFrom
object
required
An object containing information and properties for the transfers ship from request.
Showchild attributes
shipTo
object
required
An object containing information and properties for the transfers ship to request.
Showchild attributes
shipmentNumber
string
required
Shipment's unique identification number
Example:
"78974156816152"
transferNumber
string
required
Transfer number for this shipment
Example:
"112345678912340"
attributes
object
Attributes to save any additional info
Showchild attributes
Example:
{ "attribute1": "value" }
cartons
object[]
Carton list
Showchild attributes
masterTrackingNumber
string
Master tracking number
Example:
"TX112345678"
poNumber
string
Optional purchase order number
Example:
"1125"
recipient
object[]
Recipient list
Showchild attributes
shippedAt
string
Ship date
Example:
"2022-06-06T07:58:30.996Z"
subtype
enum
Shipment subtype
Available options:
COD
Example:
"COD"
totalCartons
integer
Total number of cartons
Example:
2
transferId
string
Transfer ID for this shipment
Example:
"112345678912340"
type
enum
Shipment types
Available options:
STANDARD,
RESHIP,
RETURN,
SCRATCH,
PENDING_RETURN,
PICKUP,
TRANSFER
Example:
"TRANSFER"
vendorId
string
Vendor ID
Example:
"56"
Response
200
application/json
OK
An object containing information and properties of the transfer shipment response.
shipFrom
object
required
An object containing information and properties for the transfers ship from location.
Showchild attributes
shipTo
object
required
An object containing information and properties for the transfers ship to location.
Showchild attributes
shipmentNumber
string
required
Shipment's unique identification number
Example:
"78974156816152"
transferId
string
required
Transfer ID for this shipment
Example:
"112345678912340"
transferNumber
string
required
Transfer number for this shipment
Example:
"112345678912340"
attributes
object
Attributes to save any additional info
Showchild attributes
Example:
{ "attribute1": "value" }
auditLogs
object[]
Audit logs list
Showchild attributes
cartons
object[]
Carton list
Showchild attributes
createdAt
string
Created date
Example:
"2022-06-06T07:58:30.996Z"
deliveredAt
string
Delivered date of shipment
Example:
"2022-06-06T07:58:30.996Z"
masterTrackingNumber
string
Master tracking number
Example:
"TX112345678"
poNumber
string
Optional purchase order number
Example:
"1125"
receivedAt
string
Received date of shipment
Example:
"2022-06-06T07:58:30.996Z"
recipient
object[]
Recipient list
Showchild attributes
shipmentId
string
Shipment's autogenerated unique id
Example:
"627963716b19511e8a3a631b"
shippedAt
string
Ship date
Example:
"2022-06-06T07:58:30.996Z"
statusCode
enum
Transfer Shipment Status
Available options:
TRANSFER_SHIPMENT_PACKED,
TRANSFER_SHIPMENT_SENT,
TRANSFER_SHIPMENT_CREATED,
TRANSFER_SHIPMENT_DRAFT,
TRANSFER_SHIPMENT_DELIVERED,
TRANSFER_SHIPMENT_RECEIVED,
TRANSFER_SHIPMENT_STOCKED,
TRANSFER_SHIPMENT_CANCELLED,
TRANSFER_SHIPMENT_ERROR
Example:
"TRANSFER_SHIPMENT_CREATED"
stockReleaseTimeStamp
string
Stock release time stamp date
Example:
"2022-06-06T07:58:30.996Z"
subtype
enum
Shipment subtype
Available options:
COD
Example:
"COD"
totalCartons
integer
Total number of cartons
Example:
2
type
enum
Shipment types
Available options:
STANDARD,
RESHIP,
RETURN,
SCRATCH,
PENDING_RETURN,
PICKUP,
TRANSFER
Example:
"TRANSFER"
updatedAt
string
Updated date
Example:
"2022-06-06T07:58:30.996Z"
vendorId
string
Vendor ID
Example:
"56"
Was this page helpful?
YesNo
Update shipment tracking Get inventory transfer by transfershipmentid
Ctrl+I
Assistant
Responses are generated using AI and may contain mistakes.