OrdersResource class

Constructors

OrdersResource(ApiRequester client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

acknowledge(OrdersAcknowledgeRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersAcknowledgeResponse>

Marks an order as acknowledged.

advancetestorder(String merchantId, String orderId, {String? $fields}) → Future<OrdersAdvanceTestOrderResponse>

Sandbox only.

cancel(OrdersCancelRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersCancelResponse>

Cancels all line items in an order, making a full refund.

cancellineitem(OrdersCancelLineItemRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersCancelLineItemResponse>

Cancels a line item, making a full refund.

canceltestorderbycustomer(OrdersCancelTestOrderByCustomerRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersCancelTestOrderByCustomerResponse>

Sandbox only.

captureOrder(CaptureOrderRequest request, String merchantId, String orderId, {String? $fields}) → Future<CaptureOrderResponse>

Capture funds from the customer for the current order total.

createtestorder(OrdersCreateTestOrderRequest request, String merchantId, {String? $fields}) → Future<OrdersCreateTestOrderResponse>

Sandbox only.

createtestreturn(OrdersCreateTestReturnRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersCreateTestReturnResponse>

Sandbox only.

get(String merchantId, String orderId, {String? $fields}) → Future<Order>

Retrieves an order from your Merchant Center account.

getbymerchantorderid(String merchantId, String merchantOrderId, {String? $fields}) → Future<OrdersGetByMerchantOrderIdResponse>

Retrieves an order using merchant order ID.

gettestordertemplate(String merchantId, String templateName, {String? country, String? $fields}) → Future<OrdersGetTestOrderTemplateResponse>

Sandbox only.

instorerefundlineitem(OrdersInStoreRefundLineItemRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersInStoreRefundLineItemResponse>

Notifies that item return and refund was handled directly by merchant outside of Google payments processing (for example, cash refund done in store).

list(String merchantId, {bool? acknowledged, int? maxResults, String? orderBy, String? pageToken, String? placedDateEnd, String? placedDateStart, List<String>? statuses, String? $fields}) → Future<OrdersListResponse>

Lists the orders in your Merchant Center account.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

refunditem(OrdersRefundItemRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersRefundItemResponse>

Issues a partial or total refund for items and shipment.

refundorder(OrdersRefundOrderRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersRefundOrderResponse>

Issues a partial or total refund for an order.

rejectreturnlineitem(OrdersRejectReturnLineItemRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersRejectReturnLineItemResponse>

Rejects return on an line item.

returnrefundlineitem(OrdersReturnRefundLineItemRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersReturnRefundLineItemResponse>

Returns and refunds a line item.

setlineitemmetadata(OrdersSetLineItemMetadataRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersSetLineItemMetadataResponse>

Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs.

shiplineitems(OrdersShipLineItemsRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersShipLineItemsResponse>

Marks line item(s) as shipped.

toString() → String

A string representation of this object.

inherited

updatelineitemshippingdetails(OrdersUpdateLineItemShippingDetailsRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersUpdateLineItemShippingDetailsResponse>

Updates ship by and delivery by dates for a line item.

updatemerchantorderid(OrdersUpdateMerchantOrderIdRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersUpdateMerchantOrderIdResponse>

Updates the merchant order ID for a given order.

updateshipment(OrdersUpdateShipmentRequest request, String merchantId, String orderId, {String? $fields}) → Future<OrdersUpdateShipmentResponse>

Updates a shipment's status, carrier, and/or tracking ID.

Operators

operator ==(Object other) → bool

The equality operator.

inherited