Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 1.73 KB

BatchApi.md

File metadata and controls

58 lines (38 loc) · 1.73 KB
Raw

\VoloCommerce\Api\v1\BatchApi

All URIs are relative to https://api.volocommerce.io/1.0

Method HTTP request Description
getBatchStatus GET /batch/status/{batchId} Returns status of a given batch. The batch ID is provided by the asynchronous methods

getBatchStatus

\VoloCommerce\Api\v1\Model\BatchStatusResponse getBatchStatus($batch_id, $authorization, $x_api_key)

Returns status of a given batch. The batch ID is provided by the asynchronous methods

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\BatchApi();
$batch_id = "batch_id_example"; // string | Batch ID
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key

try {
    $result = $api_instance->getBatchStatus($batch_id, $authorization, $x_api_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BatchApi->getBatchStatus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
batch_id string Batch ID
authorization string Auth token
x_api_key string API Key

Return type

\VoloCommerce\Api\v1\Model\BatchStatusResponse

Authorization

No authorization required

HTTP request headers

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

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