Supplier Contact

The supplier contact resource.

Basehttps://rest.carbon.ms/supplierContact

GET/supplierContact

List supplier contacts

Retrieve a paginated list of supplier contacts. 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/supplierContact

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

Response

[
  {
    "id": "abc123def456",
    "supplierId": "xyz789",
    "contactId": "xyz789",
    "supplierLocationId": "xyz789",
    "userId": "xyz789",
    "customFields": "string",
    "tags": []
  }
]

GET/supplierContact

Retrieve a supplier contact

Fetch a single supplier contact by filtering on `id`.

Query parameters

idstring

Match on the supplier contact's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/supplierContact

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

Response

{
  "id": "abc123def456",
  "supplierId": "xyz789",
  "contactId": "xyz789",
  "supplierLocationId": "xyz789",
  "userId": "xyz789",
  "customFields": "string",
  "tags": []
}

POST/supplierContact

Create a supplier contact

Create a new supplier contact.

Body parameters

supplierIdstringrequired

References supplier.id

contactIdstringrequired

References contact.id

supplierLocationIdstring

References supplierLocation.id

userIdstring

References user.id

customFieldsobject

tagsarray

POSThttps://rest.carbon.ms/supplierContact

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

Response

{
  "id": "abc123def456",
  "supplierId": "xyz789",
  "contactId": "xyz789",
  "supplierLocationId": "xyz789",
  "userId": "xyz789",
  "customFields": "string",
  "tags": []
}

PATCH/supplierContact

Update a supplier contact

Update an existing supplier contact, matched on `id`.

Body parameters

supplierIdstringrequired

References supplier.id

contactIdstringrequired

References contact.id

supplierLocationIdstring

References supplierLocation.id

userIdstring

References user.id

customFieldsobject

tagsarray

PATCHhttps://rest.carbon.ms/supplierContact

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

Response

{
  "id": "abc123def456",
  "supplierId": "xyz789",
  "contactId": "xyz789",
  "supplierLocationId": "xyz789",
  "userId": "xyz789",
  "customFields": "string",
  "tags": []
}

DELETE/supplierContact

Delete a supplier contact

Delete a supplier contact, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the supplier contact to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/supplierContact

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

204 No Content