Skip to content

Latest commit

 

History

History
182 lines (127 loc) · 7.6 KB

SalesInvoiceRepositoryV1Api.md

File metadata and controls

182 lines (127 loc) · 7.6 KB
Raw

Krak\MagentoApiClient\SalesInvoiceRepositoryV1Api

All URIs are relative to http://ce22.vg/index.php/rest/default

Method HTTP request Description
salesInvoiceRepositoryV1GetGet GET /V1/invoices/{id}
salesInvoiceRepositoryV1GetListGet GET /V1/invoices
salesInvoiceRepositoryV1SavePost POST /V1/invoices/

salesInvoiceRepositoryV1GetGet

\Krak\MagentoApiClient\Model\SalesDataInvoiceInterface salesInvoiceRepositoryV1GetGet($id)

Loads a specified invoice.

Example

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

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\SalesInvoiceRepositoryV1Api(
    // 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 = 56; // int | The invoice ID.

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

Parameters

Name Type Description Notes
id int The invoice ID.

Return type

\Krak\MagentoApiClient\Model\SalesDataInvoiceInterface

Authorization

OAuth2

HTTP request headers

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

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

salesInvoiceRepositoryV1GetListGet

\Krak\MagentoApiClient\Model\SalesDataInvoiceSearchResultInterface salesInvoiceRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage)

Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

Example

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

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\SalesInvoiceRepositoryV1Api(
    // 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
);
$searchCriteriaFilterGroupsFiltersField = "searchCriteriaFilterGroupsFiltersField_example"; // string | Field
$searchCriteriaFilterGroupsFiltersValue = "searchCriteriaFilterGroupsFiltersValue_example"; // string | Value
$searchCriteriaFilterGroupsFiltersConditionType = "searchCriteriaFilterGroupsFiltersConditionType_example"; // string | Condition type
$searchCriteriaSortOrdersField = "searchCriteriaSortOrdersField_example"; // string | Sorting field.
$searchCriteriaSortOrdersDirection = "searchCriteriaSortOrdersDirection_example"; // string | Sorting direction.
$searchCriteriaPageSize = 56; // int | Page size.
$searchCriteriaCurrentPage = 56; // int | Current page.

try {
    $result = $apiInstance->salesInvoiceRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesInvoiceRepositoryV1Api->salesInvoiceRepositoryV1GetListGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
searchCriteriaFilterGroupsFiltersField string Field [optional]
searchCriteriaFilterGroupsFiltersValue string Value [optional]
searchCriteriaFilterGroupsFiltersConditionType string Condition type [optional]
searchCriteriaSortOrdersField string Sorting field. [optional]
searchCriteriaSortOrdersDirection string Sorting direction. [optional]
searchCriteriaPageSize int Page size. [optional]
searchCriteriaCurrentPage int Current page. [optional]

Return type

\Krak\MagentoApiClient\Model\SalesDataInvoiceSearchResultInterface

Authorization

OAuth2

HTTP request headers

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

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

salesInvoiceRepositoryV1SavePost

\Krak\MagentoApiClient\Model\SalesDataInvoiceInterface salesInvoiceRepositoryV1SavePost($salesInvoiceRepositoryV1SavePostBody)

Performs persist operations for a specified invoice.

Example

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

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\SalesInvoiceRepositoryV1Api(
    // 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
);
$salesInvoiceRepositoryV1SavePostBody = new \Krak\MagentoApiClient\Model\SalesInvoiceRepositoryV1SavePostBody(); // \Krak\MagentoApiClient\Model\SalesInvoiceRepositoryV1SavePostBody | 

try {
    $result = $apiInstance->salesInvoiceRepositoryV1SavePost($salesInvoiceRepositoryV1SavePostBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesInvoiceRepositoryV1Api->salesInvoiceRepositoryV1SavePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
salesInvoiceRepositoryV1SavePostBody \Krak\MagentoApiClient\Model\SalesInvoiceRepositoryV1SavePostBody [optional]

Return type

\Krak\MagentoApiClient\Model\SalesDataInvoiceInterface

Authorization

OAuth2

HTTP request headers

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

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