Lire un produit par ID

Prod Env

https://relay.exostack.cloud/{{relay_path}}

GET

/api/inventory/products/by-id/{id}

Retourne la fiche complète d'un produit à partir de son identifiant interne. Utilisez le paramètre include pour charger les sous-entités (items, components, suppliers). Disponible aussi par code via /{code}.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Query Params

Responses

🟢200

application/json

Fiche complète du produit

Body

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://relay.exostack.cloud//api/inventory/products/by-id/?include' \
--header 'x-api-key: <api-key>'

Response Example

{
    "id": 42,
    "code": "WIDGET-001",
    "description": "Widget Standard",
    "description_locale": {
        "fr": "Widget Standard",
        "en": "Standard Widget"
    },
    "product_group": {
        "id": 3,
        "code": "ELEC"
    },
    "tax_exception": {},
    "segment": {
        "id": 5,
        "code": "COULEUR"
    },
    "taxes_included": true,
    "upc": "012345678901",
    "upc_is_variable": false,
    "unit": {
        "code": "UN",
        "label": "Unité"
    },
    "location": "A-12-3",
    "sequence": "005",
    "sort_key_1": "WIDGET",
    "sort_key_2": "",
    "serial": {
        "has_serial_number": false,
        "serial_number_required": false,
        "existing_only": false
    },
    "comment": {
        "text": "",
        "show_on_invoice": false,
        "print_in_transactions": false
    },
    "prices": {
        "regular": 29.99,
        "promo": 24.99,
        "bulk": {
            "qty_threshold_1": 10,
            "price_1": 27.99,
            "qty_threshold_2": 50,
            "price_2": 25.99,
            "price_3": 24.49
        },
        "last_cost": 15,
        "average_cost": 15.5
    },
    "stock": {
        "on_hand": 150,
        "on_order": 25,
        "on_quote": 10,
        "reserved": 5,
        "in_purchase": 0,
        "available": 110,
        "in_demo": 2,
        "under_repair": 0,
        "totals": {
            "on_hand": 160,
            "on_order": 30,
            "on_quote": 12,
            "reserved": 5,
            "in_purchase": 0,
            "available": 113
        },
        "settings": {
            "reorder_point": 20,
            "maximum_qty": 500,
            "backorder_allowed": true,
            "backorder_allowed_by_group": true,
            "delivery_delay_days": 5
        }
    },
    "status": {
        "is_used": true,
        "is_deleted": false,
        "is_active": true,
        "product_status": 0
    },
    "metadata": {
        "updated_at": "2026-03-01T10:00:00-04:00",
        "updated_by_user_id": 7,
        "unique_id": 420,
        "sdk_interface": "PrProduct",
        "sdk_index_used": 1
    },
    "sync": {
        "organisation_id": "mastodonte",
        "extracted_at": "2026-03-13T10:00:00-04:00",
        "cursor": {
            "modified_at": "2026-03-01T10:00:00-04:00",
            "card_pos": 42
        }
    }
}

Modified at 2026-03-17 18:36:59

Trouver la clé depuis une position d'index (avancé)

Modifier un produit par ID