Purchase Order Favorite

The purchase order favorite resource.

Basehttps://rest.carbon.ms/purchaseOrderFavorite

GET/purchaseOrderFavorite

List purchase order favorites

Retrieve a paginated list of purchase order favorites. 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/purchaseOrderFavorite

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

Response

[
  {
    "purchaseOrderId": "xyz789",
    "userId": "xyz789"
  }
]

GET/purchaseOrderFavorite

Retrieve a purchase order favorite

Fetch a single purchase order favorite by filtering on `purchaseOrderId`.

Query parameters

purchaseOrderIdstring

Match on the purchase order favorite's `purchaseOrderId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/purchaseOrderFavorite

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

Response

{
  "purchaseOrderId": "xyz789",
  "userId": "xyz789"
}

POST/purchaseOrderFavorite

Create a purchase order favorite

Create a new purchase order favorite.

POSThttps://rest.carbon.ms/purchaseOrderFavorite

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

Response

{
  "purchaseOrderId": "xyz789",
  "userId": "xyz789"
}

PATCH/purchaseOrderFavorite

Update a purchase order favorite

Update an existing purchase order favorite, matched on `purchaseOrderId`.

PATCHhttps://rest.carbon.ms/purchaseOrderFavorite

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

Response

{
  "purchaseOrderId": "xyz789",
  "userId": "xyz789"
}

DELETE/purchaseOrderFavorite

Delete a purchase order favorite

Delete a purchase order favorite, matched on `purchaseOrderId`. Returns 204 No Content.

Query parameters

purchaseOrderIdstring

The `purchaseOrderId` of the purchase order favorite to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/purchaseOrderFavorite

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

204 No Content