{
"device_model": {
"device_model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>",
"description_md": "<string>",
"product_url": "<string>",
"is_forbidden_to_3dparty": true,
"no_longer_sold": true,
"shop_listings": "<unknown>",
"last_commerce_search_at": "2023-11-07T05:31:56Z",
"manufacturer": {
"manufacturer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>"
},
"device_type": {
"device_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>",
"is_accessory": true
},
"device_type_properties": "<unknown>",
"variants": [
{
"device_model_variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"color_name": "<string>",
"style_name": "<string>",
"primary_color_hex": "<string>",
"manufacturer_model_id": "<string>",
"asin": "<string>",
"gtins": "<unknown>",
"marketplace_listings": "<unknown>",
"sort_order": 0,
"images": [
{
"asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "square_logo",
"object_key": "<string>",
"url": "<string>",
"mime": "<string>",
"width": 0,
"height": 0,
"bytes": 0,
"sha256": "<string>",
"sort_order": 0,
"formats": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"featured_image": {
"asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "square_logo",
"object_key": "<string>",
"url": "<string>",
"mime": "<string>",
"width": 0,
"height": 0,
"bytes": 0,
"sha256": "<string>",
"sort_order": 0,
"formats": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"providers": [
{
"provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>"
}
],
"capabilities_by_provider": [
{
"provider": {
"provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>"
},
"capabilities": [
{
"capability_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "device_connectivity",
"supported": "yes",
"integration_support_level": "inquire",
"report": {
"details": "<string>",
"requirements": {},
"dependencies": [
"<string>"
]
},
"report_raw": {
"details": "<string>",
"requirements": {},
"dependencies": [
"<string>"
]
},
"locale": "<string>",
"computed_at": "2023-11-07T05:31:56Z"
}
]
}
],
"capabilities_stale": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"ok": true
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}API Reference
Get a Device Model
Returns one published device model by slug or device_model_id, with variants, properties, featured image, providers and capabilities grouped by provider. A model hidden from third parties is not found unless the request uses its manufacturer’s secret key and sets include_forbidden. Capability reports are resolved per locale, with the raw translation keys in report_raw.
GET
/
device_models
/
get
{
"device_model": {
"device_model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>",
"description_md": "<string>",
"product_url": "<string>",
"is_forbidden_to_3dparty": true,
"no_longer_sold": true,
"shop_listings": "<unknown>",
"last_commerce_search_at": "2023-11-07T05:31:56Z",
"manufacturer": {
"manufacturer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>"
},
"device_type": {
"device_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>",
"is_accessory": true
},
"device_type_properties": "<unknown>",
"variants": [
{
"device_model_variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"color_name": "<string>",
"style_name": "<string>",
"primary_color_hex": "<string>",
"manufacturer_model_id": "<string>",
"asin": "<string>",
"gtins": "<unknown>",
"marketplace_listings": "<unknown>",
"sort_order": 0,
"images": [
{
"asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "square_logo",
"object_key": "<string>",
"url": "<string>",
"mime": "<string>",
"width": 0,
"height": 0,
"bytes": 0,
"sha256": "<string>",
"sort_order": 0,
"formats": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"featured_image": {
"asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "square_logo",
"object_key": "<string>",
"url": "<string>",
"mime": "<string>",
"width": 0,
"height": 0,
"bytes": 0,
"sha256": "<string>",
"sort_order": 0,
"formats": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"providers": [
{
"provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>"
}
],
"capabilities_by_provider": [
{
"provider": {
"provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>"
},
"capabilities": [
{
"capability_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "device_connectivity",
"supported": "yes",
"integration_support_level": "inquire",
"report": {
"details": "<string>",
"requirements": {},
"dependencies": [
"<string>"
]
},
"report_raw": {
"details": "<string>",
"requirements": {},
"dependencies": [
"<string>"
]
},
"locale": "<string>",
"computed_at": "2023-11-07T05:31:56Z"
}
]
}
],
"capabilities_stale": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"ok": true
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}Authorizations
secret_keyembed_keyembed_key_param
Optional on endpoints that serve published content. A secret key (eco_sk_…), sent as Authorization: Bearer eco_sk_… from your servers only. A manufacturer secret key implies its manufacturer and can include that manufacturer's device models hidden from third parties.
Query Parameters
Device model slug; provide this or device_model_id.
Device model UUID; provide this or slug.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Include models forbidden to third parties (is_forbidden_to_3dparty): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.
Locale for resolved capability report text; unknown locales fall back to the default locale.
Was this page helpful?