Saltar al contingut principal
GET

Obtenir un producte per ID

Scope:inventory:products.read
https://api.holded.com/api/v2/products/{productId}

Recupera tots els detalls d'un producte específic pel seu identificador únic.

Paràmetres

Paràmetres de ruta

productIdstringobligatori

ID del producte (ObjectId hexadecimal de 24 caràcters)

Petició

python
import requests

url = "https://api.holded.com/api/v2/products/{productId}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Respostes

Resposta

json
{
  "id": "507f1f77bcf86cd799439011",
  "kind": "simple",
  "name": "string",
  "description": "string",
  "type_id": "string",
  "price": "99.95",
  "taxes": [
    "string"
  ],
  "total": "string",
  "has_stock": false,
  "stock": "15.3",
  "barcode": "string",
  "sku": "string",
  "cost": "50.00",
  "purchase_price": "string",
  "weight": "3.2",
  "tags": [
    "string"
  ],
  "category_id": "string",
  "factory_code": "string",
  "for_sale": false,
  "for_purchase": false,
  "sales_channel_id": "string",
  "exp_account_id": "string",
  "warehouse_id": "string",
  "archived": false,
  "purchase_taxes": [
    "string"
  ],
  "min_stock": "5",
  "min_stock_alarm": false,
  "in_pos": false,
  "supplier_id": "string",
  "translations": [
    {}
  ],
  "rates": [
    {
      "id": "string",
      "subtotal": "string",
      "taxes": [
        "string"
      ]
    }
  ],
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "value": "string"
    }
  ],
  "variants": [
    {
      "id": "string",
      "sku": "string",
      "barcode": "string",
      "price": "19.99",
      "cost": "string",
      "purchase_price": "string",
      "stock": "10.00",
      "description": "string",
      "weight": "string",
      "factory_code": "string",
      "archived": false,
      "options": [
        {
          "name": "...",
          "value": "...",
          "originId": "..."
        }
      ],
      "category_fields": [
        {
          "id": "...",
          "name": "...",
          "value": "..."
        }
      ],
      "sales_rates": [
        {
          "id": "...",
          "subtotal": "...",
          "taxes": "..."
        }
      ]
    }
  ],
  "pack_items": [
    {
      "product_selection": "507f1f77bcf86cd799439011",
      "units": 2
    }
  ],
  "stocks": [
    {
      "warehouse_id": "string",
      "stock": "10",
      "variant_id": "string"
    }
  ],
  "image": {}
}

Respostes exitoses

200Producte trobatapplication/json
object
idstring

Unique identifier of the product

kindstring

Type of item

Enum:simplevariantslotsserialnumberspack
namestring

Name of the product

descriptionstring | null

Description of the product

type_idstring | null

Identifier of the product type

pricestring | null

Sale price as a decimal string

taxes[]string[]

List of tax identifiers applied to the product

totalstring | null

Total price including taxes as a decimal string

has_stockboolean

Whether the product has stock tracking enabled

stockstring

Current total stock across all warehouses as a decimal string

barcodestring | null

Barcode value (EAN, UPC, etc.)

skustring | null

Stock Keeping Unit code

coststring | null

Cost price as a decimal string

purchase_pricestring | null

Purchase price as a decimal string

weightstring | null

Weight in the account default unit as a decimal string

tags[]string[]

List of tags attached to the product

category_idstring | null

Identifier of the product category

factory_codestring | null

Manufacturer or factory reference code

for_saleboolean

Whether the product is available for sale

for_purchaseboolean

Whether the product is available for purchase

sales_channel_idstring | null

Identifier of the sales channel assigned to this product

exp_account_idstring | null

Identifier of the expenses account

warehouse_idstring | null

Identifier of the default warehouse

archivedboolean

Whether the product is archived

purchase_taxes[]string[]

List of tax identifiers applied to purchases

min_stockstring | null

Minimum stock threshold as a decimal string

min_stock_alarmboolean

Whether the minimum stock alarm is enabled

in_posboolean

Whether the product is available in point of sale

supplier_idstring | null

Identifier of the default supplier

translations[]object[]

Product name translations by locale

rates[]object[]

Price rates with different subtotals and taxes

idstring
subtotalstring
taxes[]string[]
attributes[]object[]

Product attributes

idstring
namestring
valuestring
variants[]object[]

Variants of the product. Present for kinds: variants, lots, serialnumbers. Each item contains fields relevant to the kind.

idstring
skustring | null
barcodestring | null
pricestring | null
coststring | null
purchase_pricestring | null
stockstring | null
descriptionstring | null
weightstring | null
factory_codestring | null
archivedboolean
options[]object[]

Attribute options for this variant (e.g. Color=Red, Size=M). Only present for variants products.

category_fields[]object[]

Values of your own variant-group fields for this variant (e.g. Size=M, Color=Red) — the fields you configure under your product categories. Unrelated to `options`, which is ecommerce-synced data. Only present for variants products.

sales_rates[]object[]

Price rates with tax breakdown for this variant.

pack_items[]object[] | null

Component items included in this pack product. Only present for pack products.

product_selectionstring

Product ID or "productId#variantId"

unitsnumber
stocks[]object[]

Stock per warehouse. Each entry has warehouse_id and stock. Variant products also include variant_id.

warehouse_idstring
stockstring
variant_idstring | null

Only present for variant/lots/serialnumbers products.

imageobject

Main product image with its resolved URLs. Null when the product has no images.

Respostes d'error

401API key no vàlida o no proporcionadaapplication/json
403Permisos insuficientsapplication/json
404Producte no trobatapplication/json
429Límit de sol·licituds exceditapplication/json