Get a catalogue item
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://api.azimea.com/v1/items/example"), Headers = { { "Authorization", "Bearer <token>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://api.azimea.com/v1/items/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.azimea.com/v1/items/example \ --header 'Authorization: Bearer <token>'Reads one of the items your system sent, by your own id (externalId). Items synced from a connected store are not found here. Needs the items:read permission.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”The item
object
true when the call worked, false when errors say why it did not.
The answer itself; null when the call failed.
object
Azimea’s id for the item.
Where the item comes from: store (synced from a connected shop, edited only there), file (an import) or api.
The connected store the item belongs to; null for items from a file or the API.
Your own id for the item, the one you sent as id.
product, plan, service or other.
The item’s name.
A description, up to 5,000 characters.
Where the item can be bought or read about: a full address starting with https://.
An image of the item: a full address starting with https://.
The current price, in currency.
The price before a discount. Higher than price when set.
The three-letter currency code, such as EUR or GBP.
true when the item can be bought.
How many are left; null when you do not track it.
The item’s categories. They drive the “one category” and “for each person” recommendations in emails.
Extra fields you attached, by key.
object
false stops recommending the item and keeps its history.
When the item was added.
When it last changed; null if it never did.
An internal result number. Rely on the HTTP status code instead.
What went wrong, one entry per problem; empty when the call worked.
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
The same problems grouped by the request field they belong to; null when none is tied to a field.
object
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
Example
{ "isSuccess": true, "value": { "id": "01a10900-0000-7000-8000-000000000001", "source": "api", "storeId": null, "externalId": "plan-pro", "kind": "plan", "name": "Pro plan", "description": "Unlimited projects and priority support.", "url": "https://example.com/pricing#pro", "imageUrl": "https://example.com/img/pro.png", "price": 49, "comparePrice": 59, "currency": "EUR", "inStock": true, "stockQuantity": null, "categories": [ "plans" ], "attributes": { "billing": "monthly", "seats": 5 }, "active": true, "createdAt": "2026-10-05T09:00:00+00:00", "updatedAt": null }, "status": 0, "errors": [], "fieldErrors": null}Missing or invalid API key
The key lacks the items:read permission
No item with this id (catalog.item_not_found)
object
true when the call worked, false when errors say why it did not.
The answer itself; null when the call failed.
An internal result number. Rely on the HTTP status code instead.
What went wrong, one entry per problem; empty when the call worked.
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
The same problems grouped by the request field they belong to; null when none is tied to a field.
object
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
Examplegenerated
{ "isSuccess": true, "value": "example", "status": 1, "errors": [ { "code": "example", "message": "example", "params": { "additionalProperty": "example" } } ], "fieldErrors": { "additionalProperty": [ { "code": "example", "message": "example", "params": { "additionalProperty": "example" } } ] }}Too many requests for this key