Product
The Product API endpoints allow fetching essential product related data such as pricing and stock levels.
One or more product references of products / product variants to retrieve.
{"value":"34dc4eaf-2800-4fac-899c-b5e6ca94850b"}
Limit the properties returned in the response
{"value":" "}
Defines the properties that should be expanded in the response
{"value":" "}
API key specified through configuration to authorize access to the API.
The ID or the alias of the store
{"value":"573b1f7f-dc4d-49bd-a5b3-7ae753e32307"}
The ID of the current order associated with the current session
615c83c3-326e-4c82-ba81-3dfa97b74e53
The ID or alias of the session default billing country
{"value":"51b5ccf6-57b9-4641-b407-25a817b737e6"}
The ID or alias of the session default billing region
{"value":"551be988-8fd3-4120-8b9f-38ece5585e92"}
The ID or alias of the session default shipping country
{"value":"c232e18b-919a-4408-a6e5-fe3ab5ef7d54"}
The ID or alias of the session default shipping region
{"value":"4a0e4875-b757-4945-bdc2-f7186dc67b4a"}
The ID or alias of the session default tax class
{"value":"e4dbac33-5b18-47f6-8795-1db15149888c"}
The ID or alias of the session currency
{"value":"64301345-f64f-4d97-8eb6-329e1545e4b0"}
The ISO culture code of the current session culture
en-US
The unique reference for the customer associated with the current session
cust_627edc2c-9547-4f8a-b057-df3040f24dc2
GET /umbraco/commerce/storefront/api/v1/products HTTP/1.1
Host:
Api-Key: text
Store: text
Accept: */*
[
{
"productReference": "text",
"sku": "text",
"name": "text",
"productVariantReference": "text",
"imageUrl": "text",
"price": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 1,
"tax": 1,
"withTax": 1,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"stock": 1,
"attributes": [
{
"name": {
"alias": "text",
"name": "text"
},
"value": {
"alias": "text",
"name": "text"
}
}
],
"taxClass": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text",
"name": "text",
"store": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text",
"name": "text",
"defaultCountry": "[Circular Reference]",
"defaultTaxClass": "[Circular Reference]",
"baseCurrency": "[Circular Reference]",
"pricesIncludeTax": true
},
"defaultTaxRate": 1,
"defaultTaxCode": "text",
"taxRate": 1,
"taxCode": "text",
"countryRegionTaxClasses": [
{
"store": "[Circular Reference]",
"country": "[Circular Reference]",
"region": "[Circular Reference]",
"taxRate": 1,
"taxCode": "text"
}
]
},
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"isGiftCard": true
}
]
Last updated
Was this helpful?