Common ModelsItems

/items/{id}

Returns an Item object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:
show_enum_originsenumOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
Allowed values:

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
namestring or null
The item's name.
statusenum or null
The item's status. * `ACTIVE` - ACTIVE * `ARCHIVED` - ARCHIVED
Allowed values:
typeenum or null
The item's type. * `INVENTORY` - INVENTORY * `NON_INVENTORY` - NON_INVENTORY * `SERVICE` - SERVICE * `UNKNOWN` - UNKNOWN
Allowed values:
unit_pricedouble or null
The item's unit price.
purchase_pricedouble or null
The price at which the item is purchased from a vendor.
purchase_accountstring or nullformat: "uuid"
References the default account used to record a purchase of the item.
sales_accountstring or nullformat: "uuid"
References the default account used to record a sale.
companystring or nullformat: "uuid"
The company the item belongs to.
purchase_tax_ratestring or nullformat: "uuid"
The default purchase tax rate for this item.
sales_tax_ratestring or nullformat: "uuid"
The default sales tax rate for this item.
remote_updated_atdatetime or null
When the third party's item note was updated.
remote_was_deletedbooleanRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only