Warehouse Transfer Line

The warehouse transfer line resource.

Basehttps://rest.carbon.ms/warehouseTransferLine

GET/warehouseTransferLine

List warehouse transfer lines

Retrieve a paginated list of warehouse transfer lines. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/warehouseTransferLine

curl --request GET \
  --url 'https://rest.carbon.ms/warehouseTransferLine?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "transferId": "xyz789",
    "itemId": "xyz789",
    "quantity": 10,
    "shippedQuantity": 10,
    "receivedQuantity": 10,
    "fromLocationId": "xyz789",
    "toLocationId": "xyz789"
  }
]

GET/warehouseTransferLine

Retrieve a warehouse transfer line

Fetch a single warehouse transfer line by filtering on `id`.

Query parameters

idstring

Match on the warehouse transfer line's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/warehouseTransferLine

curl --request GET \
  --url 'https://rest.carbon.ms/warehouseTransferLine?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "transferId": "xyz789",
  "itemId": "xyz789",
  "quantity": 10,
  "shippedQuantity": 10,
  "receivedQuantity": 10,
  "fromLocationId": "xyz789",
  "toLocationId": "xyz789"
}

POST/warehouseTransferLine

Create a warehouse transfer line

Create a new warehouse transfer line.

Body parameters

transferIdstringrequired

References warehouseTransfer.id

itemIdstringrequired

References item.id

quantitynumberrequired

shippedQuantitynumberrequired

receivedQuantitynumberrequired

fromLocationIdstringrequired

References location.id

fromStorageUnitIdstring

References storageUnit.id

toLocationIdstringrequired

References location.id

toStorageUnitIdstring

References storageUnit.id

unitOfMeasureCodestring

notesstring

companyIdstringrequired

References company.id

customFieldsobject

POSThttps://rest.carbon.ms/warehouseTransferLine

curl --request POST \
  --url https://rest.carbon.ms/warehouseTransferLine \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"transferId":"xyz789","itemId":"xyz789","quantity":10,"shippedQuantity":10,"receivedQuantity":10,"fromLocationId":"xyz789","toLocationId":"xyz789","companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "transferId": "xyz789",
  "itemId": "xyz789",
  "quantity": 10,
  "shippedQuantity": 10,
  "receivedQuantity": 10,
  "fromLocationId": "xyz789",
  "toLocationId": "xyz789"
}

PATCH/warehouseTransferLine

Update a warehouse transfer line

Update an existing warehouse transfer line, matched on `id`.

Body parameters

transferIdstringrequired

References warehouseTransfer.id

itemIdstringrequired

References item.id

quantitynumberrequired

shippedQuantitynumberrequired

receivedQuantitynumberrequired

fromLocationIdstringrequired

References location.id

fromStorageUnitIdstring

References storageUnit.id

toLocationIdstringrequired

References location.id

toStorageUnitIdstring

References storageUnit.id

unitOfMeasureCodestring

notesstring

companyIdstringrequired

References company.id

customFieldsobject

PATCHhttps://rest.carbon.ms/warehouseTransferLine

curl --request PATCH \
  --url 'https://rest.carbon.ms/warehouseTransferLine?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"transferId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "transferId": "xyz789",
  "itemId": "xyz789",
  "quantity": 10,
  "shippedQuantity": 10,
  "receivedQuantity": 10,
  "fromLocationId": "xyz789",
  "toLocationId": "xyz789"
}

DELETE/warehouseTransferLine

Delete a warehouse transfer line

Delete a warehouse transfer line, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the warehouse transfer line to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/warehouseTransferLine

curl --request DELETE \
  --url 'https://rest.carbon.ms/warehouseTransferLine?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content