Sales Order Favorite

The sales order favorite resource.

Basehttps://rest.carbon.ms/salesOrderFavorite

GET/salesOrderFavorite

List sales order favorites

Retrieve a paginated list of sales 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/salesOrderFavorite

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

Response

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

GET/salesOrderFavorite

Retrieve a sales order favorite

Fetch a single sales order favorite by filtering on `salesOrderId`.

Query parameters

salesOrderIdstring

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

GEThttps://rest.carbon.ms/salesOrderFavorite

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

Response

{
  "salesOrderId": "xyz789",
  "userId": "xyz789"
}

POST/salesOrderFavorite

Create a sales order favorite

Create a new sales order favorite.

POSThttps://rest.carbon.ms/salesOrderFavorite

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

Response

{
  "salesOrderId": "xyz789",
  "userId": "xyz789"
}

PATCH/salesOrderFavorite

Update a sales order favorite

Update an existing sales order favorite, matched on `salesOrderId`.

PATCHhttps://rest.carbon.ms/salesOrderFavorite

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

Response

{
  "salesOrderId": "xyz789",
  "userId": "xyz789"
}

DELETE/salesOrderFavorite

Delete a sales order favorite

Delete a sales order favorite, matched on `salesOrderId`. Returns 204 No Content.

Query parameters

salesOrderIdstring

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

DELETEhttps://rest.carbon.ms/salesOrderFavorite

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

204 No Content