Conekta\OrdersApi

All URIs are relative to https://api.conekta.io, except if the operation defines another base path.

Method	HTTP request	Description
cancelOrder()	POST /orders/{id}/cancel	Cancel Order
createOrder()	POST /orders	Create order
getOrderById()	GET /orders/{id}	Get Order
getOrders()	GET /orders	Get a list of Orders
orderCancelRefund()	DELETE /orders/{id}/refunds/{refund_id}	Cancel Refund
orderRefund()	POST /orders/{id}/refunds	Refund Order
ordersCreateCapture()	POST /orders/{id}/capture	Capture Order
updateOrder()	PUT /orders/{id}	Update Order

`cancelOrder()`

cancelOrder($id, $accept_language, $x_child_company_id): \Conekta\Model\OrderResponse

Cancel Order

Cancel an order that has been previously created.

Example

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


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\OrdersApi(
    // 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 = 6307a60c41de27127515a575; // string | Identifier of the resource
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.

try {
    $result = $apiInstance->cancelOrder($id, $accept_language, $x_child_company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->cancelOrder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

\Conekta\Model\OrderResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.conekta-v2.1.0+json

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

`createOrder()`

createOrder($order_request, $accept_language, $x_child_company_id): \Conekta\Model\OrderResponse

Create order

Create a new order.

Example

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


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\OrdersApi(
    // 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_request = new \Conekta\Model\OrderRequest(); // \Conekta\Model\OrderRequest | requested field for order
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.

try {
    $result = $apiInstance->createOrder($order_request, $accept_language, $x_child_company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->createOrder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
order_request	\Conekta\Model\OrderRequest	requested field for order
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

\Conekta\Model\OrderResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/vnd.conekta-v2.1.0+json

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

`getOrderById()`

getOrderById($id, $accept_language, $x_child_company_id): \Conekta\Model\OrderResponse

Get Order

Info for a specific order

Example

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


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\OrdersApi(
    // 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 = 6307a60c41de27127515a575; // string | Identifier of the resource
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.

try {
    $result = $apiInstance->getOrderById($id, $accept_language, $x_child_company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->getOrderById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

\Conekta\Model\OrderResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.conekta-v2.1.0+json

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

`getOrders()`

getOrders($accept_language, $x_child_company_id, $limit, $search, $next, $previous, $payment_status, $last_payment_info_status, $created_at, $created_at_gte, $created_at_lte, $updated_at_gte, $updated_at_lte): \Conekta\Model\GetOrdersResponse

Get a list of Orders

Get order details in the form of a list

Example

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


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\OrdersApi(
    // 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
);
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.
$limit = 20; // int | The numbers of items to return, the maximum value is 250
$search = 'search_example'; // string | General order search, e.g. by mail, reference etc.
$next = 'next_example'; // string | next page
$previous = 'previous_example'; // string | previous page
$payment_status = paid; // string | Filters by order status
$last_payment_info_status = pending_payment; // string | Filters by last payment info status
$created_at = 1612137600; // int | created equal to
$created_at_gte = 1612137600; // int | created at greater than or equal to
$created_at_lte = 1612137600; // int | created at less than or equal to
$updated_at_gte = 1612137600; // int | updated at greater than or equal to
$updated_at_lte = 1612137600; // int | updated at less than or equal to

try {
    $result = $apiInstance->getOrders($accept_language, $x_child_company_id, $limit, $search, $next, $previous, $payment_status, $last_payment_info_status, $created_at, $created_at_gte, $created_at_lte, $updated_at_gte, $updated_at_lte);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->getOrders: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]
limit	int	The numbers of items to return, the maximum value is 250	[optional] [default to 20]
search	string	General order search, e.g. by mail, reference etc.	[optional]
next	string	next page	[optional]
previous	string	previous page	[optional]
payment_status	string	Filters by order status	[optional]
last_payment_info_status	string	Filters by last payment info status	[optional]
created_at	int	created equal to	[optional]
created_at_gte	int	created at greater than or equal to	[optional]
created_at_lte	int	created at less than or equal to	[optional]
updated_at_gte	int	updated at greater than or equal to	[optional]
updated_at_lte	int	updated at less than or equal to	[optional]

Return type

\Conekta\Model\GetOrdersResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.conekta-v2.1.0+json

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

`orderCancelRefund()`

orderCancelRefund($id, $refund_id, $accept_language, $x_child_company_id): \Conekta\Model\OrderResponse

Cancel Refund

A refunded order describes the items, amount, and reason an order is being refunded.

Example

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


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\OrdersApi(
    // 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 = 6307a60c41de27127515a575; // string | Identifier of the resource
$refund_id = 6407b5bee1329a000175ba11; // string | refund identifier
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.

try {
    $result = $apiInstance->orderCancelRefund($id, $refund_id, $accept_language, $x_child_company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->orderCancelRefund: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
refund_id	string	refund identifier
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

\Conekta\Model\OrderResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.conekta-v2.1.0+json

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

`orderRefund()`

orderRefund($id, $order_refund_request, $accept_language, $x_child_company_id): \Conekta\Model\OrderResponse

Refund Order

A refunded order describes the items, amount, and reason an order is being refunded.

Example

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


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\OrdersApi(
    // 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 = 6307a60c41de27127515a575; // string | Identifier of the resource
$order_refund_request = new \Conekta\Model\OrderRefundRequest(); // \Conekta\Model\OrderRefundRequest | requested field for a refund
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.

try {
    $result = $apiInstance->orderRefund($id, $order_refund_request, $accept_language, $x_child_company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->orderRefund: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
order_refund_request	\Conekta\Model\OrderRefundRequest	requested field for a refund
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

\Conekta\Model\OrderResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/vnd.conekta-v2.1.0+json

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

`ordersCreateCapture()`

ordersCreateCapture($id, $accept_language, $x_child_company_id, $order_capture_request): \Conekta\Model\OrderResponse

Capture Order

Processes an order that has been previously authorized.

Example

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


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\OrdersApi(
    // 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 = 6307a60c41de27127515a575; // string | Identifier of the resource
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.
$order_capture_request = new \Conekta\Model\OrderCaptureRequest(); // \Conekta\Model\OrderCaptureRequest | requested fields for capture order

try {
    $result = $apiInstance->ordersCreateCapture($id, $accept_language, $x_child_company_id, $order_capture_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->ordersCreateCapture: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]
order_capture_request	\Conekta\Model\OrderCaptureRequest	requested fields for capture order	[optional]

Return type

\Conekta\Model\OrderResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/vnd.conekta-v2.1.0+json

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

`updateOrder()`

updateOrder($id, $order_update_request, $accept_language): \Conekta\Model\OrderResponse

Update Order

Update an existing Order.

Example

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


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\OrdersApi(
    // 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 = 6307a60c41de27127515a575; // string | Identifier of the resource
$order_update_request = new \Conekta\Model\OrderUpdateRequest(); // \Conekta\Model\OrderUpdateRequest | requested field for an order
$accept_language = es; // string | Use for knowing which language to use

try {
    $result = $apiInstance->updateOrder($id, $order_update_request, $accept_language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->updateOrder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
order_update_request	\Conekta\Model\OrderUpdateRequest	requested field for an order
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']

Return type

\Conekta\Model\OrderResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/vnd.conekta-v2.1.0+json

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

Files

OrdersApi.md

Latest commit

History

OrdersApi.md

File metadata and controls

Conekta\OrdersApi

cancelOrder()

Example

Parameters

Return type

Authorization

HTTP request headers

createOrder()

Example

Parameters

Return type

Authorization

HTTP request headers

getOrderById()

Example

Parameters

Return type

Authorization

HTTP request headers

getOrders()

Example

Parameters

Return type

Authorization

HTTP request headers

orderCancelRefund()

Example

Parameters

Return type

Authorization

HTTP request headers

orderRefund()

Example

Parameters

Return type

Authorization

HTTP request headers

ordersCreateCapture()

Example

Parameters

Return type

Authorization

HTTP request headers

updateOrder()

Example

Parameters

Return type

Authorization

HTTP request headers

`cancelOrder()`

`createOrder()`

`getOrderById()`

`getOrders()`

`orderCancelRefund()`

`orderRefund()`

`ordersCreateCapture()`

`updateOrder()`