\VoloCommerce\Api\v1\SalesOrdersApi

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

Method	HTTP request	Description
addOrderHistories	PUT /salesOrders/histories	Add history entries/notes to sales orders
addOrderItem	POST /salesOrders/{espOrderNo}/orderItems	Add Order Items for sales order
deleteOrderItems	DELETE /salesOrders/{espOrderNo}/orderItems/{orderItemId}	Deletes order items from order
getAmazonRefundReasons	GET /salesOrders/amazon/refund/reasons	Returns a list of Amazon refund reasons
getOrderCredits	GET /salesOrders/credits	Returns array of order credits
getOrderHistories	GET /salesOrders/histories	Returns order histories for given order numbers
getOrderStatuses	GET /salesOrders/statuses	Returns List of all Sales Order Statuses
getOrders	GET /salesOrders	Returns a list of orders
getSalesOrderFlags	GET /salesOrders/flags/{flagType}	Returns List Sales order flags
getSellerIds	GET /salesOrders/sellers	Returns a list of seller ids
getStockActions	GET /salesOrders/refund/stockActions	Returns stock actions to process refunds
issueRefund	POST /salesOrders/{espOrderNo}/refund	Issue Refund
saveOrders	POST /salesOrders	Create orders within Volo
savePayment	POST /salesOrders/{espOrderNo}/payments	Payment details for SalesOrder within Volo
updateOrderItems	PUT /salesOrders/{espOrderNo}/orderItems	Update to an order Item
updateOrders	PUT /salesOrders	Update order details
updateOrdersAsync	PUT /salesOrders/async	Updates order details
updateSalesOrderPayment	PUT /salesOrders/{espOrderNo}/payments/{paymentId}	Update payment details of sales order

addOrderHistories

\VoloCommerce\Api\v1\Model\MessageResponse addOrderHistories($authorization, $x_api_key, $body)

Add history entries/notes to sales orders

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key
$body = new \VoloCommerce\Api\v1\Model\OrderHistories(); // \VoloCommerce\Api\v1\Model\OrderHistories | 

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

Parameters

Name	Type	Description	Notes
authorization	string	Auth token
x_api_key	string	API Key
body	\VoloCommerce\Api\v1\Model\OrderHistories		[optional]

Return type

\VoloCommerce\Api\v1\Model\MessageResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json

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

addOrderItem

\VoloCommerce\Api\v1\Model\AddOrderItemResponse addOrderItem($esp_order_no, $authorization, $x_api_key, $body)

Add Order Items for sales order

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$esp_order_no = 56; // int | EspOrderNo
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key
$body = new \VoloCommerce\Api\v1\Model\AddSalesOrderItemsRequest(); // \VoloCommerce\Api\v1\Model\AddSalesOrderItemsRequest | Add Sales OrderItem

try {
    $result = $api_instance->addOrderItem($esp_order_no, $authorization, $x_api_key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesOrdersApi->addOrderItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
esp_order_no	int	EspOrderNo
authorization	string	Auth token
x_api_key	string	API Key
body	\VoloCommerce\Api\v1\Model\AddSalesOrderItemsRequest	Add Sales OrderItem	[optional]

Return type

\VoloCommerce\Api\v1\Model\AddOrderItemResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json

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

deleteOrderItems

\VoloCommerce\Api\v1\Model\DeleteOrderItemsResponse deleteOrderItems($esp_order_no, $order_item_id, $authorization, $x_api_key)

Deletes order items from order

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$esp_order_no = 56; // int | EspOrderNo to fetch relevant Order
$order_item_id = 56; // int | orderItemId to fetch relevant item
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key

try {
    $result = $api_instance->deleteOrderItems($esp_order_no, $order_item_id, $authorization, $x_api_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesOrdersApi->deleteOrderItems: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
esp_order_no	int	EspOrderNo to fetch relevant Order
order_item_id	int	orderItemId to fetch relevant item
authorization	string	Auth token
x_api_key	string	API Key

Return type

\VoloCommerce\Api\v1\Model\DeleteOrderItemsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json

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

getAmazonRefundReasons

\VoloCommerce\Api\v1\Model\AmazonRefundReasonResponse getAmazonRefundReasons($authorization, $x_api_key)

Returns a list of Amazon refund reasons

Example

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

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

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

Parameters

Name	Type	Description	Notes
authorization	string	Auth token
x_api_key	string	API Key

Return type

\VoloCommerce\Api\v1\Model\AmazonRefundReasonResponse

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]

getOrderCredits

\VoloCommerce\Api\v1\Model\OrderCreditResponse getOrderCredits($authorization, $x_api_key, $start_date, $end_date)

Returns array of order credits

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Start date for comparison by using order creation date
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | End date for comparison by using order creation date

try {
    $result = $api_instance->getOrderCredits($authorization, $x_api_key, $start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesOrdersApi->getOrderCredits: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Auth token
x_api_key	string	API Key
start_date	\DateTime	Start date for comparison by using order creation date	[optional]
end_date	\DateTime	End date for comparison by using order creation date	[optional]

Return type

\VoloCommerce\Api\v1\Model\OrderCreditResponse

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]

getOrderHistories

\VoloCommerce\Api\v1\Model\OrderHistoryResponse getOrderHistories($authorization, $x_api_key, $esp_order_no)

Returns order histories for given order numbers

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key
$esp_order_no = array(56); // int[] | 

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

Parameters

Name	Type	Description	Notes
authorization	string	Auth token
x_api_key	string	API Key
esp_order_no	int[]		[optional]

Return type

\VoloCommerce\Api\v1\Model\OrderHistoryResponse

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]

getOrderStatuses

\VoloCommerce\Api\v1\Model\OrderStatusResponse getOrderStatuses($authorization, $x_api_key)

Returns List of all Sales Order Statuses

Example

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

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

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

Parameters

Name	Type	Description	Notes
authorization	string	Auth token
x_api_key	string	API Key

Return type

\VoloCommerce\Api\v1\Model\OrderStatusResponse

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]

getOrders

\VoloCommerce\Api\v1\Model\OrdersResponse getOrders($authorization, $x_api_key, $start_date, $end_date, $order_source, $seller_id, $paid, $entries_per_page, $page_number, $customer_email, $include_credits, $start_modified_date, $end_modified_date, $esp_order_no, $order_status, $flag1, $flag2, $courier_name, $fulfilment_type, $trade_sale, $supplier_id, $paid_status, $picked, $posted_batch_id, $back_order, $external_order_reference, $invoice_number, $stock_number, $courier_service, $currency_code)

Returns a list of orders

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Start date for comparison by using order creation date
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | End date for comparison by using order creation date
$order_source = "order_source_example"; // string | Source of the order
$seller_id = 56; // int | Indicates sellerId of the order
$paid = true; // bool | Flag indicates the orders is paid or not
$entries_per_page = 56; // int | No of records in a page to be retrieved
$page_number = 56; // int | The Page number for pagination
$customer_email = "customer_email_example"; // string | Customer Email
$include_credits = true; // bool | Include Credits?
$start_modified_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Start date for comparison by using order update date
$end_modified_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | End date for comparison by using order update date
$esp_order_no = 56; // int | ESP Order Number
$order_status = "order_status_example"; // string | Indicates status of the order
$flag1 = "flag1_example"; // string | Order flag type 1
$flag2 = "flag2_example"; // string | Order flag type 2
$courier_name = "courier_name_example"; // string | Order Courier Name
$fulfilment_type = "fulfilment_type_example"; // string | Fulfilment Type: Valid values : \"MERCHANT\" OR \"AMAZON_FBA\"
$trade_sale = true; // bool | isTradeSale?
$supplier_id = 56; // int | Supplier ID
$paid_status = "paid_status_example"; // string | Paid status
$picked = true; // bool | Indicates picked status
$posted_batch_id = 56; // int | Payment postedBatch Id
$back_order = true; // bool | Indicates Back Order status
$external_order_reference = "external_order_reference_example"; // string | External Order Reference
$invoice_number = "invoice_number_example"; // string | Invoice Number
$stock_number = "stock_number_example"; // string | Stock Number
$courier_service = "courier_service_example"; // string | Courier Service
$currency_code = "currency_code_example"; // string | Currency Code

try {
    $result = $api_instance->getOrders($authorization, $x_api_key, $start_date, $end_date, $order_source, $seller_id, $paid, $entries_per_page, $page_number, $customer_email, $include_credits, $start_modified_date, $end_modified_date, $esp_order_no, $order_status, $flag1, $flag2, $courier_name, $fulfilment_type, $trade_sale, $supplier_id, $paid_status, $picked, $posted_batch_id, $back_order, $external_order_reference, $invoice_number, $stock_number, $courier_service, $currency_code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesOrdersApi->getOrders: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Auth token
x_api_key	string	API Key
start_date	\DateTime	Start date for comparison by using order creation date	[optional]
end_date	\DateTime	End date for comparison by using order creation date	[optional]
order_source	string	Source of the order	[optional]
seller_id	int	Indicates sellerId of the order	[optional]
paid	bool	Flag indicates the orders is paid or not	[optional]
entries_per_page	int	No of records in a page to be retrieved	[optional]
page_number	int	The Page number for pagination	[optional]
customer_email	string	Customer Email	[optional]
include_credits	bool	Include Credits?	[optional]
start_modified_date	\DateTime	Start date for comparison by using order update date	[optional]
end_modified_date	\DateTime	End date for comparison by using order update date	[optional]
esp_order_no	int	ESP Order Number	[optional]
order_status	string	Indicates status of the order	[optional]
flag1	string	Order flag type 1	[optional]
flag2	string	Order flag type 2	[optional]
courier_name	string	Order Courier Name	[optional]
fulfilment_type	string	Fulfilment Type: Valid values : "MERCHANT" OR "AMAZON_FBA"	[optional]
trade_sale	bool	isTradeSale?	[optional]
supplier_id	int	Supplier ID	[optional]
paid_status	string	Paid status	[optional]
picked	bool	Indicates picked status	[optional]
posted_batch_id	int	Payment postedBatch Id	[optional]
back_order	bool	Indicates Back Order status	[optional]
external_order_reference	string	External Order Reference	[optional]
invoice_number	string	Invoice Number	[optional]
stock_number	string	Stock Number	[optional]
courier_service	string	Courier Service	[optional]
currency_code	string	Currency Code	[optional]

Return type

\VoloCommerce\Api\v1\Model\OrdersResponse

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]

getSalesOrderFlags

\VoloCommerce\Api\v1\Model\FlagsResponse getSalesOrderFlags($flag_type, $authorization, $x_api_key)

Returns List Sales order flags

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$flag_type = "flag_type_example"; // string | Flag Type
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key

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

Parameters

Name	Type	Description
flag_type	string	Flag Type
authorization	string	Auth token
x_api_key	string	API Key

Return type

\VoloCommerce\Api\v1\Model\FlagsResponse

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]

getSellerIds

\VoloCommerce\Api\v1\Model\SellerIdResponse getSellerIds($authorization, $x_api_key, $id, $source, $seller_name)

Returns a list of seller ids

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key
$id = 56; // int | Id to fetch relevant sellers
$source = "source_example"; // string | Source - possible values are WWW,Amazon,Ebay,Manual,Marketplace
$seller_name = "seller_name_example"; // string | Seller name to compare and fetch seller details

try {
    $result = $api_instance->getSellerIds($authorization, $x_api_key, $id, $source, $seller_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesOrdersApi->getSellerIds: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Auth token
x_api_key	string	API Key
id	int	Id to fetch relevant sellers	[optional]
source	string	Source - possible values are WWW,Amazon,Ebay,Manual,Marketplace	[optional]
seller_name	string	Seller name to compare and fetch seller details	[optional]

Return type

\VoloCommerce\Api\v1\Model\SellerIdResponse

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]

getStockActions

\VoloCommerce\Api\v1\Model\StockActionsResultBean getStockActions($authorization, $x_api_key)

Returns stock actions to process refunds

Example

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

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

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

Parameters

Name	Type	Description	Notes
authorization	string	Auth token
x_api_key	string	API Key

Return type

\VoloCommerce\Api\v1\Model\StockActionsResultBean

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]

issueRefund

\VoloCommerce\Api\v1\Model\SalesOrdersRefundResponseDTO issueRefund($esp_order_no, $authorization, $x_api_key, $body)

Issue Refund

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$esp_order_no = 56; // int | 
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key
$body = new \VoloCommerce\Api\v1\Model\IssueRefundParams(); // \VoloCommerce\Api\v1\Model\IssueRefundParams | Issue refund params

try {
    $result = $api_instance->issueRefund($esp_order_no, $authorization, $x_api_key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesOrdersApi->issueRefund: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
esp_order_no	int
authorization	string	Auth token
x_api_key	string	API Key
body	\VoloCommerce\Api\v1\Model\IssueRefundParams	Issue refund params	[optional]

Return type

\VoloCommerce\Api\v1\Model\SalesOrdersRefundResponseDTO

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json

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

saveOrders

\VoloCommerce\Api\v1\Model\AddOrderResponse saveOrders($authorization, $x_api_key, $body)

Create orders within Volo

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key
$body = new \VoloCommerce\Api\v1\Model\AddSalesOrdersBean(); // \VoloCommerce\Api\v1\Model\AddSalesOrdersBean | 

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

Parameters

Name	Type	Description	Notes
authorization	string	Auth token
x_api_key	string	API Key
body	\VoloCommerce\Api\v1\Model\AddSalesOrdersBean		[optional]

Return type

\VoloCommerce\Api\v1\Model\AddOrderResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json

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

savePayment

\VoloCommerce\Api\v1\Model\CreateSalesOrderPaymentResponse savePayment($esp_order_no, $authorization, $x_api_key, $body)

Payment details for SalesOrder within Volo

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$esp_order_no = 56; // int | EspOrderNo
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key
$body = new \VoloCommerce\Api\v1\Model\CreateSalesOrderPaymentBean(); // \VoloCommerce\Api\v1\Model\CreateSalesOrderPaymentBean | Payment details for SalesOrder

try {
    $result = $api_instance->savePayment($esp_order_no, $authorization, $x_api_key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesOrdersApi->savePayment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
esp_order_no	int	EspOrderNo
authorization	string	Auth token
x_api_key	string	API Key
body	\VoloCommerce\Api\v1\Model\CreateSalesOrderPaymentBean	Payment details for SalesOrder	[optional]

Return type

\VoloCommerce\Api\v1\Model\CreateSalesOrderPaymentResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json

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

updateOrderItems

\VoloCommerce\Api\v1\Model\UpdateOrderItemsResponse updateOrderItems($esp_order_no, $authorization, $x_api_key, $body)

Update to an order Item

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$esp_order_no = 56; // int | EspOrderNo to fetch relevant Order
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key
$body = new \VoloCommerce\Api\v1\Model\ItemUpdateInputList(); // \VoloCommerce\Api\v1\Model\ItemUpdateInputList | list of updated items

try {
    $result = $api_instance->updateOrderItems($esp_order_no, $authorization, $x_api_key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesOrdersApi->updateOrderItems: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
esp_order_no	int	EspOrderNo to fetch relevant Order
authorization	string	Auth token
x_api_key	string	API Key
body	\VoloCommerce\Api\v1\Model\ItemUpdateInputList	list of updated items	[optional]

Return type

\VoloCommerce\Api\v1\Model\UpdateOrderItemsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json

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

updateOrders

\VoloCommerce\Api\v1\Model\MessageResponse updateOrders($authorization, $x_api_key, $body)

Update order details

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key
$body = new \VoloCommerce\Api\v1\Model\UpdateSalesOrdersBean(); // \VoloCommerce\Api\v1\Model\UpdateSalesOrdersBean | 

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

Parameters

Name	Type	Description	Notes
authorization	string	Auth token
x_api_key	string	API Key
body	\VoloCommerce\Api\v1\Model\UpdateSalesOrdersBean		[optional]

Return type

\VoloCommerce\Api\v1\Model\MessageResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json

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

updateOrdersAsync

\VoloCommerce\Api\v1\Model\UpdateAsyncResponse updateOrdersAsync($authorization, $x_api_key, $body)

Updates order details

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key
$body = new \VoloCommerce\Api\v1\Model\UpdateSalesOrderAsyncBean(); // \VoloCommerce\Api\v1\Model\UpdateSalesOrderAsyncBean | List of IncomingOrdersUpdate to update

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

Parameters

Name	Type	Description	Notes
authorization	string	Auth token
x_api_key	string	API Key
body	\VoloCommerce\Api\v1\Model\UpdateSalesOrderAsyncBean	List of IncomingOrdersUpdate to update	[optional]

Return type

\VoloCommerce\Api\v1\Model\UpdateAsyncResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json

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

updateSalesOrderPayment

\VoloCommerce\Api\v1\Model\UpdateSalesOrderPaymentResponse updateSalesOrderPayment($esp_order_no, $payment_id, $authorization, $x_api_key, $body)

Update payment details of sales order

Example

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

$api_instance = new \VoloCommerce\Api\v1\Client\SalesOrdersApi();
$esp_order_no = 56; // int | EspOrderNo
$payment_id = 56; // int | Id of PaymentTransactions
$authorization = "authorization_example"; // string | Auth token
$x_api_key = "x_api_key_example"; // string | API Key
$body = new \VoloCommerce\Api\v1\Model\UpdateSalesOrderPaymentRequest(); // \VoloCommerce\Api\v1\Model\UpdateSalesOrderPaymentRequest | Update payment detail of salesorder

try {
    $result = $api_instance->updateSalesOrderPayment($esp_order_no, $payment_id, $authorization, $x_api_key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesOrdersApi->updateSalesOrderPayment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
esp_order_no	int	EspOrderNo
payment_id	int	Id of PaymentTransactions
authorization	string	Auth token
x_api_key	string	API Key
body	\VoloCommerce\Api\v1\Model\UpdateSalesOrderPaymentRequest	Update payment detail of salesorder	[optional]

Return type

\VoloCommerce\Api\v1\Model\UpdateSalesOrderPaymentResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json

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

Files

SalesOrdersApi.md

Latest commit

History

SalesOrdersApi.md

File metadata and controls

\VoloCommerce\Api\v1\SalesOrdersApi

addOrderHistories

Example

Parameters

Return type

Authorization

HTTP request headers

addOrderItem

Example

Parameters

Return type

Authorization

HTTP request headers

deleteOrderItems

Example

Parameters

Return type

Authorization

HTTP request headers

getAmazonRefundReasons

Example

Parameters

Return type

Authorization

HTTP request headers

getOrderCredits

Example

Parameters

Return type

Authorization

HTTP request headers

getOrderHistories

Example

Parameters

Return type

Authorization

HTTP request headers

getOrderStatuses

Example

Parameters

Return type

Authorization

HTTP request headers

getOrders

Example

Parameters

Return type

Authorization

HTTP request headers

getSalesOrderFlags

Example

Parameters

Return type

Authorization

HTTP request headers

getSellerIds

Example

Parameters

Return type

Authorization

HTTP request headers

getStockActions

Example

Parameters

Return type

Authorization

HTTP request headers

issueRefund

Example

Parameters

Return type

Authorization

HTTP request headers

saveOrders