Items

The Item object is used to represent an item that a company buys, sells, or resells, such as products and services.

The Item object

Properties


idString
Optional

remote_idString
Optional
The third-party API ID of the matching object.

remote_dataRemoteData[]
Optional

nameString
Optional
The item's name.

statusEnum
Optional
The item's status. Possible values include: ACTIVE, ARCHIVED, or - in cases where there is no clear mapping - the original value passed through.

unit_priceNumber
Optional
The item's unit price.

purchase_priceNumber
Optional
The item's purchase price.

purchase_accountString
Optional
The item's purchase account.

sales_accountString
Optional
The item's sales account.

remote_updated_atString
Optional
When the third party's item note was updated.

The Item object

{
  "id": "d2f972d0-2526-434b-9409-4c3b468e08f0",
  "remote_id": "12374",
  "remote_data": [
    {
      "path": "/actions",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "name": "Pickleball Paddle",
  "status": "ACTIVE",
  "unit_price": 10,
  "purchase_price": 25,
  "purchase_account": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
  "sales_account": "3872b4c9-f5d2-4f3b-a66b-dfedbed42c49",
  "remote_updated_at": "2020-03-31T00:00:00Z"
}

GET

/items

Returns a list of Item objects.


Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

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

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "d2f972d0-2526-434b-9409-4c3b468e08f0",
      "remote_id": "12374",
      "remote_data": [
        {
          "path": "/actions",
          "data": [
            "Varies by platform"
          ]
        }
      ],
      "name": "Pickleball Paddle",
      "status": "ACTIVE",
      "unit_price": 10,
      "purchase_price": 25,
      "purchase_account": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
      "sales_account": "3872b4c9-f5d2-4f3b-a66b-dfedbed42c49",
      "remote_updated_at": "2020-03-31T00:00:00Z"
    }
  ]
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_updated_atString

unit_priceNumber

remote_dataRemoteData[]

purchase_priceNumber

statusEnum

nameString

purchase_accountString

remote_idString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_updated_atString

unit_priceNumber

remote_dataRemoteData[]

purchase_priceNumber

sales_accountString

statusEnum

nameString

purchase_accountString

remote_idString
GET

/items/{id}

Returns an Item object with the given id.


Query & Path Parameters


idString
Required

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

Response

{
  "id": "d2f972d0-2526-434b-9409-4c3b468e08f0",
  "remote_id": "12374",
  "remote_data": [
    {
      "path": "/actions",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "name": "Pickleball Paddle",
  "status": "ACTIVE",
  "unit_price": 10,
  "purchase_price": 25,
  "purchase_account": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
  "sales_account": "3872b4c9-f5d2-4f3b-a66b-dfedbed42c49",
  "remote_updated_at": "2020-03-31T00:00:00Z"
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_updated_atString

unit_priceNumber

remote_dataRemoteData[]

purchase_priceNumber

statusEnum

nameString

purchase_accountString

remote_idString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_updated_atString

unit_priceNumber

remote_dataRemoteData[]

purchase_priceNumber

sales_accountString

statusEnum

nameString

purchase_accountString

remote_idString