ALaltoviz
Products

Get a product by ID

Changed on
get/v1/products/{id}

Request

Path parameters

idinteger required

Product id

Response

OK

activeboolean

Indicates whether the product is active

defaultQuantitynumber double

Default quantity

descriptionstring nullable

Description

idinteger

Product ID

imageUrlstring nullable

Gets the product image URL

internalIdstring nullable

ID used in your system

internalNotesstring nullable

Internal notes

isUnitPriceTaxIncludedboolean

<b>Deprecated</b> — always false on read, because unitPrice is now always the tax-excluded price. There is nothing left for it to select between.

On write it is still honoured: setting it to true means the price you are sending is tax-included, exactly as before. Send taxIncludedPrice instead.

marginnumber double

Margin per unit, excluding tax: tax-excluded price less purchase price.

Derived by the server on every save; a value sent here is ignored.

marginRatenumber double

Margin rate: the margin as a percentage of the sale price (FR « taux de marque »).

Derived by the server on every save; a value sent here is ignored.

markupRatenumber double

Markup rate: the margin as a percentage of the purchase price (FR « taux de marge »).

Derived by the server on every save; a value sent here is ignored.

metadataobject nullable

Metadata: free-form key/value pairs carried with the product, for an integration to keep its own identifiers and flags against it.

Sent as a PATCH, not a replacement: keys you send are added or updated, keys you leave out keep whatever they held, and a key is removed only when you send it as null. Omitting the property entirely leaves the whole bag untouched, and "" stores an empty value rather than removing the key.

namestring nullable

Name

numberstring nullable

Number

purchasePricenumber double

Purchase price

taxExcludedPricenumber double

Sale price excluding tax.

taxIncludedPricenumber double

Sale price including tax.

type'Product' | 'Service' | 'Text'
unitPricenumber double

<b>Deprecated</b> — use taxExcludedPrice. Unit price, excluding tax: the same value as taxExcludedPrice.

Still populated, and still read on write when neither new price field is sent, so no existing integration has to change today. It used to carry whichever half the product was edited in — the tax-included price when isUnitPriceTaxIncluded was true — because only one price was stored. Both are stored now, so this always reports the tax-excluded one and isUnitPriceTaxIncluded is always false: a client that reads the flag keeps computing the same result.

Changes

  • 4f7fa64cf9e3Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property isUnitPriceTaxIncluded deprecated

    • info

      response property unitPrice deprecated