Merge pull request #1681 from woocommerce/update/1610-order-by-total-…

…sales-in-product-feed-api Free Listings + Paid Ads: Update product feed API to return the bestselling product
woocommerce · Sep 21, 2022 · 046f8fe · 046f8fe
2 parents 694d25d + 7e3caaf
commit 046f8fe
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 11 deletions.
diff --git a/src/API/Site/Controllers/MerchantCenter/ProductFeedController.php b/src/API/Site/Controllers/MerchantCenter/ProductFeedController.php
@@ -87,27 +87,37 @@ protected function get_schema_properties(): array {
 				'items'       => [
 					'type'       => 'object',
 					'properties' => [
-						'id'      => [
+						'id'        => [
 							'type'        => 'numeric',
 							'description' => __( 'Product ID.', 'google-listings-and-ads' ),
 							'context'     => [ 'view' ],
 						],
-						'title'   => [
+						'title'     => [
 							'type'        => 'string',
 							'description' => __( 'Product title.', 'google-listings-and-ads' ),
 							'context'     => [ 'view' ],
 						],
-						'visible' => [
+						'visible'   => [
 							'type'        => 'boolean',
 							'description' => __( 'Whether the product is set to be visible in the Merchant Center', 'google-listings-and-ads' ),
 							'context'     => [ 'view' ],
 						],
-						'status'  => [
+						'status'    => [
 							'type'        => 'string',
 							'description' => __( 'The current sync status of the product.', 'google-listings-and-ads' ),
 							'context'     => [ 'view' ],
 						],
-						'errors'  => [
+						'image_url' => [
+							'type'        => 'string',
+							'description' => __( 'The image url of the product.', 'google-listings-and-ads' ),
+							'context'     => [ 'view' ],
+						],
+						'price'     => [
+							'type'        => 'string',
+							'description' => __( 'The price of the product.', 'google-listings-and-ads' ),
+							'context'     => [ 'view' ],
+						],
+						'errors'    => [
 							'type'        => 'array',
 							'description' => __( 'Errors preventing the product from being synced to the Merchant Center.', 'google-listings-and-ads' ),
 							'context'     => [ 'view' ],

diff --git a/src/Admin/Admin.php b/src/Admin/Admin.php
@@ -129,6 +129,7 @@ protected function get_assets(): array {
 				'enableReports'            => $this->enableReports(),
 				'dateFormat'               => get_option( 'date_format' ),
 				'timeFormat'               => get_option( 'time_format' ),
+				'siteLogoUrl'              => wp_get_attachment_image_url( get_theme_mod( 'custom_logo' ), 'full' ),
 
 			]
 		);

diff --git a/src/DB/ProductFeedQueryHelper.php b/src/DB/ProductFeedQueryHelper.php
@@ -49,6 +49,11 @@ class ProductFeedQueryHelper implements ContainerAwareInterface, Service {
 	 */
 	protected $product_repository;
 
+	/**
+	 * Meta key for total sales.
+	 */
+	protected const META_KEY_TOTAL_SALES = 'total_sales';
+
 	/**
 	 * ProductFeedQueryHelper constructor.
 	 *
@@ -88,11 +93,13 @@ public function get( WP_REST_Request $request ): array {
 			$errors = $product_helper->get_validation_errors( $product );
 
 			$products[ $id ] = [
-				'id'      => $id,
-				'title'   => $product->get_name(),
-				'visible' => $product_helper->get_channel_visibility( $product ) !== ChannelVisibility::DONT_SYNC_AND_SHOW,
-				'status'  => $product_helper->get_mc_status( $product ) ?: $product_helper->get_sync_status( $product ),
-				'errors'  => array_values( $errors ),
+				'id'        => $id,
+				'title'     => $product->get_name(),
+				'visible'   => $product_helper->get_channel_visibility( $product ) !== ChannelVisibility::DONT_SYNC_AND_SHOW,
+				'status'    => $product_helper->get_mc_status( $product ) ?: $product_helper->get_sync_status( $product ),
+				'image_url' => wp_get_attachment_image_url( $product->get_image_id(), 'full' ),
+				'price'     => $product->get_price(),
+				'errors'    => array_values( $errors ),
 			];
 		}
 
@@ -165,8 +172,12 @@ protected function prepare_query_args(): array {
 				$args['meta_key'] = $this->prefix_meta_key( ProductMetaHandler::KEY_MC_STATUS );
 				$args['orderby']  = [ 'meta_value' => $this->get_order() ] + $args['orderby'];
 				break;
+			case 'total_sales':
+				$args['meta_key'] = self::META_KEY_TOTAL_SALES;
+				$args['orderby']  = [ 'meta_value_num' => $this->get_order() ] + $args['orderby'];
+				break;
 			default:
-				throw InvalidValue::not_in_allowed_list( 'orderby', [ 'title', 'id', 'visible', 'status' ] );
+				throw InvalidValue::not_in_allowed_list( 'orderby', [ 'title', 'id', 'visible', 'status', 'total_sales' ] );
 		}
 
 		return $args;