abbadon1334 / scloby-client-api
Installs: 4
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 1
pkg:composer/abbadon1334/scloby-client-api
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ~1.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2025-10-15 21:20:12 UTC
README
https://developer.scloby.com/apidoc/assets/documentation.json Introduction The authentication token is issued via Oauth2 standard ( https://oauth.net) You can apply for a Scloby test account on our developer portal https://developer.scloby.com Here is your ClientId and ClientSecret for tests: client_id: SclobyApiDocs client_secret: DdyPNPvfPOGa0Izjct0C All data is JSON format, and the Content-Type header of POST/PUT request must be set to application/json. Search Parameters You can perform a search in a collection using all first level properties in combination with some parameter, or specifying a value: property = VALUE if you are searching for all items with a specific property value property_since = MIN_VALUE if you are searching for all items with property value greater (or equal) than MIN_VALUE property_max = MAX_VALUE if you are searching for all items with property value smaller (or equal)than MAX_VALUE property_like = LIKE_VALUE if you are searching for a substring content. You can use property_since and property_max in order to simulate between operator If you are using equal operator, all other operators for that parameter will be ingnored If you are using _max or _since operator in strings, the alphabetical ordering will be used
This PHP package is automatically generated by the Swagger Codegen project:
- API version: 2.0.0
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen For more information, please visit https://developer.scloby.com
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json:
{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}
Then run composer install
Manual Installation
Download the files and include autoload.php:
require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
Tests
To run the unit tests:
composer install
./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure OAuth2 access token for authorization: oAuth2AuthCode $config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new Swagger\Client\Api\AccountingDepartmentsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $pagination = true; // bool | Pagination parameter $per_page = 56; // int | Results_per_page $page = 56; // int | PAGE_NUMBER(starting from 0 to TOTAL_PAGE-1) try { $result = $apiInstance->departmentsGet($pagination, $per_page, $page); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountingDepartmentsApi->departmentsGet: ', $e->getMessage(), PHP_EOL; } // Configure OAuth2 access token for authorization: oAuth2AuthCode $config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new Swagger\Client\Api\AccountingDepartmentsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $id = "id_example"; // string | id of the Department that need to be deleted try { $apiInstance->departmentsIdDelete($id); } catch (Exception $e) { echo 'Exception when calling AccountingDepartmentsApi->departmentsIdDelete: ', $e->getMessage(), PHP_EOL; } // Configure OAuth2 access token for authorization: oAuth2AuthCode $config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new Swagger\Client\Api\AccountingDepartmentsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $id = "id_example"; // string | id of the department try { $result = $apiInstance->departmentsIdGet($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountingDepartmentsApi->departmentsIdGet: ', $e->getMessage(), PHP_EOL; } // Configure OAuth2 access token for authorization: oAuth2AuthCode $config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new Swagger\Client\Api\AccountingDepartmentsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \Swagger\Client\Model\StockMovements(); // \Swagger\Client\Model\StockMovements | Object data that need to be updated $id = "id_example"; // string | id of the department that need to be updated try { $result = $apiInstance->departmentsIdPut($body, $id); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountingDepartmentsApi->departmentsIdPut: ', $e->getMessage(), PHP_EOL; } // Configure OAuth2 access token for authorization: oAuth2AuthCode $config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new Swagger\Client\Api\AccountingDepartmentsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \Swagger\Client\Model\Departments(); // \Swagger\Client\Model\Departments | Department object that needs to be added. try { $result = $apiInstance->departmentsPost($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountingDepartmentsApi->departmentsPost: ', $e->getMessage(), PHP_EOL; } ?>
Documentation for API Endpoints
All URIs are relative to https://api.scloby.com/v2
| Class | Method | HTTP request | Description | 
|---|---|---|---|
| AccountingDepartmentsApi | departmentsGet | GET /departments | Get All Departments | 
| AccountingDepartmentsApi | departmentsIdDelete | DELETE /departments/{id} | Delete existing Department | 
| AccountingDepartmentsApi | departmentsIdGet | GET /departments/{id} | Get existing department | 
| AccountingDepartmentsApi | departmentsIdPut | PUT /departments/{id} | Edit existing Department | 
| AccountingDepartmentsApi | departmentsPost | POST /departments | Add new Department | 
| AllergensApi | allergensGet | GET /allergens | Get All Allergens | 
| AllergensApi | allergensIdGet | GET /allergens/{id} | Get existing Allergen | 
| BookingsApi | bookingsGet | GET /bookings | GET All bookings | 
| BookingsApi | bookingsIdDelete | DELETE /bookings/{id} | Delete existing booking | 
| BookingsApi | bookingsIdGet | GET /bookings/{id} | Get existing booking | 
| BookingsApi | bookingsIdPut | PUT /bookings/{id} | Edit existing booking | 
| BookingsApi | bookingsPost | POST /bookings | Add booking | 
| CashBookApi | cashMovementsGet | GET /cash_movements | Get All Cash Movements | 
| CashBookApi | cashMovementsIdDelete | DELETE /cash_movements/{id} | Delete existing Cash Movement | 
| CashBookApi | cashMovementsIdGet | GET /cash_movements/{id} | Get existing Cash Movement | 
| CashBookApi | cashMovementsIdPut | PUT /cash_movements/{id} | Edit existing Cash Movement | 
| CashBookApi | cashMovementsPost | POST /cash_movements | Add new Cash movement | 
| ChainShopsApi | chainShopsIdGet | GET /chain_shops/{id} | Get existing Chain Shop | 
| ChannelsApi | channelsGet | GET /channels | Get All Channels | 
| ChannelsApi | channelsIdDelete | DELETE /channels/{id} | Delete existing Channel | 
| ChannelsApi | channelsIdGet | GET /channels/{id} | Get existing channel | 
| ChannelsApi | channelsIdPut | PUT /channels/{id} | Edit existing channel | 
| ChannelsApi | channelsPost | POST /channels | Add channel | 
| ComponentsApi | componentsGet | GET /components | Get All Components | 
| ComponentsApi | componentsIdDelete | DELETE /components/{id} | Delete existing Component | 
| ComponentsApi | componentsIdGet | GET /components/{id} | Get existing component | 
| ComponentsApi | componentsIdPut | PUT /components/{id} | Edit existing Component | 
| ComponentsApi | componentsPost | POST /components | Add new Component | 
| CustomerOrdersApi | ordersGet | GET /orders | Get All Orders | 
| CustomerOrdersApi | ordersIdDelete | DELETE /orders/{id} | Delete existing Order | 
| CustomerOrdersApi | ordersIdGet | GET /orders/{id} | Get existing Order | 
| CustomerOrdersApi | ordersIdPut | PUT /orders/{id} | Edit existing Order | 
| CustomerOrdersApi | ordersPost | POST /orders | Add new Order | 
| CustomersApi | customersGet | GET /customers | Get All Customers | 
| CustomersApi | customersIdDelete | DELETE /customers/{id} | Delete existing Customer | 
| CustomersApi | customersIdGet | GET /customers/{id} | Get existing customer | 
| CustomersApi | customersIdPut | PUT /customers/{id} | Edit existing customers | 
| CustomersApi | customersPost | POST /customers | Add customer | 
| EInvoiceApi | salesEInvoiceCheckPost | POST /sales/e_invoice/check | Check e-invoice status | 
| EInvoiceApi | sendEInvoiceIdGet | GET /send_e_invoice/{id} | Send e-invoice | 
| ItemCategoriesApi | categoriesGet | GET /categories | Get All Categories | 
| ItemCategoriesApi | categoriesIdDelete | DELETE /categories/{id} | Delete existing Category | 
| ItemCategoriesApi | categoriesIdGet | GET /categories/{id} | Get existing category | 
| ItemCategoriesApi | categoriesIdPut | PUT /categories/{id} | Edit existing Category | 
| ItemCategoriesApi | categoriesPost | POST /categories | Add new Category | 
| ItemsApi | itemsGet | GET /items | GET All items | 
| ItemsApi | itemsIdDelete | DELETE /items/{id} | Delete existing Item | 
| ItemsApi | itemsIdGet | GET /items/{id} | Get existing item | 
| ItemsApi | itemsIdPut | PUT /items/{id} | Edit existing item | 
| ItemsApi | itemsPost | POST /items | Add new Item | 
| LoyaltyProgramCampaignsApi | campaignsGet | GET /campaigns | Get All Campaigns | 
| LoyaltyProgramCampaignsApi | campaignsIdDelete | DELETE /campaigns/{id} | Delete existing Campaign | 
| LoyaltyProgramCampaignsApi | campaignsIdGet | GET /campaigns/{id} | Get existing Campaign | 
| LoyaltyProgramCampaignsApi | campaignsIdPut | PUT /campaigns/{id} | Edit existing Campaign | 
| LoyaltyProgramCampaignsApi | campaignsPost | POST /campaigns | Add new Campaign | 
| LoyaltyProgramCustomerPointsApi | fidelitiesPointsIdGet | GET /fidelities_points/{id} | Get existing Fidelity Point | 
| LoyaltyProgramPointsMovementsApi | fidelitiesMovementsGet | GET /fidelities_movements | Get All Fidelity Movements | 
| LoyaltyProgramPointsMovementsApi | fidelitiesMovementsIdGet | GET /fidelities_movements/{id} | Get existing Fidelity Movement | 
| LoyaltyProgramPointsMovementsApi | fidelitiesMovementsPost | POST /fidelities_movements | Add new Fidelity Movement | 
| LoyaltyProgramPrizesApi | prizesGet | GET /prizes | Get All Prizes | 
| LoyaltyProgramPrizesApi | prizesIdDelete | DELETE /prizes/{id} | Delete existing Prize | 
| LoyaltyProgramPrizesApi | prizesIdGet | GET /prizes/{id} | Get existing Prize | 
| LoyaltyProgramPrizesApi | prizesIdPut | PUT /prizes/{id} | Edit existing Prize | 
| LoyaltyProgramPrizesApi | prizesPost | POST /prizes | Add new Prize | 
| LoyaltyProgramRulesApi | rulesGet | GET /rules | Get All Rules | 
| LoyaltyProgramRulesApi | rulesIdDelete | DELETE /rules/{id} | Delete existing Rule | 
| LoyaltyProgramRulesApi | rulesIdGet | GET /rules/{id} | Get existing Rule | 
| LoyaltyProgramRulesApi | rulesIdPut | PUT /rules/{id} | Edit existing Rule | 
| LoyaltyProgramRulesApi | rulesPost | POST /rules | Add new Rule | 
| PaymentMethodsApi | paymentMethodsGet | GET /payment_methods | Get All Payment Methods | 
| PaymentMethodsApi | paymentMethodsIdDelete | DELETE /payment_methods/{id} | Delete existing Vat rate | 
| PaymentMethodsApi | paymentMethodsIdGet | GET /payment_methods/{id} | Get existing Payment Method | 
| PaymentMethodsApi | paymentMethodsIdPut | PUT /payment_methods/{id} | Edit existing Payment Method | 
| PaymentMethodsApi | paymentMethodsPost | POST /payment_methods | Add new Payment Method | 
| PrepaidCreditMovementsApi | prepaidCustomersGet | GET /prepaid_customers | Get list of Prepaid Customers | 
| PrepaidCreditMovementsApi | prepaidMovementsIdGet | GET /prepaid_movements/{id} | Get existing Prepaid Movement | 
| PrepaidCreditMovementsApi | prepaidMovementsPost | POST /prepaid_movements | Add new Prepaid Movement | 
| PrintersApi | printersGet | GET /printers | Get All Printers | 
| PrintersApi | printersIdDelete | DELETE /printers/{id} | Delete existing Printer | 
| PrintersApi | printersIdGet | GET /printers/{id} | Get existing Printer | 
| PrintersApi | printersIdPut | PUT /printers/{id} | Edit existing Printer | 
| PrintersApi | printersPost | POST /printers | Add new Printer | 
| RawMaterialsApi | rawMaterialsGet | GET /raw_materials | Get All Raw Materials | 
| RawMaterialsApi | rawMaterialsIdDelete | DELETE /raw_materials/{id} | Delete existing Raw material | 
| RawMaterialsApi | rawMaterialsIdGet | GET /raw_materials/{id} | Get existing raw Material | 
| RawMaterialsApi | rawMaterialsIdPut | PUT /raw_materials/{id} | Edit existing Raw material | 
| RawMaterialsApi | rawMaterialsPost | POST /raw_materials | Add new Raw material | 
| RoomsApi | roomsGet | GET /rooms | Get All Rooms | 
| RoomsApi | roomsIdDelete | DELETE /rooms/{id} | Delete existing Room | 
| RoomsApi | roomsIdGet | GET /rooms/{id} | Get existing Printer | 
| RoomsApi | roomsIdPut | PUT /rooms/{id} | Edit existing Room | 
| RoomsApi | roomsPost | POST /rooms | Add new Room | 
| SalesApi | salesGet | GET /sales | Get All Sales | 
| SalesApi | salesIdDelete | DELETE /sales/{id} | Delete existing Sale | 
| SalesApi | salesIdGet | GET /sales/{id} | Get existing Sale | 
| SalesApi | salesIdPut | PUT /sales/{id} | Edit existing Sale | 
| SalesApi | salesPost | POST /sales | Add new Sale | 
| SessionApi | sessionsMeGet | GET /sessions/me | Get Session | 
| ShiftsApi | bookingShiftsGet | GET /booking_shifts | GET All Shifts | 
| ShiftsApi | bookingShiftsIdDelete | DELETE /booking_shifts/{id} | Delete existing shift | 
| ShiftsApi | bookingShiftsIdGet | GET /booking_shifts/{id} | Get existing Shift | 
| ShiftsApi | bookingShiftsIdPut | PUT /booking_shifts/{id} | Edit existing shift | 
| ShiftsApi | bookingShiftsPost | POST /booking_shifts | Add Shift | 
| SuppliersApi | suppliersGet | GET /suppliers | GET All suppliers | 
| SuppliersApi | suppliersIdDelete | DELETE /suppliers/{id} | Delete existing supplier | 
| SuppliersApi | suppliersIdPut | PUT /suppliers/{id} | Edit existing supplier | 
| SuppliersApi | suppliersPost | POST /suppliers | Add a new supplier | 
| VatRatesApi | vatGet | GET /vat | Get All VAT Rates | 
| VatRatesApi | vatIdDelete | DELETE /vat/{id} | Delete existing Vat rate | 
| VatRatesApi | vatIdGet | GET /vat/{id} | Get existing Vat | 
| VatRatesApi | vatIdPut | PUT /vat/{id} | Edit existing Vat | 
| VatRatesApi | vatPost | POST /vat | Add new Vat rate | 
| WarehouseStockApi | stockIdGet | GET /stock/{id} | Get existing Stock | 
| WarehouseStockApi | stockSummaryGet | GET /stock_summary | GET All stock summaries | 
| WarehouseStockMovementsApi | stockMovementsGet | GET /stock_movements | Get All Stock Movements | 
| WarehouseStockMovementsApi | stockMovementsIdDelete | DELETE /stock_movements/{id} | Delete existing Stock Movement | 
| WarehouseStockMovementsApi | stockMovementsIdGet | GET /stock_movements/{id} | Get existing stock movement | 
| WarehouseStockMovementsApi | stockMovementsIdPut | PUT /stock_movements/{id} | Edit existing Stock Movement | 
| WarehouseStockMovementsApi | stockMovementsPost | POST /stock_movements | Add new Stock Movements | 
Documentation For Models
- AllergenSchema
- Allergens
- BookingShifts
- Bookings
- BookingtableSchema
- BookingtagSchema
- CampaignitemSchema
- CashMovements
- Categories
- CategorySchema
- ChainPrepaidMovements
- ChainsCampaigns
- ChainsFidelitiesMovements
- ChainsPrizes
- ChainsRules
- Channels
- CombinationbarcodeSchema
- ComponentSchema
- Components
- CustomerSchema
- CustomerSchema1
- Customers
- DepartmentSchema
- Departments
- InlineResponse200
- InlineResponse2001
- InlineResponse2002
- InlineResponse2003
- InlineResponse2003Shop
- InlineResponse2004
- InlineResponse2005
- InlineResponse201
- InlineResponse2011
- InlineResponse2012
- InlineResponse400
- InlineResponse400Error
- ItemSchema
- ItembarcodeSchema
- ItembomcomponentSchema
- ItemchannelSchema
- ItemcombinationSchema
- ItemimageSchema
- Items
- OrdercustomerSchema
- OrderitemSchema
- OrderitemingredientSchema
- OrderitemvariationSchema
- Orders
- PaymentMethods
- PricechangeSchema
- PrinterSchema
- Printers
- RawMaterial
- Rooms
- RuleSchema
- SalecustomerSchema
- SaledocumentSchema
- SaleeinvoiceSchema
- SaleitemSchema
- SalepaymentSchema
- Sales
- Session
- SessionShop
- Stock
- StockMovements
- Supplier
- TableSchema
- VariationSchema
- VariationvalueSchema
- Vat
- VatSchema
Documentation For Authorization
oAuth2AuthCode
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://login.scloby.com/signin.php
- Scopes:
- ****: