Automattic\WooCommerce\Internal\RestApi\Routes\V4\Orders\Schema

OrderCouponSchema::get_item_responsepublicWC 1.0

Get an item response.

Method of the class: OrderCouponSchema{}

No Hooks.

Returns

Array.

Usage

$OrderCouponSchema = new OrderCouponSchema();
$OrderCouponSchema->get_item_response( $order_item, $request, $include_fields ): array;
$order_item(WC_Order_Item_Coupon) (required)
Order item instance.
$request(WP_REST_Request) (required)
Request object.
$include_fields(array)
Fields to include in the response.
Default: array()

OrderCouponSchema::get_item_response() code WC 10.8.1

public function get_item_response( $order_item, WP_REST_Request $request, array $include_fields = array() ): array {
	$dp     = is_null( $request['num_decimals'] ) ? wc_get_price_decimals() : absint( $request['num_decimals'] );
	$coupon = WC_Coupon::from_order_item( $order_item );

	return array(
		'id'             => $order_item->get_id(),
		'code'           => $order_item->get_code(),
		'discount'       => wc_format_decimal( $order_item->get_discount(), $dp ),
		'discount_tax'   => wc_format_decimal( $order_item->get_discount_tax(), $dp ),
		'discount_type'  => $coupon->get_discount_type(),
		'nominal_amount' => (float) $coupon->get_amount(),
		'free_shipping'  => $coupon->get_free_shipping(),
		'meta_data'      => $this->prepare_meta_data( $order_item ),
	);
}