Get product (admin)

GET
/admin/products/{id}

Authorization

headerx-api-key<token>

Organization-scoped API key with scope metadata.

Path Parameters

id*string

Response Body

Success

application/json
  1. response
id*string
sku*string|null
name*
slug*string
description*|null
shortDescription*|null
price*|null
primaryImage*|null
gallery*array<>
rating*|null
variants*array<>
attributes*array<>
quantityLimit*number|null
categories*array<>
inStock*boolean
vatIncluded*boolean
vatRate*number|null
tags*array<string>
createdAt*string
updatedAt*string
productType*string
Value in"physical""digital""service""event""subscription"
requiresShipping*boolean
isDropshipped*boolean
status*string|null
Example Request
curl -X GET 'https://api-prood.vercel.app/v1/admin/products/string'
Example Response
{  "id": "string",  "sku": "string",  "name": {    "property1": "string",    "property2": "string"  },  "slug": "string",  "description": {    "property1": "string",    "property2": "string"  },  "shortDescription": {    "property1": "string",    "property2": "string"  },  "price": {    "amount": 0,    "currency": "string",    "formatted": "string",    "originalAmount": 0,    "discountPercent": 0  },  "primaryImage": {    "url": "string",    "alt": "string",    "width": 0,    "height": 0  },  "gallery": [    {      "url": "string",      "alt": "string",      "width": 0,      "height": 0    }  ],  "rating": {    "average": 0,    "count": 0  },  "variants": [    {      "id": "string",      "sku": "string",      "name": {        "property1": "string",        "property2": "string"      },      "price": {        "amount": 0,        "currency": "string",        "formatted": "string",        "originalAmount": 0,        "discountPercent": 0      },      "inStock": true,      "inventoryQuantity": 0    }  ],  "attributes": [    {      "code": "string",      "name": {        "property1": "string",        "property2": "string"      },      "value": {        "property1": "string",        "property2": "string"      }    }  ],  "quantityLimit": 0,  "categories": [    {      "id": "string",      "name": {        "property1": "string",        "property2": "string"      },      "slug": "string",      "description": {        "property1": "string",        "property2": "string"      },      "image": {        "url": "string",        "alt": "string",        "width": 0,        "height": 0      },      "parentId": "string",      "productCount": 0    }  ],  "inStock": true,  "vatIncluded": true,  "vatRate": 0,  "tags": [    "string"  ],  "createdAt": "string",  "updatedAt": "string",  "productType": "physical",  "requiresShipping": true,  "isDropshipped": true,  "status": "string"}