The Woolworths Grocery API is a powerful, user-friendly interface designed to enhance the shopping experience by providing developers access to a wide array of grocery-related data from one of Australia's leading supermarket chains. This API grants users the ability to search for products, access real-time pricing information, view promotions, and retrieve comprehensive product details including nutritional information, allergens, and ingredients. With the Woolworths Grocery API, developers can seamlessly integrate grocery data into their applications, enabling end-users to browse products effortlessly, compare prices, and make informed purchasing decisions. The API supports various endpoints that allow for advanced functionalities, such as retrieving lists of store locations, checking stock availability, and managing customer shopping carts. Security and scalability are built into the API's design, ensuring that it can handle a high volume of requests while protecting user data and privacy. This makes it suitable for a range of applications, from mobile grocery apps to web-based shopping platforms, enhancing customer engagement and driving sales. Moreover, the API is regularly updated with the latest product offerings and promotions, ensuring that developers can provide their users with the most accurate and timely information. With extensive documentation and robust support resources, the Woolworths Grocery API empowers developers to innovate and create tailored shopping experiences that meet the diverse needs of consumers. Whether you’re building an app for meal planning, budgeting, or personalized shopping, the Woolworths Grocery API offers the tools necessary to create rich, interactive, and responsive applications that engage users and simplify grocery shopping. By harnessing the power of this API, businesses can tap into the vast potential of online grocery shopping and improve customer loyalty through enhanced service offerings.
Search Woolworths Products - Endpoint Features
| Object | Description |
|---|---|
query |
[Required] Search term such as milk, bread, coffee, pasta, or yogurt. |
page |
Optional 1-based page number. Backend page size is fixed to 36. |
{"status":"success","total":2151,"results":[{"id":888140,"sku":"888140","barcode":"9300633556150","name":"Woolworths Full Cream Milk 3L","slug":"woolworths-full-cream-milk","brand":"Woolworths","price":5.15,"discount_price":5.15,"unit_price":"$1.72 / 1L","is_on_special":false,"price_info":[{"price":5.15,"discount_price":5.15,"unit_price":"$1.72 / 1L"}],"unit":"Each","size":"3L","minimum_quantity":1,"stock_status":"InStock","is_available":true,"is_purchasable":true,"image":"https://cdn0.woolworths.media/content/wowproductimages/large/888140.jpg","images":["https://cdn0.woolworths.media/content/wowproductimages/large/888140.jpg"],"url":"https://www.woolworths.com.au/shop/productdetails/888140","source_url":"https://www.woolworths.com.au/shop/productdetails/888140","category_id":"1_6E4F4E4","description":"Woolworths Full Cream Milk 3L","specifications":{"ingredients":"Pasteurised and Homogenised Full Cream Milk.","allergens":null,"storage":null,"lifestyle":"Gluten Free,Low Salt,Source of Protein,Vegetarian"},"ingredients":"Pasteurised and Homogenised Full Cream Milk.","allergens":null,"nutrition":{"Name":"Nutritional Information","Attributes":[{"Id":702,"Name":"Calcium Quantity Per 100g - Total - NIP","Value":"117.0mg","Description":"Calcium Quantity Per 100g - Total - NIP","SortOrder":71},{"Id":47,"Name":"Calcium Quantity Per Serve - Total - NIP","Value":"292.0mg","Description":"Calcium Quantity Per Serve - Total - NIP","SortOrder":75},{"Id":705,"Name":"Carbohydrate Quantity Per 100g - Total - NIP","Value":"4.8g","Description":"Carbohydrate Quantity Per 100g - Total - NIP","SortOrder":83},{"Id":706,"Name":"Carbohydrate Quantity Per Serve - Total - NIP","Value":"12.0g","Description":"Carbohydrate Quantity Per Serve - Total - NIP","SortOrder":87},{"Id":125,"Name":"Cholesterol Quantity Per Serve - Total - NIP","Value":"25.03mg","Description":"Cholesterol Quantity Per Serve - Total - NIP","SortOrder":115},{"Id":759,"Name":"Energy kJ Quantity Per 100g - Total - NIP","Value":"264.0kJ","Description":"Energy kJ Quantity Per 100g - Total - NIP","SortOrder":239},{"Id":760,"Name":"Energy kJ Quantity Per Serve - Total - NIP","Value":"660.0kJ","Description":"Energy kJ Quantity Per Serve - Total - NIP","SortOrder":243},{"Id":253,"Name":"Fat Saturated Quantity Per 100g - Total - NIP","Value":"2.2g","Description":"Fat Saturated Quantity Per 100g - Total - NIP","SortOrder":251},{"Id":258,"Name":"Fat Saturated Quantity Per Serve - Total - NIP","Value":"5.5g","Description":"Fat Saturated Quantity Per Serve - Total - NIP","SortOrder":255},{"Id":764,"Name":"Fat Total Quantity Per 100g - Total - NIP","Value":"3.4g","Description":"Fat Total Quantity Per 100g - Total - NIP","SortOrder":263},{"Id":166,"Name":"Fat Total Quantity Per 100g - ValueWord - NIP","Value":"3.4","Description":"Fat Total Quantity Per 100g - ValueWord - NIP","SortOrder":264},{"Id":264,"Name":"Fat Total Quantity Per Serve - Total - NIP","Value":"8.5g","Description":"Fat Total Quantity Per Serve - Total - NIP","SortOrder":267},{"Id":834,"Name":"Monounsaturated Quantity Per Serve - Total - NIP","Value":"2.23g","Description":"Monounsaturated Quantity Per Serve - Total - NIP","SortOrder":483},{"Id":435,"Name":"Polyunsaturated Quantity Per Serve - Total - NIP","Value":"0.23g","Description":"Polyunsaturated Quantity Per Serve - Total - NIP","SortOrder":567},{"Id":493,"Name":"Potassium Quantity Per Serve - Total - NIP","Value":"347.98mg","Description":"Potassium Quantity Per Serve - Total - NIP","SortOrder":579},{"Id":878,"Name":"Protein Quantity Per 100g - Total - NIP","Value":"3.3g","Description":"Protein Quantity Per 100g - Total - NIP","SortOrder":587},{"Id":882,"Name":"Protein Quantity Per Serve - Total - NIP","Value":"8.2g","Description":"Protein Quantity Per Serve - Total - NIP","SortOrder":591},{"Id":477,"Name":"Serving Size - Total - NIP","Value":"250.0 ML","Description":"Serving Size - Total - NIP","SortOrder":607},{"Id":544,"Name":"Servings Per Pack - Total - NIP","Value":"12.0","Description":"Servings Per Pack - Total - NIP","SortOrder":611},{"Id":491,"Name":"Sodium Quantity Per 100g - Total - NIP","Value":"44.0mg","Description":"Sodium Quantity Per 100g - Total - NIP","SortOrder":623},{"Id":495,"Name":"Sodium Quantity Per Serve - Total - NIP","Value":"110.0mg","Description":"Sodium Quantity Per Serve - Total - NIP","SortOrder":627},{"Id":908,"Name":"Sugars Quantity Per 100g - SuffixUnits - NIP","Value":"g","Description":"Sugars Quantity Per 100g - SuffixUnits - NIP","SortOrder":646},{"Id":909,"Name":"Sugars Quantity Per 100g - Total - NIP","Value":"4.8g","Description":"Sugars Quantity Per 100g - Total - NIP","SortOrder":647},{"Id":910,"Name":"Sugars Quantity Per 100g - ValueWord - NIP","Value":"4.8","Description":"Sugars Quantity Per 100g - ValueWord - NIP","SortOrder":648},{"Id":911,"Name":"Sugars Quantity Per Serve - SuffixUnits - NIP","Value":"g","Description":"Sugars Quantity Per Serve - SuffixUnits - NIP","SortOrder":650},{"Id":912,"Name":"Sugars Quantity Per Serve - Total - NIP","Value":"12.0g","Description":"Sugars Quantity Per Serve - Total - NIP","SortOrder":651},{"Id":572,"Name":"Sugars Quantity Per Serve - ValueWord - NIP","Value":"12.0","Description":"Sugars Quantity Per Serve - ValueWord - NIP","SortOrder":652},{"Id":593,"Name":"Trans Quantity Per 100g - Total - NIP","Value":"1.0g","Description":"Trans Quantity Per 100g - Total - NIP","SortOrder":667},{"Id":510,"Name":"Trans Quantity Per Serve - Total - NIP","Value":"<1g","Description":"Trans Quantity Per Serve - Total - NIP","SortOrder":671}]}},{"id":888137,"sku":"888137","barcode":"9300633556143","name":"Woolworths Full Cream Milk 2L","slug":"woolworths-full-cream-milk","brand":"Woolworths","price":3.55,"discount_price":3.55,"unit_price":"$1.78 / 1L","is_on_special":false,"price_info":[{"price":3.55,"discount_price":3.55,"unit_price":"$1.78 / 1L"}],"unit":"Each","size":"2L","minimum_quantity":1,"stock_status":"InStock","is_available":true,"is_purchasable":true,"image":"https://cdn0.woolworths.media/content/wowproductimages/large/888137.jpg","images":["https://cdn0.woolworths.media/content/wowproductimages/large/888137.jpg"],"url":"https://www.woolworths.com.au/shop/productdetails/888137","source_url":"https://www.woolworths.com.au/shop/productdetails/888137","category_id":"1_6E4F4E4","description":"Woolworths Full Cream Milk 2L","specifications":{"ingredients":"Pasteurised and Homogenised Full Cream Milk.","allergens":null,"storage":null,"lifestyle":"Gluten Free,Low Salt,Source of Protein,Vegetarian"},"ingredients":"Pasteurised and Homogenised Full Cream Milk.","allergens":null,"nutrition":{"Name":"Nutritional Information","Attributes":[{"Id":702,"Name":"Calcium Quantity Per 100g - Total - NIP","Value":"117.0mg","Description":"Calcium Quantity Per 100g - Total - NIP","SortOrder":71},{"Id":47,"Name":"Calcium Quantity Per Serve - Total - NIP","Value":"292.0mg","Description":"Calcium Quantity Per Serve - Total - NIP","SortOrder":75},{"Id":705,"Name":"Carbohydrate Quantity Per 100g - Total - NIP","Value":"4.8g","Description":"Carbohydrate Quantity Per 100g - Total - NIP","SortOrder":83},{"Id":706,"Name":"Carbohydrate Quantity Per Serve - Total - NIP","Value":"12.0g","Description":"Carbohydrate Quantity Per Serve - Total - NIP","SortOrder":87},{"Id":125,"Name":"Cholesterol Quantity Per Serve - Total - NIP","Value":"25.03mg","Description":"Cholesterol Quantity Per Serve - Total - NIP","SortOrder":115},{"Id":759,"Name":"Energy kJ Quantity Per 100g - Total - NIP","Value":"264.0kJ","Description":"Energy kJ Quantity Per 100g - Total - NIP","SortOrder":239},{"Id":760,"Name":"Energy kJ Quantity Per Serve - Total - NIP","Value":"660.0kJ","Description":"Energy kJ Quantity Per Serve - Total - NIP","SortOrder":243},{"Id":253,"Name":"Fat Saturated Quantity Per 100g - Total - NIP","Value":"2.2g","Description":"Fat Saturated Quantity Per 100g - Total - NIP","SortOrder":251},{"Id":258,"Name":"Fat Saturated Quantity Per Serve - Total - NIP","Value":"5.5g","Description":"Fat Saturated Quantity Per Serve - Total - NIP","SortOrder":255},{"Id":764,"Name":"Fat Total Quantity Per 100g - Total - NIP","Value":"3.4g","Description":"Fat Total Quantity Per 100g - Total - NIP","SortOrder":263},{"Id":166,"Name":"Fat Total Quantity Per 100g - ValueWord - NIP","Value":"3.4","Description":"Fat Total Quantity Per 100g - ValueWord - NIP","SortOrder":264},{"Id":264,"Name":"Fat Total Quantity Per Serve - Total - NIP","Value":"8.5g","Description":"Fat Total Quantity Per Serve - Total - NIP","SortOrder":267},{"Id":834,"Name":"Monounsaturated Quantity Per Serve - Total - NIP","Value":"2.23g","Description":"Monounsaturated Quantity Per Serve - Total - NIP","SortOrder":483},{"Id":435,"Name":"Polyunsaturated Quantity Per Serve - Total - NIP","Value":"0.23g","Description":"Polyunsaturated Quantity Per Serve - Total - NIP","SortOrder":567},{"Id":493,"Name":"Potassium Quantity Per Serve - Total - NIP","Value":"347.98mg","Description":"Potassium Quantity Per Serve - Total - NIP","SortOrder":579},{"Id":878,"Name":"Protein Quantity Per 100g - Total - NIP","Value":"3.3g","Description":"Protein Quantity Per 100g - Total - NIP","SortOrder":587},{"Id":882,"Name":"Protein Quantity Per Serve - Total - NIP","Value":"8.2g","Description":"Protein Quantity Per Serve - Total - NIP","SortOrder":591},{"Id":477,"Name":"Serving Size - Total - NIP","Value":"250.0 ML","Description":"Serving Size - Total - NIP","SortOrder":607},{"Id":544,"Name":"Servings Per Pack - Total - NIP","Value":"8.0","Description":"Servings Per Pack - Total - NIP","SortOrder":611},{"Id":491,"Name":"Sodium Quantity Per 100g - Total - NIP","Value":"44.0mg","Description":"Sodium Quantity Per 100g - Total - NIP","SortOrder":623},{"Id":495,"Name":"Sodium Quantity Per Serve - Total - NIP","Value":"110.0mg","Description":"Sodium Quantity Per Serve - Total - NIP","SortOrder":627},{"Id":908,"Name":"Sugars Quantity Per 100g - SuffixUnits - NIP","Value":"g"}]}}],"_note":"Response truncated for documentation purposes"}
curl --location --request GET 'https://zylalabs.com/api/12458/woolworths+grocery+api/23601/search+woolworths+products?query=milk&page=1' --header 'Authorization: Bearer YOUR_API_KEY'
| Header | Description |
|---|---|
Authorization
|
[Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed. |
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
Each endpoint returns structured data related to Woolworths products. The "Listar categorías" endpoint provides category taxonomy, "Buscar productos" returns product listings based on keywords, "Obtener detalles del producto" gives detailed product information, and "Explorar categoría" lists products within a specific category.
Key fields vary by endpoint. For "Buscar productos," expect fields like product name, price, and availability. "Obtener detalles del producto" includes fields such as product ID, description, nutritional information, and allergens. Each endpoint's response structure is designed to facilitate easy integration.
Parameters vary by endpoint. For "Buscar productos," you can use keywords to refine searches. "Explorar categoría" may accept category IDs to filter results. Each endpoint's documentation provides specific parameter options to customize requests effectively.
Response data is organized in JSON format, with clear hierarchies. For example, "Obtener detalles del producto" returns a main object containing product attributes, while "Listar categorías" provides a list of categories, each with an ID and name, making it easy to navigate and utilize.
The data is sourced directly from Woolworths' inventory and product databases, ensuring it reflects real-time availability and accurate product details. Regular updates maintain data integrity and relevance, allowing developers to provide users with the latest information.
Typical use cases include building grocery shopping apps, meal planning tools, and price comparison platforms. Developers can leverage the API to enhance user experiences by integrating product searches, category browsing, and detailed product information seamlessly.
Users can utilize returned data by parsing the JSON responses to display product information in their applications. For instance, they can create dynamic product listings, filter by categories, or show detailed product pages, enhancing user engagement and decision-making.
When handling partial or empty results, check the response status and data fields. Implement fallback mechanisms, such as displaying a message for no results found or suggesting alternative searches. This ensures a smooth user experience even when data is limited.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world's most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]
Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.
The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.
Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]
Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.
API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.
Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.
To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.
To check how many API calls you have left for the current month, refer to the 'X-Zyla-API-Calls-Monthly-Remaining' field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.
To see the maximum number of API requests your plan allows, check the 'X-Zyla-RateLimit-Limit' response header. For instance, if your plan includes 1,000 requests per month, this header will display 1,000.
The 'X-Zyla-RateLimit-Reset' header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3,600, it means 3,600 seconds are left until the limit resets.
Yes, you can cancel your plan anytime by going to your account and selecting the cancellation option on the Billing page. Please note that upgrades, downgrades, and cancellations take effect immediately. Additionally, upon cancellation, you will no longer have access to the service, even if you have remaining calls left in your quota.
You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]
To give you the opportunity to experience our APIs without any commitment, we offer a 7-day free trial that allows you to make up to 50 API calls at no cost. This trial can be used only once, so we recommend applying it to the API that interests you the most. While most of our APIs offer a free trial, some may not. The trial concludes after 7 days or once you've made 50 requests, whichever occurs first. If you reach the 50 request limit during the trial, you will need to "Start Your Paid Plan" to continue making requests. You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab. Alternatively, if you don't cancel your subscription before the 7th day, your free trial will end, and your plan will automatically be billed, granting you access to all the API calls specified in your plan. Please keep this in mind to avoid unwanted charges.
After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it's important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.
When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.
Payout Orders are processed between the 20th and the 30th of each month. If you submit your request before the 20th, your payment will be processed within this timeframe.
Service Level:
100%
Response Time:
4,358ms
Service Level:
99%
Response Time:
11,261ms
Service Level:
100%
Response Time:
9,689ms
Service Level:
100%
Response Time:
3,975ms
Service Level:
100%
Response Time:
1,489ms
Service Level:
100%
Response Time:
3,786ms
Service Level:
100%
Response Time:
20,003ms
Service Level:
100%
Response Time:
1,370ms
Service Level:
100%
Response Time:
1,774ms
Service Level:
100%
Response Time:
9,066ms
Service Level:
50%
Response Time:
3,821ms
Service Level:
50%
Response Time:
1,258ms
Service Level:
50%
Response Time:
1,663ms
Service Level:
50%
Response Time:
4,342ms
Service Level:
50%
Response Time:
7,928ms
Service Level:
100%
Response Time:
3,143ms
Service Level:
100%
Response Time:
3,680ms
Service Level:
100%
Response Time:
7,768ms
Service Level:
100%
Response Time:
4,583ms
Service Level:
100%
Response Time:
2,250ms
