Skip to content

Latest commit

 

History

History
128 lines (94 loc) · 4.69 KB

ProductsApi.md

File metadata and controls

128 lines (94 loc) · 4.69 KB
Raw

Ageras\Api\ProductsApi

All URIs are relative to https://api.ageras.com/v2

Method HTTP request Description
productsCreate POST /products Create product.
productsIndex GET /products List products.

productsCreate

\Ageras\Api\ProductResource productsCreate($product_resource)

Create product.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProductsApi();
$product_resource = new \Ageras\Api\ProductResource(); // \Ageras\Api\ProductResource | 

try {
    $result = $api_instance->productsCreate($product_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->productsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
product_resource \Ageras\Api\ProductResource

Return type

\Ageras\Api\ProductResource

Authorization

jwt, login

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

productsIndex

\Ageras\Api\ProductResult productsIndex($criteria)

List products.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ProductsApi();
$criteria = [
        'product_id' => 56; // int | Product id of Products to filter by.
        'employee_id' => 56; // int | Employee id of Products to filter by.
        'geo_code' => "geo_code_example"; // string | Geo code of Products to filter by.
        'is_archived' => false; // bool | Filter products by archived status.
        'is_auto_quotable' => false; // bool | Filter products by auto-quote availability
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->productsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->productsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
product_id int Product id of Products to filter by. [optional]
employee_id int Employee id of Products to filter by. [optional]
geo_code string Geo code of Products to filter by. [optional]
is_archived bool Filter products by archived status. [optional] [default to false]
is_auto_quotable bool Filter products by auto-quote availability [optional] [default to false]
limit int The number of resources to be returned. [optional]
page int The page position in the result. [optional]
query string The search wildcard. [optional]

Return type

\Ageras\Api\ProductResult

Authorization

jwt, login

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]