ultracart.OrderApi

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

Method	HTTP request	Description
adjust_order_total	POST /order/orders/{order_id}/adjust_order_total/{desired_total}	Adjusts an order total
cancel_order	POST /order/orders/{order_id}/cancel	Cancel an order
delete_order	DELETE /order/orders/{order_id}	Delete an order
duplicate_order	POST /order/orders/{order_id}/duplicate	Duplicate an order
format	POST /order/orders/{order_id}/format	Format order
generate_invoice	GET /order/orders/{order_id}/invoice	Generate an invoice for this order.
generate_order_token	GET /order/orders/token/{order_id}	Generate an order token for a given order id
generate_packing_slip_all_dc	GET /order/orders/{order_id}/packing_slip	Generate a packing slip for this order across all distribution centers.
generate_packing_slip_specific_dc	GET /order/orders/{order_id}/packing_slip/{distribution_center_code}	Generate a packing slip for this order for the given distribution center.
get_accounts_receivable_retry_config	GET /order/accountsReceivableRetryConfig	Retrieve A/R Retry Configuration
get_accounts_receivable_retry_stats	GET /order/accountsReceivableRetryConfig/stats	Retrieve A/R Retry Statistics
get_order	GET /order/orders/{order_id}	Retrieve an order
get_order_by_token	POST /order/orders/token	Retrieve an order using a token
get_order_edi_documents	GET /order/orders/{order_id}/edi	Retrieve EDI documents associated with this order.
get_orders	GET /order/orders	Retrieve orders
get_orders_batch	POST /order/orders/batch	Retrieve order batch
get_orders_by_query	POST /order/orders/query	Retrieve orders by query
insert_order	POST /order/orders	Insert an order
is_refundable_order	GET /order/orders/{order_id}/refundable	Determine if an order can be refunded
process_payment	POST /order/orders/{order_id}/process_payment	Process payment
refund_order	PUT /order/orders/{order_id}/refund	Refund an order
replacement	POST /order/orders/{order_id}/replacement	Replacement order
resend_receipt	POST /order/orders/{order_id}/resend_receipt	Resend receipt
resend_shipment_confirmation	POST /order/orders/{order_id}/resend_shipment_confirmation	Resend shipment confirmation
update_accounts_receivable_retry_config	POST /order/accountsReceivableRetryConfig	Update A/R Retry Configuration
update_order	PUT /order/orders/{order_id}	Update an order
validate_order	POST /order/validate	Validate

adjust_order_total

BaseResponse adjust_order_total(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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.OrderApi.fromApiKey(simple_key, False, True)

order_id = 'order_id_example' # str | The order id to cancel.
desired_total = 'desired_total_example' # str | The desired total with no formatting. example 123.45

try:
    # Adjusts an order total
    api_response = api_instance.adjust_order_total(order_id, desired_total)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderApi->adjust_order_total: %s\n" % e)

Parameters

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

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

Name	Type	Description	Notes
order_id	str	The order id to format
format_options	OrderFormat	Format options

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

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

Name	Type	Description	Notes
order_by_token_query	OrderByTokenQuery	Order by token query
expand	str	The object expansion to perform on the result. See documentation for examples	[optional]

Name	Type	Description	Notes
order_batch	OrderQueryBatch	Order batch
expand	str	The object expansion to perform on the result.	[optional]

Name	Type	Description	Notes
order_query	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	str	The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]
expand	str	The object expansion to perform on the result.	[optional]

Name	Type	Description	Notes
order	Order	Order to insert
expand	str	The object expansion to perform on the result. See documentation for examples	[optional]

Name	Type	Description	Notes
order_id	str	The order id to process payment on
process_payment_request	OrderProcessPaymentRequest	Process payment parameters

Name	Type	Description	Notes
order	Order	Order to refund
order_id	str	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]
expand	str	The object expansion to perform on the result. See documentation for examples	[optional]

Name	Type	Description	Notes
order_id	str	The order id to generate a replacement for.
replacement	OrderReplacement	Replacement order details

Name	Type	Description	Notes
order	Order	Order to update
order_id	str	The order id to update.
expand	str	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.OrderApi

adjust_order_total

Example

Parameters

Return type

Authorization

HTTP request headers

cancel_order

Example

Parameters

Return type

Authorization

HTTP request headers

delete_order

Example

Parameters

Return type

Authorization

HTTP request headers

duplicate_order

Example

Parameters

Return type

Authorization

HTTP request headers

format

Example

Parameters

Return type

Authorization

HTTP request headers

generate_invoice

Example

Parameters

Return type

Authorization

HTTP request headers

generate_order_token

Example

Parameters

Return type

Authorization

HTTP request headers

generate_packing_slip_all_dc

Example

Parameters

Return type

Authorization

HTTP request headers

generate_packing_slip_specific_dc

Example

Parameters

Return type

Authorization

HTTP request headers

get_accounts_receivable_retry_config

Example

Parameters

Return type

Authorization

HTTP request headers

get_accounts_receivable_retry_stats

Example

Parameters

Return type

Authorization

HTTP request headers

get_order

Example

Parameters

Return type

Authorization

HTTP request headers

get_order_by_token