Skip to main content
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>"
    }
  ]
}
'
{
  "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

​
Authorization
string
header
required

Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'

Body

application/json

The Transfer to create

Defines a transfer to create

​
supplierId
string
required

SupplierId is the unique ID for the owner of items in the system

Minimum string length: 2
​
fromWarehouseCode
string
required

The warehouse (Code)

"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - Dallas
Minimum string length: 1
​
toWarehouseCode
string
required

The warehouse (Code)

"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - Dallas
Minimum string length: 1
​
supplierReferenceNumber
string
required

The Supplier Transfer Reference Number.

Minimum string length: 1
​
inventories
object[] | null

Inventory Items in the transfer

Response

200 - application/json

OK

Generic container for all service responses

​
isSuccess
boolean

Was the request successful. If not, the message will have more information.

​
message
string | null

Any error message

​
payload
object

A Transfer defines a request to move inventory from one warehouse to another