Skip to content

RmaTrackManagementV1Api.md

Latest commit

 

History

History
228 lines (156 loc) · 7.07 KB

RmaTrackManagementV1Api.md

File metadata and controls

228 lines (156 loc) · 7.07 KB
Raw

Krak\MagentoApiClient\RmaTrackManagementV1Api

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

Method HTTP request Description
rmaTrackManagementV1AddTrackPost POST /V1/returns/{id}/tracking-numbers
rmaTrackManagementV1GetShippingLabelPdfGet GET /V1/returns/{id}/labels
rmaTrackManagementV1GetTracksGet GET /V1/returns/{id}/tracking-numbers
rmaTrackManagementV1RemoveTrackByIdDelete DELETE /V1/returns/{id}/tracking-numbers/{trackId}

rmaTrackManagementV1AddTrackPost

bool rmaTrackManagementV1AddTrackPost($id, $rmaTrackManagementV1AddTrackPostBody)

Add track

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\RmaTrackManagementV1Api(
    // 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 | 
$rmaTrackManagementV1AddTrackPostBody = new \Krak\MagentoApiClient\Model\RmaTrackManagementV1AddTrackPostBody(); // \Krak\MagentoApiClient\Model\RmaTrackManagementV1AddTrackPostBody | 

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

Parameters

Name Type Description Notes
id int
rmaTrackManagementV1AddTrackPostBody \Krak\MagentoApiClient\Model\RmaTrackManagementV1AddTrackPostBody [optional]

Return type

bool

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]

rmaTrackManagementV1GetShippingLabelPdfGet

string rmaTrackManagementV1GetShippingLabelPdfGet($id)

Get shipping label int the PDF format

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\RmaTrackManagementV1Api(
    // 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 | 

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

Parameters

Name Type Description Notes
id int

Return type

string

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]

rmaTrackManagementV1GetTracksGet

\Krak\MagentoApiClient\Model\RmaDataTrackSearchResultInterface rmaTrackManagementV1GetTracksGet($id)

Get track list

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\RmaTrackManagementV1Api(
    // 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 | 

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

Parameters

Name Type Description Notes
id int

Return type

\Krak\MagentoApiClient\Model\RmaDataTrackSearchResultInterface

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]

rmaTrackManagementV1RemoveTrackByIdDelete

bool rmaTrackManagementV1RemoveTrackByIdDelete($id, $trackId)

Remove track by id

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\RmaTrackManagementV1Api(
    // 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 | 
$trackId = 56; // int | 

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

Parameters

Name Type Description Notes
id int
trackId int

Return type

bool

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]