All URIs are relative to http://t213.vg/rest/default

Method	HTTP request	Description
salesShipmentRepositoryV1GetGet	GET /V1/shipment/{id}
salesShipmentRepositoryV1GetListGet	GET /V1/shipments
salesShipmentRepositoryV1SavePost	POST /V1/shipment/

salesShipmentRepositoryV1GetGet

\SpringImport\Swagger\Magento2\Client\Model\SalesDataShipmentInterface salesShipmentRepositoryV1GetGet($id)

Loads a specified shipment.

Example

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

$api_instance = new SpringImport\Swagger\Magento2\Client\Api\SalesShipmentRepositoryV1Api();
$id = 56; // int | The shipment ID.

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

Parameters

Name	Type	Description	Notes
id	int	The shipment ID.

Return type

\SpringImport\Swagger\Magento2\Client\Model\SalesDataShipmentInterface

Authorization

No authorization required

HTTP request headers

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

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

salesShipmentRepositoryV1GetListGet

\SpringImport\Swagger\Magento2\Client\Model\SalesDataShipmentSearchResultInterface salesShipmentRepositoryV1GetListGet($searchCriteriaFilterGroups0Filters0Field,$searchCriteriaFilterGroups0Filters0Value, $searchCriteriaFilterGroups0Filters0ConditionType,$searchCriteriaSortOrders0Field, $searchCriteriaSortOrders0Direction,$searchCriteriaPageSize, $searchCriteriaCurrentPage)

Lists shipments 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#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

Example

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

$api_instance = new SpringImport\Swagger\Magento2\Client\Api\SalesShipmentRepositoryV1Api();
$searchCriteriaFilterGroups0Filters0Field = "searchCriteriaFilterGroups0Filters0Field_example"; // string | Field
$searchCriteriaFilterGroups0Filters0Value = "searchCriteriaFilterGroups0Filters0Value_example"; // string | Value
$searchCriteriaFilterGroups0Filters0ConditionType = "searchCriteriaFilterGroups0Filters0ConditionType_example"; // string | Condition type
$searchCriteriaSortOrders0Field = "searchCriteriaSortOrders0Field_example"; // string | Sorting field.
$searchCriteriaSortOrders0Direction = "searchCriteriaSortOrders0Direction_example"; // string | Sorting direction.
$searchCriteriaPageSize = 56; // int | Page size.
$searchCriteriaCurrentPage = 56; // int | Current page.

try {
    $result = $api_instance->salesShipmentRepositoryV1GetListGet($searchCriteriaFilterGroups0Filters0Field, $searchCriteriaFilterGroups0Filters0Value, $searchCriteriaFilterGroups0Filters0ConditionType, $searchCriteriaSortOrders0Field, $searchCriteriaSortOrders0Direction, $searchCriteriaPageSize, $searchCriteriaCurrentPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesShipmentRepositoryV1Api->salesShipmentRepositoryV1GetListGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
searchCriteriaFilterGroups0Filters0Field	string	Field	[optional]
searchCriteriaFilterGroups0Filters0Value	string	Value	[optional]
searchCriteriaFilterGroups0Filters0ConditionType	string	Condition type	[optional]
searchCriteriaSortOrders0Field	string	Sorting field.	[optional]
searchCriteriaSortOrders0Direction	string	Sorting direction.	[optional]
searchCriteriaPageSize	int	Page size.	[optional]
searchCriteriaCurrentPage	int	Current page.	[optional]

Return type

\SpringImport\Swagger\Magento2\Client\Model\SalesDataShipmentSearchResultInterface

Authorization

No authorization required

HTTP request headers

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

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

salesShipmentRepositoryV1SavePost

\SpringImport\Swagger\Magento2\Client\Model\SalesDataShipmentInterface salesShipmentRepositoryV1SavePost($body)

Performs persist operations for a specified shipment.

Example

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

$api_instance = new SpringImport\Swagger\Magento2\Client\Api\SalesShipmentRepositoryV1Api();
$body = new \SpringImport\Swagger\Magento2\Client\Model\Body82(); // \SpringImport\Swagger\Magento2\Client\Model\Body82 | 

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

Parameters

Name	Type	Description	Notes
body	\SpringImport\Swagger\Magento2\Client\Model\Body82		[optional]

Return type

\SpringImport\Swagger\Magento2\Client\Model\SalesDataShipmentInterface

Authorization

No authorization required

HTTP request headers

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

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