Skip to main content
POST
/
api
/
warehouse-transfers
/
{id}
Edit the given warehouse transfer transaction.
curl --request POST \
  --url https://api.example.com/api/warehouse-transfers/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "fromWarehouseId": 1,
  "toWarehouseId": 2,
  "date": "2021-01-01",
  "transactionNumber": "123456",
  "transferInitiated": false,
  "transferDelivered": false,
  "entries": [
    {
      "index": 1,
      "itemId": 1,
      "description": "This is a description",
      "quantity": 100,
      "cost": 100
    }
  ]
}
'

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Path Parameters

​
id
number
required

Body

application/json
​
fromWarehouseId
number
required

The id of the warehouse to transfer from

Example:

1

​
toWarehouseId
number
required

The id of the warehouse to transfer to

Example:

2

​
date
string<date-time>
required

The date of the warehouse transfer

Example:

"2021-01-01"

​
transactionNumber
string
required

The transaction number of the warehouse transfer

Example:

"123456"

​
transferInitiated
boolean
required

Whether the warehouse transfer has been initiated

Example:

false

​
transferDelivered
boolean
required

Whether the warehouse transfer has been delivered

Example:

false

​
entries
string[]
required

The entries of the warehouse transfer

Example:
[
  {
    "index": 1,
    "itemId": 1,
    "description": "This is a description",
    "quantity": 100,
    "cost": 100
  }
]

Response

200

The warehouse transfer transaction has been edited successfully.