Get Store Inventory
curl --request GET \
--url 'https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory'import requests
url = "https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"inventory": [
{
"id": "<string>",
"image": "<string>",
"name": "<string>",
"description": "<string>",
"size": "<string>",
"category": {
"id": "<string>",
"name": "<string>",
"category_order": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
},
"price": "<string>",
"upc": "<string>",
"quantity": 123,
"external_id": "<string>",
"store_id": "<string>",
"is_editable": true,
"dsp_item_price": 123,
"is_added_to_doordash": true,
"is_added_to_ubereats": true,
"is_added_to_grub_hub": true
}
]
}Catalog
Get Store Inventory
This endpoint retrieves the complete inventory for a specific store, including product details, pricing, quantities, and category information.
GET
{micro_service_base_url}
/
inventory
/
v2
/
{store_id}
/
inventory
Get Store Inventory
curl --request GET \
--url 'https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory'import requests
url = "https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/{{micro_service_base_url}}/inventory/v2/{{store_id}}/inventory")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"inventory": [
{
"id": "<string>",
"image": "<string>",
"name": "<string>",
"description": "<string>",
"size": "<string>",
"category": {
"id": "<string>",
"name": "<string>",
"category_order": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
},
"price": "<string>",
"upc": "<string>",
"quantity": 123,
"external_id": "<string>",
"store_id": "<string>",
"is_editable": true,
"dsp_item_price": 123,
"is_added_to_doordash": true,
"is_added_to_ubereats": true,
"is_added_to_grub_hub": true
}
]
}This endpoint returns a paginated list of all products in your store’s inventory with comprehensive details including pricing, stock levels, and category information.
Query Parameters
number
default:20
Maximum number of items to return per page
number
default:0
Number of items to skip for pagination
boolean
default:true
Filter by product active status
number
default:0
Minimum price filter (in cents)
number
default:9999
Maximum price filter (in cents)
string
default:"createdAt"
Field to order results by
string
default:"DESC"
Sort direction. Values: “ASC” or “DESC”
Response
array
Array of inventory items
Show Inventory Item Object
Show Inventory Item Object
string
Internal item ID
string
Product image URL
string
Product name
string
Product description
string
Product size
object
string
Product price
string
Product UPC code
number
Available quantity
string
External product identifier
string
Store identifier
boolean
Whether the product can be edited
number
Display item price
boolean
Whether product is available on DoorDash
boolean
Whether product is available on Uber Eats
boolean
Whether product is available on Grub Hub
Response Example
[
{
"id": "58",
"image": "https://lula-inventory-service-staging.s3.amazonaws.com/images/1000019/Candy/1014132_1749556811814.webp",
"name": "Wrigley's 5 Rain Spearmint Mega Pack",
"description": "35 sticks",
"size": "",
"category": {
"id": "ae8c7e12-4372-4266-9859-42d07559131b",
"name": "Candy",
"category_order": "2100",
"createdAt": "2021-10-21T15:15:12.217Z",
"updatedAt": "2021-10-21T15:15:12.217Z"
},
"price": "99.80",
"upc": "22000017901",
"quantity": 50,
"external_id": "22000017901",
"store_id": "449235c1-3d04-4519-998b-40d2a621e5e0",
"is_editable": true,
"dsp_item_price": 129.74,
"is_added_to_doordash": false,
"is_added_to_ubereats": false,
"is_added_to_grub_hub": false
}
]
Use the limit and offset parameters to implement pagination for large inventories. The active parameter helps filter between active and inactive products.
⌘I

