Skip to main content
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
    }
  ]
}
'
{
  "isSuccess": true,
  "message": "<string>",
  "payload": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
supplierId
string
required

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

Minimum string length: 2
​
referenceNumber
string
required

Create any ID you wish. This ID will be needed in the SUBMIT or DELETE phase

Minimum string length: 1
​
deliveryMethodCode
string
required

The 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: 1
​
expectedDate
string<date-time>
required

When is the item expected

​
warehouseCode
string | null

The warehouse (Code)

"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - Dallas
​
pickupSiteId
integer<int32> | null

If the DeliveryMethodCode is WD_PICKUP then PickupSiteId is required. To get this code, use the API Help page, and select the 'Seller'.

​
lineItems
object[] | null

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
string[] | null

The payload object of the response