Overview

The Retrieve Suppliers API is used by the Agent to access a comprehensive list of all connected suppliers. By using this API, the Agent can obtain key details about each supplier, including unique identifiers, contact information, and their current connectivity status. The API response provides a clear and structured overview of all connected suppliers, making it easier for the Agent to manage and interact with them.

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

Response Definition

Response Item	Description	Data Type
`"suppliers"`	An array containing information about the connected Suppliers	array

`"suppliers"` Object

Response Item	Description	Data Type
`"id"`	The unique identifier of the Supplier.	int
`"emails"`	The email address(s) associated with the supplier user.	string
`"telephone"`	The contact telephone number of the supplier.	string
`"full_name"`	The full name of the supplier.	string
`"first_name"`	The first name of the supplier.	string
`"last_name"`	The last name of the supplier.	string
`"company_name"`	The name of the company associated with the supplier.	string
`"address"`	An object containing the address details of the supplier.	object
`"domain_name"`	The domain name associated with the supplier's website.	string
`"credit_cards"`	A list of credit cards accepted by the supplier.	array
`"arrival_time"`	Default arrival/check-in time (in HH:MM format).	string
`"departure_time"`	Default departure/check-out time (in HH:MM format).	string

`"address"` Object

Response Item	Description	Data Type
`"address_line_1"`	The first line of the supplier's address.	string
`"address_line_2"`	The second line of the supplier's address (e.g., suite or unit number).	string
`"city"`	The City where the supplier is located.	string
`"state_province"`	The State or Province where the supplier is located.	string
`"country"`	The Country where the supplier is located.	string
`"postal_code"`	The Postal or ZIP code of the supplier's location.	string

`"credit_cards"` Object

Response Item	Description	Data Type
`"id"`	Unique ID for the credit card configuration.	int
`"card_type"`	Name/type of the card (e.g., Visa, Mastercard, Check).	string
`"percentage"`	The fee percentage applied when this card type is used.	float

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,
            "emails": "[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/vv2024.07.31/suppliers?page=2&page_size=25&no_total=false",
        "total_page_count": 2,
        "page": 1,
        "page_size": 25
    }
}