Struct google_content2::api::Order
source · pub struct Order {Show 22 fields
pub acknowledged: Option<bool>,
pub channel_type: Option<String>,
pub customer: Option<OrderCustomer>,
pub delivery_details: Option<OrderDeliveryDetails>,
pub id: Option<String>,
pub kind: Option<String>,
pub line_items: Option<Vec<OrderLineItem>>,
pub merchant_id: Option<u64>,
pub merchant_order_id: Option<String>,
pub net_amount: Option<Price>,
pub payment_method: Option<OrderPaymentMethod>,
pub payment_status: Option<String>,
pub pickup_details: Option<OrderPickupDetails>,
pub placed_date: Option<String>,
pub promotions: Option<Vec<OrderLegacyPromotion>>,
pub refunds: Option<Vec<OrderRefund>>,
pub shipments: Option<Vec<OrderShipment>>,
pub shipping_cost: Option<Price>,
pub shipping_cost_tax: Option<Price>,
pub shipping_option: Option<String>,
pub status: Option<String>,
pub tax_collector: Option<String>,
}Expand description
Order. Production access (all methods) requires the order manager role. Sandbox access does not.
§Activities
This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).
- acknowledge orders (none)
- advancetestorder orders (none)
- cancel orders (none)
- cancellineitem orders (none)
- canceltestorderbycustomer orders (none)
- createtestorder orders (none)
- createtestreturn orders (none)
- custombatch orders (none)
- get orders (response)
- getbymerchantorderid orders (none)
- gettestordertemplate orders (none)
- instorerefundlineitem orders (none)
- list orders (none)
- refund orders (none)
- rejectreturnlineitem orders (none)
- returnlineitem orders (none)
- returnrefundlineitem orders (none)
- setlineitemmetadata orders (none)
- shiplineitems orders (none)
- updatelineitemshippingdetails orders (none)
- updatemerchantorderid orders (none)
- updateshipment orders (none)
Fields§
§acknowledged: Option<bool>Whether the order was acknowledged.
channel_type: Option<String>Deprecated. Acceptable values are: - “googleExpress” - “purchasesOnGoogle”
customer: Option<OrderCustomer>The details of the customer who placed the order.
delivery_details: Option<OrderDeliveryDetails>Delivery details for shipments of type delivery.
id: Option<String>The REST ID of the order. Globally unique.
kind: Option<String>Identifies what kind of resource this is. Value: the fixed string “content#order”
line_items: Option<Vec<OrderLineItem>>Line items that are ordered.
merchant_id: Option<u64>no description provided
merchant_order_id: Option<String>Merchant-provided ID of the order.
net_amount: Option<Price>The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
payment_method: Option<OrderPaymentMethod>The details of the payment method.
payment_status: Option<String>The status of the payment. Acceptable values are: - “paymentCaptured” - “paymentRejected” - “paymentSecured” - “pendingAuthorization”
pickup_details: Option<OrderPickupDetails>Pickup details for shipments of type pickup.
placed_date: Option<String>The date when the order was placed, in ISO 8601 format.
promotions: Option<Vec<OrderLegacyPromotion>>The details of the merchant provided promotions applied to the order. To determine which promotions apply to which products, check the Promotions[].Benefits[].OfferIds field against the LineItems[].Product.OfferId field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId. Examples: 1. To calculate the line item level discount for a single specific item: For each promotion, subtract the Promotions[].Benefits[].Discount.value amount from the LineItems[].Price.value. 2. To calculate the line item level discount for multiple quantity of a specific item: For each promotion, divide the Promotions[].Benefits[].Discount.value by the quantity of products and substract it from LineItems[].Product.Price.value for each quantity item. Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. More details about the program are here.
refunds: Option<Vec<OrderRefund>>Refunds for the order.
shipments: Option<Vec<OrderShipment>>Shipments of the order.
shipping_cost: Option<Price>The total cost of shipping for all items.
shipping_cost_tax: Option<Price>The tax for the total shipping cost.
shipping_option: Option<String>Deprecated. Shipping details are provided with line items instead. Acceptable values are: - “economy” - “expedited” - “oneDay” - “sameDay” - “standard” - “twoDay”
status: Option<String>The status of the order. Acceptable values are: - “canceled” - “delivered” - “inProgress” - “partiallyDelivered” - “partiallyReturned” - “partiallyShipped” - “pendingShipment” - “returned” - “shipped”
tax_collector: Option<String>The party responsible for collecting and remitting taxes. Acceptable values are: - “marketplaceFacilitator” - “merchant”