Skip to content

Latest commit

 

History

History
116 lines (80 loc) · 3.43 KB

OrderStatesApi.md

File metadata and controls

116 lines (80 loc) · 3.43 KB

OrderStatesApi

All URIs are relative to https://api.kinow.com/api

Method HTTP request Description
getOrderState GET /order-states/{order_state_id}
getOrderStates GET /order-states

getOrderState

\Kinow\Client\Model\OrderStateResponse getOrderState($order_state_id)

Get order state

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\OrderStatesApi();
$order_state_id = 789; // int | Order state ID to fetch

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

Parameters

Name Type Description Notes
order_state_id int Order state ID to fetch

Return type

\Kinow\Client\Model\OrderStateResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getOrderStates

\Kinow\Client\Model\OrderStateListResponse getOrderStates($page, $per_page)

Get order state list

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\OrderStatesApi();
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getOrderStates($page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderStatesApi->getOrderStates: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
page int [optional]
per_page int [optional]

Return type

\Kinow\Client\Model\OrderStateListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined