Vendors

These are the related business partners for the customer.

Get Vendors

GET https://api.berymo.com/api/schedule/v1/vendors

This endpoint allows you to get all vendors.

Query Parameters

Name	Type	Description
limit	integer	How many items exactly shows
page	integer	Current page to show
search	string	A query text for the search vendor

200 Vendors successfully retrieved. The vendor objects are located on vendors.items

{
    "vendors": {
        "current_page_number": 1,
        "num_items_per_page": 10,
        "items": [],
        "total_count": 0,
        "paginator_options": {
            "pageParameterName": "page",
            "sortFieldParameterName": "sort",
            "sortDirectionParameterName": "direction",
            "filterFieldParameterName": "filterField",
            "filterValueParameterName": "filterValue",
            "distinct": true
        },
        "custom_parameters": [],
        "route": "api_schedule_vendors_list",
        "params": {
            "page": "1",
            "limit": "10"
        },
        "page_range": 5,
        "template": "@KnpPaginator/Pagination/sliding.html.twig",
        "sortable_template": "@KnpPaginator/Pagination/sortable_link.html.twig",
        "filtration_template": "@KnpPaginator/Pagination/filtration.html.twig"
    }
}

Create Vendor

POST https://api.berymo.com/api/schedule/v1/vendors

This endpoint creates new vendor for the customer.

Request Body

Name	Type	Description
firstName	string	Name of the authorized person
lastName	string	Last name of the authorized person
businessName	string	Partner's offical name
address	string	Partner's address
email	string	Partner's email address
countryCode	string	Partner's country code of phone
phone	string	Partner's phone
notes	string	Notes
latitude	string	Partner's latitude
longitude	string	Partner's longitude
memo	string
position	string
customer	integer	Customer ID

200 Vendor created successfully.

{
    "status": true,
    "vendor": {
        "id": 5,
        "first_name": "Innes",
        "last_name": "Kanwald",
        "business_name": "Adam Inc",
        "address": "163 St. San F., CA",
        "email": "[email protected]",
        "country_code": "1",
        "phone": "538227XXXX",
        "latitude": "38.XXXXX",
        "longitude": "27.XXXXX"
    }
}

Update a Vendor

PATCH https://api.berymo.com/api/schedule/v1/vendors/:id

This endpoint updates a vendor information. Body parameters are same as create endpoint.

Path Parameters

Name	Type	Description
id	integer	ID of an vendor object to update

200 Vendor updated successfully.

{
    "status": true,
    "vendor": {
        "id": 5,
        "first_name": "Ali",
        "last_name": "Kanwald",
        "business_name": "Adam Inc",
        "address": "1675 St. San F, CA",
        "email": "[email protected]",
        "country_code": "1",
        "phone": "538XXXXX",
        "latitude": "-38.XXXXX",
        "longitude": "-27.XXXX"
    }
}

Delete a Vendor

DELETE https://api.berymo.com/api/schedule/v1/vendors/:id

Path Parameters

Name	Type	Description
id	integer	ID of an vendor object to delete

200