Printer Route

The printer route resource.

Basehttps://rest.carbon.ms/printerRoute

GET/printerRoute

List printer routes

Retrieve a paginated list of printer routes. 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/printerRoute

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "name": "Example",
    "format": "string",
    "printerUrl": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "locationId": "xyz789",
    "mediaSizeId": "xyz789"
  }
]

GET/printerRoute

Retrieve a printer route

Fetch a single printer route by filtering on `id`.

Query parameters

idstring

Match on the printer route's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/printerRoute

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "format": "string",
  "printerUrl": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "locationId": "xyz789",
  "mediaSizeId": "xyz789"
}

POST/printerRoute

Create a printer route

Create a new printer route.

Body parameters

locationIdstring

References location.id

namestringrequired

formatstringrequired

mediaSizeIdstring

printerUrlstringrequired

apiKeystring

POSThttps://rest.carbon.ms/printerRoute

curl --request POST \
  --url https://rest.carbon.ms/printerRoute \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","format":"string","printerUrl":"string"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "format": "string",
  "printerUrl": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "locationId": "xyz789",
  "mediaSizeId": "xyz789"
}

PATCH/printerRoute

Update a printer route

Update an existing printer route, matched on `id`.

Body parameters

locationIdstring

References location.id

namestringrequired

formatstringrequired

mediaSizeIdstring

printerUrlstringrequired

apiKeystring

PATCHhttps://rest.carbon.ms/printerRoute

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "format": "string",
  "printerUrl": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "locationId": "xyz789",
  "mediaSizeId": "xyz789"
}

DELETE/printerRoute

Delete a printer route

Delete a printer route, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the printer route to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/printerRoute

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

204 No Content