Overview

The Retrieve Suppliers endpoint represents the first step in the standard CiiRUS Partner API integration workflow. It allows an Agent to retrieve the list of suppliers that are available within their integration scope and establish the foundational supplier context used throughout the rest of the integration.

This response is commonly used to:

Build and persist a local mapping of "management_company_user_id" values used across downstream endpoints such as /units, /unit_calendars, /unit_quotes, and /reservations.
Display supplier-facing metadata, including company name and contact information.
Retrieve supplier-level configuration values that directly influence booking, availability, and payment behavior later in the workflow.

Several values returned by this endpoint reflect supplier-managed configuration within the CiiRUS system (for example, accepted credit card types and default check-in/check-out times). Each supplier defines these settings, and they are consistently applied across their entire inventory.

📘
Important Note:
Accepted credit card types are configured at the supplier level.
When submitting payment-related data, the "card_type" (cardType) value must exactly match one of the values returned for the associated supplier.
Agents should not assume global card acceptance rules or infer supported card types across different suppliers.

Related Supplier Configuration (Optional Context)

The following supplier-facing settings in CiiRUS directly map to values returned by this endpoint:

Accepted Credit Card Types (maps to "credit_cards")
- Adding accepted credit card types
Default Check-In / Check-Out Times (maps to "arrival_time" and "departure_time")
- Setting default check-in/out times

Endpoints Available

Method	Endpoint	Description
GET	v2024.07.31/suppliers	Retrieve a list of all connected suppliers.

Query String Parameters

Parameters	Required / Optional	Description	Data Type
page	Optional	The page to be shown (defaults to 1).	int
page_size	Optional	Limits the number of returned results (defaults to 25).	int
no_total	Optional	Removes the total page count for faster results (defaults to `false`)	boolean
active	Optional	Only return suppliers marked as active.	boolean

Response Definition

Response Item	Description	Data Type
`"suppliers"`	A collection of suppliers that are available within the Agent’s integration scope. Each entry represents a management company that manages inventory accessible via the API.	array
`"paging"`	Paging metadata used to navigate through large result sets when multiple suppliers are returned.	object

`"suppliers"` Object

Response Item	Description	Data Type
`"id"`	The unique identifier for the supplier. This value maps directly to `management_company_user_id` used across various endpoints, such as `/units`, `/unit_calendars`, `/unit_quotes`, and `/reservations`.	int
`"emails"`	One or more email addresses associated with the supplier account. These are typically used for operational or administrative contact purposes.	string
`"telephone"`	The primary contact phone number for the supplier, if configured.	string
`"full_name"`	The full name of the primary supplier user associated with the account.	string
`"first_name"`	The first name of the supplier user.	string
`"last_name"`	The last name of the supplier user.	string
`"company_name"`	The business or brand name under which the supplier operates and manages inventory.	string
`"address"`	An object containing the physical address details associated with the supplier account.	object
`"domain_name"`	The domain or website associated with the supplier’s branding or online presence, if configured.	string
`"credit_cards"`	A list of credit card configurations defining which payment methods the supplier accepts and how they are processed.	array
`"arrival_time"`	The default check-in time configured by the supplier. This value represents the standard arrival time applied across the supplier’s inventory.	string
`"departure_time"`	The default check-out time configured by the supplier. This value represents the standard departure time applied across the supplier’s inventory.	string

`"address"` Object

Response Item	Description	Data Type
`"address_line_1"`	The primary street address associated with the supplier’s business location.	string
`"address_line_2"`	Additional address details such as suite, unit number, or building identifier, if applicable.	string
`"city"`	The city in which the supplier is located.	string
`"state_province"`	The state or province in which the supplier is located.	string
`"country"`	The country in which the supplier is located.	string
`"postal_code"`	The postal or ZIP code associated with the supplier’s address.	string

`"credit_cards"` Object

Response Item	Description	Data Type
`"id"`	The unique identifier for this supplier-specific credit card configuration.	int
`"card_type"`	The supplier-defined name of the credit card type (for example, `Visa`, `Mastercard`). This value must be submitted exactly as returned when processing payments.	string
`"percentage"`	The processing fee percentage applied by the supplier when this card type is used for a transaction.	float

`"paging"` Object

Response Item	Description	Data Type
`"next_page_url"`	A URL that can be used to retrieve the next page of supplier results, if additional pages exist.	string
`"previous_page_url"`	A URL that can be used to retrieve the previous page of supplier results, if applicable.	string
`"total_page_count"`	The total number of available pages for the current request.	int
`"page"`	The current page number being returned.	int
`"page_size"`	The number of records being included per page.	int

Sample Request

curl --request GET \
     --url 'https://api.ciiruspartners.com/v2024.07.31/suppliers?page=1&page_size=25&no_total=false' \
     --header 'accept: application/json' \
     --header 'authorization: Basic {APIUsername:APIPassword}'

GET /v2024.07.31/suppliers?page=1&page_size=25&no_total=false HTTP/1.1
Host: api.ciiruspartners.com
Authorization: Basic {APIUsername:APIPassword}

Sample Response

{
    "suppliers": [
        {"id": 42330,
            "email": "[email protected]",
            "telephone": "1231231234",
            "full_name": "API Test",
            "first_name": "API",
            "last_name": "Test",
            "company_name": "CiiRUS, Inc.",
            "address": {
                "address_line_1": "1142 Celebration Blvd",
                "address_line_2": "Suite A",
                "city": "Celebration",
                "state_province": "Florida",
                "country": "US",
                "postal_code": "34747"
            },
            "domain_name": "http://APITest.ciirus.com",
            "credit_cards": [
                {
                    "id": 1384,
                    "card_type": "American Express",
                    "percentage": 3.00
                },
                {
                    "id": 2551,
                    "card_type": "Discover",
                    "percentage": 3.00
                },
                {
                    "id": 1383,
                    "card_type": "Master Card",
                    "percentage": 3.00
                },
                {
                    "id": 1382,
                    "card_type": "Visa",
                    "percentage": 3.00
                }
            ],
            "arrival_time": "16:00",
            "departure_time": "10:00"
        },
      ...
    ],
     "paging": {
        "next_page_url": "https://api.ciiruspartners.com/v2024.07.31/suppliers?page=2&page_size=25&no_total=false",
        "total_page_count": 2,
        "page": 1,
        "page_size": 25
    }
}

Overview

Important Note:

Related Supplier Configuration (Optional Context)

Endpoints Available

Query String Parameters

Response Definition

"suppliers" Object

"address" Object

"credit_cards" Object

"paging" Object

Sample Request

Sample Response

`"suppliers"` Object

`"address"` Object

`"credit_cards"` Object

`"paging"` Object