{"id":319035,"date":"2026-06-18T11:38:51","date_gmt":"2026-06-18T11:38:51","guid":{"rendered":"https:\/\/wordpress.org\/plugins\/api-optimizer-for-woocommerce\/"},"modified":"2026-06-18T11:38:34","modified_gmt":"2026-06-18T11:38:34","slug":"api-optimizer-for-woocommerce","status":"publish","type":"plugin","link":"https:\/\/wordpress.org\/plugins\/api-optimizer-for-woocommerce\/","author":23505390,"comment_status":"closed","ping_status":"closed","template":"","meta":{"version":"1.0.0","stable_tag":"1.0.0","tested":"7.0","requires":"5.8","requires_php":"7.4","requires_plugins":null,"header_name":"ShopMobi \u2013 API Optimizer for WooCommerce","header_author":"ShopMobi","header_description":"Your store deserves a better API. Stop receiving 50+ fields when your app needs 3. GraphQL-like field filtering over REST, plus login and Stripe payments out of the box.","assets_banners_color":"151e31","last_updated":"2026-06-18 11:38:34","external_support_url":"","external_repository_url":"","donate_link":"","header_plugin_uri":"","header_author_uri":"","rating":0,"author_block_rating":0,"active_installs":0,"downloads":45,"num_ratings":0,"support_threads":0,"support_threads_resolved":0,"author_block_count":0,"sections":["description","installation","faq","changelog"],"tags":{"1.0.0":{"tag":"1.0.0","author":"hammadev2","date":"2026-06-18 11:38:34"}},"upgrade_notice":{"1.0.0":"

Initial release \u2014 no upgrade steps required.<\/p>"},"ratings":[],"assets_icons":{"icon-128x128.png":{"filename":"icon-128x128.png","revision":3577108,"resolution":"128x128","location":"assets","locale":"","width":128,"height":128},"icon-256x256.png":{"filename":"icon-256x256.png","revision":3577108,"resolution":"256x256","location":"assets","locale":"","width":256,"height":256}},"assets_banners":{"banner-1544x500.png":{"filename":"banner-1544x500.png","revision":3577108,"resolution":"1544x500","location":"assets","locale":"","width":1544,"height":500},"banner-772x250.png":{"filename":"banner-772x250.png","revision":3577108,"resolution":"772x250","location":"assets","locale":"","width":772,"height":250}},"assets_blueprints":{},"all_blocks":[],"tagged_versions":["1.0.0"],"block_files":[],"assets_screenshots":{"screenshot-1.png":{"filename":"screenshot-1.png","revision":3577108,"resolution":"1","location":"assets","locale":"","width":1440,"height":900},"screenshot-2.png":{"filename":"screenshot-2.png","revision":3577108,"resolution":"2","location":"assets","locale":"","width":1440,"height":900},"screenshot-3.png":{"filename":"screenshot-3.png","revision":3577108,"resolution":"3","location":"assets","locale":"","width":1440,"height":900}},"screenshots":{"1":"Settings page under WooCommerce > API Optimizer \u2014 enter optional Stripe API keys.","2":"Example: field-filtered product list response returning only id<\/code>, name<\/code>, and price<\/code>.","3":"Example: variation response enriched with full attributes, pricing, and image URL."}},"plugin_section":[],"plugin_tags":[1556,841,247,23853,286],"plugin_category":[45,54],"plugin_contributors":[267701],"plugin_business_model":[],"class_list":["post-319035","plugin","type-plugin","status-publish","hentry","plugin_tags-api","plugin_tags-mobile","plugin_tags-performance","plugin_tags-rest-api","plugin_tags-woocommerce","plugin_category-ecommerce","plugin_category-security-and-spam-protection","plugin_contributors-hammadev2","plugin_committers-hammadev2"],"banners":{"banner":"https:\/\/ps.w.org\/api-optimizer-for-woocommerce\/assets\/banner-772x250.png?rev=3577108","banner_2x":"https:\/\/ps.w.org\/api-optimizer-for-woocommerce\/assets\/banner-1544x500.png?rev=3577108","banner_rtl":false,"banner_2x_rtl":false},"icons":{"svg":false,"icon":"https:\/\/ps.w.org\/api-optimizer-for-woocommerce\/assets\/icon-128x128.png?rev=3577108","icon_2x":"https:\/\/ps.w.org\/api-optimizer-for-woocommerce\/assets\/icon-256x256.png?rev=3577108","generated":false},"screenshots":[{"src":"https:\/\/ps.w.org\/api-optimizer-for-woocommerce\/assets\/screenshot-1.png?rev=3577108","caption":"Settings page under WooCommerce > API Optimizer \u2014 enter optional Stripe API keys."},{"src":"https:\/\/ps.w.org\/api-optimizer-for-woocommerce\/assets\/screenshot-2.png?rev=3577108","caption":"Example: field-filtered product list response returning only id<\/code>, name<\/code>, and price<\/code>."},{"src":"https:\/\/ps.w.org\/api-optimizer-for-woocommerce\/assets\/screenshot-3.png?rev=3577108","caption":"Example: variation response enriched with full attributes, pricing, and image URL."}],"raw_content":"\n

Stop receiving 50+ fields when your app needs 3. ShopMobi \u2013 API Optimizer for WooCommerce gives your store GraphQL-like flexibility over REST \u2014 plus login, password reset, and Stripe payments out of the box.<\/p>\n\n

Built for developers creating mobile apps, Flutter apps, React Native apps, or any headless WooCommerce frontend.<\/p>\n\n

Field Filtering<\/h4>\n\n

Apply field filtering to any WooCommerce REST API response. No changes required on the server side \u2014 clients request only what they need.<\/p>\n\n

Via request header (recommended for apps):<\/strong>\n X-WC-Fields: id,name,price,images<\/p>\n\n

Via query parameter:<\/strong>\n ?fields=id,name,price,images<\/p>\n\n

Exclude specific fields:<\/strong>\n X-WC-Except: meta_data,description or ?except_fields=meta_data<\/code><\/p>\n\n

When both header and query parameter are provided, the header takes priority. The plugin applies filtering after WooCommerce builds the full response, so all existing WooCommerce hooks and permissions remain intact.<\/p>\n\n

Custom REST Endpoints<\/h4>\n\n

The plugin registers the following custom endpoints under the shopmobi\/v1<\/code> namespace:<\/p>\n\n

Authentication<\/strong><\/p>\n\n

    \n
  • POST \/wp-json\/shopmobi\/v1\/users\/login<\/code> \u2014 Login with username and password<\/li>\n
  • POST \/wp-json\/shopmobi\/v1\/users\/register<\/code> \u2014 Register a new customer account<\/li>\n
  • POST \/wp-json\/shopmobi\/v1\/users\/update-profile<\/code> \u2014 Update first name, last name, and phone (requires login)<\/li>\n<\/ul>\n\n

    Password Reset<\/strong><\/p>\n\n

      \n
    • POST \/wp-json\/shopmobi\/v1\/users\/reset-password\/generate<\/code> \u2014 Send a password reset link to the user's email (WordPress native flow)<\/li>\n
    • POST \/wp-json\/shopmobi\/v1\/users\/reset-password\/verify<\/code> \u2014 Verify the reset key and set a new password<\/li>\n<\/ul>\n\n

      Store Information<\/strong><\/p>\n\n

        \n
      • GET \/wp-json\/shopmobi\/v1\/general-settings<\/code> \u2014 Country, currency, and active payment gateways (public)<\/li>\n
      • GET \/wp-json\/shopmobi\/v1\/store-location<\/code> \u2014 Store address and location (requires login)<\/li>\n
      • GET \/wp-json\/shopmobi\/v1\/payment-gateways<\/code> \u2014 Available payment gateways<\/li>\n<\/ul>\n\n

        Payments<\/strong><\/p>\n\n

          \n
        • POST \/wp-json\/shopmobi\/v1\/stripe-payment<\/code> \u2014 Create a Stripe PaymentIntent and EphemeralKey for mobile checkout (requires login)<\/li>\n<\/ul>\n\n

          Product Variation Enhancement<\/h4>\n\n

          Variation responses are enriched automatically. Raw variation IDs in product responses are replaced with full objects including:<\/p>\n\n

            \n
          • Pricing (regular price, sale price, on_sale flag)<\/li>\n
          • SKU and stock quantity<\/li>\n
          • Stock status<\/li>\n
          • Attributes with labels and slugs<\/li>\n
          • Variation image URL<\/li>\n<\/ul>\n\n

            Third-Party Services<\/h4>\n\n

            This plugin optionally integrates with Stripe<\/strong> (https:\/\/stripe.com) for payment processing. The Stripe integration is inactive until you provide API keys under WooCommerce > API Optimizer<\/strong>.<\/p>\n\n

            When the \/shopmobi\/v1\/stripe-payment<\/code> endpoint is called, payment data (amount, currency, Stripe customer ID) is sent directly to Stripe's servers. No payment data passes through ShopMobi or any other third party.<\/p>\n\n

              \n
            • Stripe Privacy Policy: https:\/\/stripe.com\/privacy<\/li>\n
            • Stripe Terms of Service: https:\/\/stripe.com\/legal<\/li>\n<\/ul>\n\n

              Your Stripe API keys are stored in your WordPress database and are never shared with the plugin author.<\/p>\n\n

              Privacy Policy<\/h3>\n\n

              This plugin stores data in your own WordPress database only:<\/p>\n\n

                \n
              • Stripe Customer IDs<\/strong> (stripe_cust_id<\/code> user meta) \u2014 created when a user makes a Stripe payment. Stored locally and shared only with Stripe to identify returning customers.<\/li>\n
              • Password Reset Keys<\/strong> \u2014 handled entirely by WordPress core (get_password_reset_key()<\/code> \/ reset_password()<\/code>). No custom data is stored in user meta by this plugin.<\/li>\n<\/ul>\n\n

                This plugin does not track users, send analytics, or transmit any personal data to ShopMobi or any third party, except for payment data sent directly to Stripe when the Stripe endpoint is used.<\/p>\n\n

                For Stripe's data handling practices, see https:\/\/stripe.com\/privacy.<\/p>\n\n\n

                Standard Installation (Recommended)<\/h4>\n\n
                  \n
                1. Go to Plugins > Add New > Upload Plugin<\/strong> in your WordPress admin.<\/li>\n
                2. Upload the plugin zip file and click Install Now<\/strong>.<\/li>\n
                3. Click Activate Plugin<\/strong>.<\/li>\n
                4. Optionally, go to WooCommerce > API Optimizer<\/strong> to enter your Stripe API keys.<\/li>\n<\/ol>\n\n

                  Installation from Source<\/h4>\n\n
                    \n
                  1. Clone the repository and navigate to the plugin folder.<\/li>\n
                  2. Run: composer install --no-dev --optimize-autoloader<\/code><\/li>\n
                  3. Copy the folder to wp-content\/plugins\/<\/code> and activate from the Plugins screen.<\/li>\n<\/ol>\n\n

                    Requirements<\/h4>\n\n
                      \n
                    • WordPress 5.8 or higher<\/li>\n
                    • WooCommerce 6.0 or higher<\/li>\n
                    • PHP 7.4 or higher<\/li>\n<\/ul>\n\n\n
                      \n

                      Does field filtering affect server performance?<\/h3><\/dt>\n

                      The full WooCommerce response is built internally before filtering is applied, so server processing time is unchanged. The benefit is a smaller network payload for mobile and headless clients.<\/p><\/dd>\n

                      Does this replace the WooCommerce REST API?<\/h3><\/dt>\n

                      No. This plugin adds a filtering layer on top of the standard WooCommerce REST API. All existing WooCommerce authentication, permissions, and hooks still apply.<\/p><\/dd>\n

                      Can I use both a header and a query parameter at the same time?<\/h3><\/dt>\n

                      The header takes priority. If X-WC-Fields<\/code> is present, the fields<\/code> query parameter is ignored for that request.<\/p><\/dd>\n

                      Which WooCommerce endpoints support field filtering?<\/h3><\/dt>\n
                        \n
                      • \/wc\/v3\/products<\/code> and individual product responses<\/li>\n
                      • \/wc\/v3\/products\/{id}\/variations<\/code><\/li>\n
                      • \/wc\/v3\/orders<\/code> and individual order responses<\/li>\n
                      • \/wc\/v3\/customers<\/code> and individual customer responses<\/li>\n<\/ul><\/dd>\n

                        Is Stripe required?<\/h3><\/dt>\n

                        No. Stripe is completely optional. All other features \u2014 field filtering, auth endpoints, general settings \u2014 work without any Stripe configuration.<\/p><\/dd>\n

                        Does this work with WooCommerce HPOS (High-Performance Order Storage)?<\/h3><\/dt>\n

                        Yes. The plugin filters WooCommerce REST API responses and does not make direct database queries, so it is fully compatible with HPOS.<\/p><\/dd>\n

                        Is the plugin compatible with caching plugins?<\/h3><\/dt>\n

                        The field filtering works on REST API responses. If your caching plugin caches REST API responses, those cached responses will not be filtered. Disable REST API caching or configure it to vary by the X-WC-Fields<\/code> header.<\/p><\/dd>\n

                        Where are Stripe API keys stored?<\/h3><\/dt>\n

                        Stripe API keys are stored in the WordPress options table via the standard WordPress Settings API. They are never logged, exposed in source code, or transmitted to any party other than Stripe.<\/p><\/dd>\n

                        Does the plugin collect any data?<\/h3><\/dt>\n

                        The plugin stores the following data in your own WordPress database:<\/p>\n\n

                          \n
                        • Stripe customer IDs in user meta (stripe_cust_id<\/code>) \u2014 only when Stripe is used<\/li>\n
                        • Temporary password reset codes and expiry timestamps in user meta \u2014 deleted immediately after use<\/li>\n<\/ul>\n\n

                          No data is sent to ShopMobi or any external service other than Stripe (when explicitly used).<\/p><\/dd>\n

                          Can I use this plugin without WooCommerce?<\/h3><\/dt>\n

                          No. WooCommerce must be installed and active. If WooCommerce is not detected, the plugin will show an admin notice and will not register any hooks or endpoints.<\/p><\/dd>\n\n<\/dl>\n\n\n

                          1.0.0<\/h4>\n\n
                            \n
                          • Initial release.<\/li>\n
                          • Field filtering via X-WC-Fields<\/code> \/ X-WC-Except<\/code> headers and fields<\/code> \/ except_fields<\/code> query parameters.<\/li>\n
                          • Applies to products, orders, customers, and variation endpoints.<\/li>\n
                          • Auth endpoints: login, register, update profile.<\/li>\n
                          • Password reset endpoints: generate and verify.<\/li>\n
                          • General settings endpoint: country, currency, store location, active gateways.<\/li>\n
                          • Payment gateways endpoint.<\/li>\n
                          • Stripe PaymentIntent endpoint with EphemeralKey support.<\/li>\n
                          • Product variation response enhancer.<\/li>\n
                          • Admin settings page under WooCommerce > API Optimizer.<\/li>\n<\/ul>","raw_excerpt":"ShopMobi reduces WooCommerce REST API response size with field filtering and adds ready-made endpoints for auth, Stripe payments, and store settings.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/319035","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=319035"}],"author":[{"embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/hammadev2"}],"wp:attachment":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=319035"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=319035"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=319035"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=319035"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=319035"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=319035"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}