Vendor

These endpoints let you manage vendor master data in the system. It allows you to retrieve vendor records.

Get Vendors

get

Return a paginated list of vendors.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
id	:	Equal operator with multiple values. Each value should separated with delimiters ;
name	:	Equal operator

Example: {"summary":"Search Vendors by Multiple IDs","value":"id:f18f5618-ac6c-11e6-80f5-76304dec7eb7;f18f5618-ac6c-11e6-80f5-76304dec7eb8"}

Responses

200

OK

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/core/v1/vendors

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/vendors?page=0&size=10&query=id%3Af18f5618-ac6c-11e6-80f5-76304dec7eb7%3Bf18f5618-ac6c-11e6-80f5-76304dec7eb8" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb7",
      "name": "freelancer",
      "createdBy": "system",
      "createdDate": 1478586884810,
      "updatedBy": "system",
      "updatedDate": 1478586884810
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "ASC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": true,
      "descending": false
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Vendor By Id

get

Return a single vendor by its ID.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f18f5618-ac6c-11e6-80f5-76304dec7eb7

Responses

200

OK

application/json

idstringOptional

namestringOptional

createdBystringOptional

createdDatenumberOptional

updatedBystringOptional

updatedDatenumberOptional

400

Bad Request

404

Not Found

get

/core/v1/vendors/{id}

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/vendors/f18f5618-ac6c-11e6-80f5-76304dec7eb7" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb7",
  "name": "Freelancer.id",
  "createdBy": "system",
  "createdDate": 1478586884810,
  "updatedBy": "system",
  "updatedDate": 1478586884810
}