Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 11.9 KB

OrderStatusesApi.md

File metadata and controls

372 lines (249 loc) · 11.9 KB
Raw

Spinen\ConnectWise\Clients\Sales\OrderStatusesApi

Spinen's PHP ConnectWise Client for Sales API generated by Swagger Code Generator.

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Method HTTP request Description
salesOrdersStatusesCountGet GET /sales/orders/statuses/count
salesOrdersStatusesGet GET /sales/orders/statuses
salesOrdersStatusesIdDelete DELETE /sales/orders/statuses/{id}
salesOrdersStatusesIdGet GET /sales/orders/statuses/{id}
salesOrdersStatusesIdPatch PATCH /sales/orders/statuses/{id}
salesOrdersStatusesIdPut PUT /sales/orders/statuses/{id}
salesOrdersStatusesPost POST /sales/orders/statuses

salesOrdersStatusesCountGet

\Spinen\ConnectWise\Clients\Sales\Model\Count salesOrdersStatusesCountGet($conditions)

Get Order Statuses Count

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Sales\Api\OrderStatusesApi();
$conditions = "conditions_example"; // string | 

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

Parameters

Name Type Description Notes
conditions string [optional]

Return type

\Spinen\ConnectWise\Clients\Sales\Model\Count

Authorization

BasicAuth

HTTP request headers

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

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

salesOrdersStatusesGet

\Spinen\ConnectWise\Clients\Sales\Model\OrderStatus[] salesOrdersStatusesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Order Statuses

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Sales\Api\OrderStatusesApi();
$conditions = "conditions_example"; // string | 
$order_by = "order_by_example"; // string | 
$childconditions = "childconditions_example"; // string | 
$customfieldconditions = "customfieldconditions_example"; // string | 
$page = 56; // int | 
$page_size = 56; // int | 

try {
    $result = $api_instance->salesOrdersStatusesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderStatusesApi->salesOrdersStatusesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
conditions string [optional]
order_by string [optional]
childconditions string [optional]
customfieldconditions string [optional]
page int [optional]
page_size int [optional]

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OrderStatus[]

Authorization

BasicAuth

HTTP request headers

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

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

salesOrdersStatusesIdDelete

salesOrdersStatusesIdDelete($id)

Delete Order Status By Id

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Sales\Api\OrderStatusesApi();
$id = 56; // int | 

try {
    $api_instance->salesOrdersStatusesIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling OrderStatusesApi->salesOrdersStatusesIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

BasicAuth

HTTP request headers

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

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

salesOrdersStatusesIdGet

\Spinen\ConnectWise\Clients\Sales\Model\OrderStatus salesOrdersStatusesIdGet($id)

Get Order Status By Id

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Sales\Api\OrderStatusesApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OrderStatus

Authorization

BasicAuth

HTTP request headers

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

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

salesOrdersStatusesIdPatch

\Spinen\ConnectWise\Clients\Sales\Model\OrderStatus salesOrdersStatusesIdPatch($id, $operations)

Update Order Status

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Sales\Api\OrderStatusesApi();
$id = 56; // int | 
$operations = array(new PatchOperation()); // \Spinen\ConnectWise\Clients\Sales\Model\PatchOperation[] | 

try {
    $result = $api_instance->salesOrdersStatusesIdPatch($id, $operations);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderStatusesApi->salesOrdersStatusesIdPatch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
operations \Spinen\ConnectWise\Clients\Sales\Model\PatchOperation[]

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OrderStatus

Authorization

BasicAuth

HTTP request headers

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

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

salesOrdersStatusesIdPut

\Spinen\ConnectWise\Clients\Sales\Model\OrderStatus salesOrdersStatusesIdPut($id, $status)

Replace Order Status

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Sales\Api\OrderStatusesApi();
$id = 56; // int | 
$status = new \Spinen\ConnectWise\Clients\Sales\Model\OrderStatus(); // \Spinen\ConnectWise\Clients\Sales\Model\OrderStatus | 

try {
    $result = $api_instance->salesOrdersStatusesIdPut($id, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderStatusesApi->salesOrdersStatusesIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
status \Spinen\ConnectWise\Clients\Sales\Model\OrderStatus

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OrderStatus

Authorization

BasicAuth

HTTP request headers

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

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

salesOrdersStatusesPost

\Spinen\ConnectWise\Clients\Sales\Model\OrderStatus[] salesOrdersStatusesPost($status)

Create Order Status

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Sales\Api\OrderStatusesApi();
$status = new \Spinen\ConnectWise\Clients\Sales\Model\OrderStatus(); // \Spinen\ConnectWise\Clients\Sales\Model\OrderStatus | 

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

Parameters

Name Type Description Notes
status \Spinen\ConnectWise\Clients\Sales\Model\OrderStatus

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OrderStatus[]

Authorization

BasicAuth

HTTP request headers

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

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