Stock Transfer

The stock transfer resource.

Basehttps://rest.carbon.ms/stockTransfer

GET/stockTransfer

List stock transfers

Retrieve a paginated list of stock transfers. 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/stockTransfer

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "stockTransferId": "xyz789",
    "locationId": "xyz789",
    "status": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "completedAt": "2026-01-01T00:00:00Z"
  }
]

GET/stockTransfer

Retrieve a stock transfer

Fetch a single stock transfer by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/stockTransfer

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "stockTransferId": "xyz789",
  "locationId": "xyz789",
  "status": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "completedAt": "2026-01-01T00:00:00Z"
}

POST/stockTransfer

Create a stock transfer

Create a new stock transfer.

Body parameters

stockTransferIdstringrequired

locationIdstringrequired

References location.id

statusstockTransferStatusrequired

completedAttimestamp

notesobject

assigneestring

References user.id

customFieldsobject

tagsarray

POSThttps://rest.carbon.ms/stockTransfer

curl --request POST \
  --url https://rest.carbon.ms/stockTransfer \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"stockTransferId":"xyz789","locationId":"xyz789","status":"string"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "stockTransferId": "xyz789",
  "locationId": "xyz789",
  "status": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "completedAt": "2026-01-01T00:00:00Z"
}

PATCH/stockTransfer

Update a stock transfer

Update an existing stock transfer, matched on `id`.

Body parameters

stockTransferIdstringrequired

locationIdstringrequired

References location.id

statusstockTransferStatusrequired

completedAttimestamp

notesobject

assigneestring

References user.id

customFieldsobject

tagsarray

PATCHhttps://rest.carbon.ms/stockTransfer

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "stockTransferId": "xyz789",
  "locationId": "xyz789",
  "status": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "completedAt": "2026-01-01T00:00:00Z"
}

DELETE/stockTransfer

Delete a stock transfer

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/stockTransfer

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

204 No Content