OpenAPI\Client\ReturnApi

All URIs are relative to https://api.api2cart.com/v1.1, except if the operation defines another base path.

Method	HTTP request	Description
returnActionList()	GET /return.action.list.json	return.action.list
returnCount()	GET /return.count.json	return.count
returnInfo()	GET /return.info.json	return.info
returnList()	GET /return.list.json	return.list
returnReasonList()	GET /return.reason.list.json	return.reason.list
returnStatusList()	GET /return.status.list.json	return.status.list

`returnActionList()`

returnActionList(): \OpenAPI\Client\Model\ReturnActionList200Response

return.action.list

Retrieve list of return actions

Example

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


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ReturnApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\ReturnActionList200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`returnCount()`

returnCount($order_ids, $customer_id, $store_id, $status, $return_type, $created_from, $created_to, $modified_from, $modified_to, $report_request_id, $disable_report_cache): \OpenAPI\Client\Model\ReturnCount200Response

return.count

Count returns in store

Example

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


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ReturnApi(
    // 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
);
$order_ids = 24,25; // string | Counts return requests specified by order ids
$customer_id = 5; // string | Counts return requests quantity specified by customer id
$store_id = 1; // string | Store Id
$status = disabled; // string | Defines status
$return_type = FBA; // string | Retrieves returns specified by return type
$created_from = 2010-07-29 13:45:52; // string | Retrieve entities from their creation date
$created_to = 2100-08-29 13:45:52; // string | Retrieve entities to their creation date
$modified_from = 2010-07-29 13:45:52; // string | Retrieve entities from their modification date
$modified_to = 2100-08-29 13:45:52; // string | Retrieve entities to their modification date
$report_request_id = 105245017661; // string | Report request id
$disable_report_cache = false; // bool | Disable report cache for current request

try {
    $result = $apiInstance->returnCount($order_ids, $customer_id, $store_id, $status, $return_type, $created_from, $created_to, $modified_from, $modified_to, $report_request_id, $disable_report_cache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnApi->returnCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
order_ids	string	Counts return requests specified by order ids	[optional]
customer_id	string	Counts return requests quantity specified by customer id	[optional]
store_id	string	Store Id	[optional]
status	string	Defines status	[optional]
return_type	string	Retrieves returns specified by return type	[optional]
created_from	string	Retrieve entities from their creation date	[optional]
created_to	string	Retrieve entities to their creation date	[optional]
modified_from	string	Retrieve entities from their modification date	[optional]
modified_to	string	Retrieve entities to their modification date	[optional]
report_request_id	string	Report request id	[optional]
disable_report_cache	bool	Disable report cache for current request	[optional] [default to false]

Return type

\OpenAPI\Client\Model\ReturnCount200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`returnInfo()`

returnInfo($id, $order_id, $store_id, $response_fields, $params, $exclude): \OpenAPI\Client\Model\ReturnInfo200Response

return.info

Retrieve return information.

Example

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


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ReturnApi(
    // 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 = 10; // string | Entity id
$order_id = 25; // string | Defines the order id
$store_id = 1; // string | Store Id
$response_fields = {return_code,return_message,result}; // string | Set this parameter in order to choose which entity fields you want to retrieve
$params = id,order_products; // string | Set this parameter in order to choose which entity fields you want to retrieve
$exclude = id,order_id; // string | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all

try {
    $result = $apiInstance->returnInfo($id, $order_id, $store_id, $response_fields, $params, $exclude);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnApi->returnInfo: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Entity id
order_id	string	Defines the order id	[optional]
store_id	string	Store Id	[optional]
response_fields	string	Set this parameter in order to choose which entity fields you want to retrieve	[optional]
params	string	Set this parameter in order to choose which entity fields you want to retrieve	[optional] [default to 'id,order_products']
exclude	string	Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all	[optional]

Return type

\OpenAPI\Client\Model\ReturnInfo200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`returnList()`

returnList($start, $count, $page_cursor, $order_id, $order_ids, $customer_id, $store_id, $status, $return_type, $created_from, $created_to, $modified_from, $modified_to, $response_fields, $params, $exclude, $report_request_id, $disable_report_cache): \OpenAPI\Client\Model\ModelResponseReturnList

return.list

Get list of return requests from store.

Example

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


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ReturnApi(
    // 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
);
$start = 0; // int | This parameter sets the number from which you want to get entities
$count = 20; // int | This parameter sets the entity amount that has to be retrieved. Max allowed count=250
$page_cursor = ; // string | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)
$order_id = 25; // string | Defines the order id
$order_ids = 24,25; // string | Retrieves return requests specified by order ids
$customer_id = 5; // string | Retrieves return requests specified by customer id
$store_id = 1; // string | Store Id
$status = disabled; // string | Defines status
$return_type = FBA; // string | Retrieves returns specified by return type
$created_from = 2010-07-29 13:45:52; // string | Retrieve entities from their creation date
$created_to = 2100-08-29 13:45:52; // string | Retrieve entities to their creation date
$modified_from = 2010-07-29 13:45:52; // string | Retrieve entities from their modification date
$modified_to = 2100-08-29 13:45:52; // string | Retrieve entities to their modification date
$response_fields = {return_code,return_message,pagination,result}; // string | Set this parameter in order to choose which entity fields you want to retrieve
$params = id,order_products; // string | Set this parameter in order to choose which entity fields you want to retrieve
$exclude = id,order_id; // string | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all
$report_request_id = 105245017661; // string | Report request id
$disable_report_cache = false; // bool | Disable report cache for current request

try {
    $result = $apiInstance->returnList($start, $count, $page_cursor, $order_id, $order_ids, $customer_id, $store_id, $status, $return_type, $created_from, $created_to, $modified_from, $modified_to, $response_fields, $params, $exclude, $report_request_id, $disable_report_cache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnApi->returnList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
start	int	This parameter sets the number from which you want to get entities	[optional] [default to 0]
count	int	This parameter sets the entity amount that has to be retrieved. Max allowed count=250	[optional] [default to 10]
page_cursor	string	Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)	[optional]
order_id	string	Defines the order id	[optional]
order_ids	string	Retrieves return requests specified by order ids	[optional]
customer_id	string	Retrieves return requests specified by customer id	[optional]
store_id	string	Store Id	[optional]
status	string	Defines status	[optional]
return_type	string	Retrieves returns specified by return type	[optional]
created_from	string	Retrieve entities from their creation date	[optional]
created_to	string	Retrieve entities to their creation date	[optional]
modified_from	string	Retrieve entities from their modification date	[optional]
modified_to	string	Retrieve entities to their modification date	[optional]
response_fields	string	Set this parameter in order to choose which entity fields you want to retrieve	[optional]
params	string	Set this parameter in order to choose which entity fields you want to retrieve	[optional] [default to 'id,order_products']
exclude	string	Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all	[optional]
report_request_id	string	Report request id	[optional]
disable_report_cache	bool	Disable report cache for current request	[optional] [default to false]

Return type

\OpenAPI\Client\Model\ModelResponseReturnList

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`returnReasonList()`

returnReasonList($store_id): \OpenAPI\Client\Model\ReturnReasonList200Response

return.reason.list

Retrieve list of return reasons

Example

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


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ReturnApi(
    // 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
);
$store_id = 1; // string | Store Id

try {
    $result = $apiInstance->returnReasonList($store_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnApi->returnReasonList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
store_id	string	Store Id	[optional]

Return type

\OpenAPI\Client\Model\ReturnReasonList200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`returnStatusList()`

returnStatusList(): \OpenAPI\Client\Model\ReturnStatusList200Response

return.status.list

Retrieve list of statuses

Example

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


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ReturnApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\ReturnStatusList200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Files

ReturnApi.md

Latest commit

History

ReturnApi.md

File metadata and controls

OpenAPI\Client\ReturnApi

returnActionList()

Example

Parameters

Return type

Authorization

HTTP request headers

returnCount()

Example

Parameters

Return type

Authorization

HTTP request headers

returnInfo()

Example

Parameters

Return type

Authorization

HTTP request headers

returnList()

Example

Parameters

Return type

Authorization

HTTP request headers

returnReasonList()

Example

Parameters

Return type

Authorization

HTTP request headers

returnStatusList()

Example

Parameters

Return type

Authorization

HTTP request headers

`returnActionList()`

`returnCount()`

`returnInfo()`

`returnList()`

`returnReasonList()`

`returnStatusList()`