ultracart\v2\OrderApi

All URIs are relative to https://secure.ultracart.com/rest/v2

Method	HTTP request	Description
adjustOrderTotal	POST /order/orders/{order_id}/adjust_order_total/{desired_total}	Adjusts an order total
cancelOrder	POST /order/orders/{order_id}/cancel	Cancel an order
deleteOrder	DELETE /order/orders/{order_id}	Delete an order
duplicateOrder	POST /order/orders/{order_id}/duplicate	Duplicate an order
format	POST /order/orders/{order_id}/format	Format order
generateInvoice	GET /order/orders/{order_id}/invoice	Generate an invoice for this order.
generateOrderToken	GET /order/orders/token/{order_id}	Generate an order token for a given order id
generatePackingSlipAllDC	GET /order/orders/{order_id}/packing_slip	Generate a packing slip for this order across all distribution centers.
generatePackingSlipSpecificDC	GET /order/orders/{order_id}/packing_slip/{distribution_center_code}	Generate a packing slip for this order for the given distribution center.
getAccountsReceivableRetryConfig	GET /order/accountsReceivableRetryConfig	Retrieve A/R Retry Configuration
getAccountsReceivableRetryStats	GET /order/accountsReceivableRetryConfig/stats	Retrieve A/R Retry Statistics
getOrder	GET /order/orders/{order_id}	Retrieve an order
getOrderByToken	POST /order/orders/token	Retrieve an order using a token
getOrderEdiDocuments	GET /order/orders/{order_id}/edi	Retrieve EDI documents associated with this order.
getOrders	GET /order/orders	Retrieve orders
getOrdersBatch	POST /order/orders/batch	Retrieve order batch
getOrdersByQuery	POST /order/orders/query	Retrieve orders by query
insertOrder	POST /order/orders	Insert an order
isRefundableOrder	GET /order/orders/{order_id}/refundable	Determine if an order can be refunded
processPayment	POST /order/orders/{order_id}/process_payment	Process payment
refundOrder	PUT /order/orders/{order_id}/refund	Refund an order
replacement	POST /order/orders/{order_id}/replacement	Replacement order
resendReceipt	POST /order/orders/{order_id}/resend_receipt	Resend receipt
resendShipmentConfirmation	POST /order/orders/{order_id}/resend_shipment_confirmation	Resend shipment confirmation
updateAccountsReceivableRetryConfig	POST /order/accountsReceivableRetryConfig	Update A/R Retry Configuration
updateOrder	PUT /order/orders/{order_id}	Update an order
validateOrder	POST /order/validate	Validate

adjustOrderTotal

\ultracart\v2\models\BaseResponse adjustOrderTotal($order_id, $desired_total)

Adjusts an order total

Adjusts an order total. Adjusts individual items appropriately and considers taxes. Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero. This call will change the order total. It returns true if the desired total is achieved. If the goal seeking algorithm falls short (usually by pennies), this method returns back false. View the merchant notes for the order for further details.

Example

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

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\OrderApi::usingApiKey($simple_key);

$order_id = "order_id_example"; // string | The order id to cancel.
$desired_total = "desired_total_example"; // string | The desired total with no formatting. example 123.45

try {
    $result = $apiInstance->adjustOrderTotal($order_id, $desired_total);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->adjustOrderTotal: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
order_id	string	The order id to cancel.
desired_total	string	The desired total with no formatting. example 123.45

Name	Type	Description	Notes
order_id	string	The order id to duplicate.
_expand	string	The object expansion to perform on the result. See documentation for examples	[optional]

Name	Type	Description	Notes
order_id	string	The order id to format
format_options	\ultracart\v2\models\OrderFormat	Format options

Name	Type	Description	Notes
distribution_center_code	string	Distribution center code
order_id	string	Order ID

Name	Type	Description	Notes
order_id	string	The order id to retrieve.
_expand	string	The object expansion to perform on the result. See documentation for examples	[optional]

Name	Type	Description	Notes
order_by_token_query	\ultracart\v2\models\OrderByTokenQuery	Order by token query
_expand	string	The object expansion to perform on the result. See documentation for examples	[optional]

Name	Type	Description	Notes
order_batch	\ultracart\v2\models\OrderQueryBatch	Order batch
_expand	string	The object expansion to perform on the result.	[optional]

Name	Type	Description	Notes
order_query	\ultracart\v2\models\OrderQuery	Order query
_limit	int	The maximum number of records to return on this one API call. (Maximum 200)	[optional] [default to 100]
_offset	int	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
_sort	string	The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]
_expand	string	The object expansion to perform on the result.	[optional]

Name	Type	Description	Notes
order	\ultracart\v2\models\Order	Order to insert
_expand	string	The object expansion to perform on the result. See documentation for examples	[optional]

Name	Type	Description	Notes
order_id	string	The order id to process payment on
process_payment_request	\ultracart\v2\models\OrderProcessPaymentRequest	Process payment parameters

Name	Type	Description	Notes
order	\ultracart\v2\models\Order	Order to refund
order_id	string	The order id to refund.
reject_after_refund	bool	Reject order after refund	[optional] [default to false]
skip_customer_notification	bool	Skip customer email notification	[optional] [default to false]
auto_order_cancel	bool	Cancel associated auto orders	[optional] [default to false]
manual_refund	bool	Consider a manual refund done externally	[optional] [default to false]
reverse_affiliate_transactions	bool	Reverse affiliate transactions	[optional] [default to true]
issue_store_credit	bool	Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account	[optional] [default to false]
auto_order_cancel_reason	string	Reason for auto orders cancellation	[optional]
_expand	string	The object expansion to perform on the result. See documentation for examples	[optional]

Name	Type	Description	Notes
order_id	string	The order id to generate a replacement for.
replacement	\ultracart\v2\models\OrderReplacement	Replacement order details

Name	Type	Description	Notes
order	\ultracart\v2\models\Order	Order to update
order_id	string	The order id to update.
_expand	string	The object expansion to perform on the result. See documentation for examples	[optional]

Files

OrderApi.md

Latest commit

History

OrderApi.md

File metadata and controls

ultracart\v2\OrderApi

adjustOrderTotal

Example

Parameters

Return type

Authorization

HTTP request headers

cancelOrder

Example

Parameters

Return type

Authorization

HTTP request headers

deleteOrder

Example

Parameters

Return type

Authorization

HTTP request headers

duplicateOrder

Example

Parameters

Return type

Authorization

HTTP request headers

format

Example

Parameters

Return type

Authorization

HTTP request headers

generateInvoice

Example

Parameters

Return type

Authorization

HTTP request headers

generateOrderToken

Example

Parameters

Return type

Authorization

HTTP request headers

generatePackingSlipAllDC

Example

Parameters

Return type

Authorization

HTTP request headers

generatePackingSlipSpecificDC

Example

Parameters

Return type

Authorization

HTTP request headers

getAccountsReceivableRetryConfig

Example

Parameters

Return type

Authorization

HTTP request headers

getAccountsReceivableRetryStats

Example

Parameters

Return type

Authorization

HTTP request headers

getOrder

Example

Parameters

Return type

Authorization

HTTP request headers

getOrderByToken