/items/{id}

from merge import Merge
from merge.resources.accounting import PatchedItemRequestRequest
client = Merge(
    account_token="YOUR_ACCOUNT_TOKEN",
    api_key="YOUR_API_KEY",
)
client.accounting.items.partial_update(
    id="id",
    model=PatchedItemRequestRequest(),
)

{
  "model": {
    "id": "d2f972d0-2526-434b-9409-4c3b468e08f0",
    "remote_id": "12374",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
    "name": "Pickleball Paddle",
    "status": "ACTIVE",
    "type": "INVENTORY",
    "unit_price": 10,
    "purchase_price": 25,
    "purchase_account": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
    "sales_account": "3872b4c9-f5d2-4f3b-a66b-dfedbed42c49",
    "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
    "purchase_tax_rate": "983e8f97-9qw2-34v9-p123-67bdf98740v5",
    "sales_tax_rate": "232c8f56-7se4-98f2-y334-12bdf89249f5",
    "remote_updated_at": "2020-03-31T00:00:00Z",
    "remote_was_deleted": true,
    "field_mappings": {
      "organization_defined_targets": {
        "custom_key": "custom_value"
      },
      "linked_account_defined_targets": {
        "custom_key": "custom_value"
      }
    },
    "remote_data": [
      {
        "path": "/actions"
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Updates an Item object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

Description

The Item object refers to the goods involved in a transaction.

Usage Example

Fetch from the LIST Items endpoint and view a company’s items.

Response

modelobject

Description

The Item object refers to the goods involved in a transaction.

Usage Example

Fetch from the LIST Items endpoint and view a company’s items.

warningslist of objects

errorslist of objects

logslist of objects or null

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The item's name.

statusenum or nullOptional

The item’s status.

ACTIVE - ACTIVE
ARCHIVED - ARCHIVED

Allowed values:

typeenum or nullOptional

The item’s type.

INVENTORY - INVENTORY
NON_INVENTORY - NON_INVENTORY
SERVICE - SERVICE
UNKNOWN - UNKNOWN

Allowed values:

unit_pricedouble or nullOptional

The item's unit price.

purchase_pricedouble or nullOptional

The price at which the item is purchased from a vendor.

purchase_accountstring or nullOptionalformat: "uuid"

References the default account used to record a purchase of the item.

sales_accountstring or nullOptionalformat: "uuid"

References the default account used to record a sale.

remote_updated_atdatetime or nullOptional

When the third party's item note was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The item's name.

typeenum or nullOptional

The item’s type.

INVENTORY - INVENTORY
NON_INVENTORY - NON_INVENTORY
SERVICE - SERVICE
UNKNOWN - UNKNOWN

Allowed values:

unit_pricedouble or nullOptional

The item's unit price.

purchase_pricedouble or nullOptional

The price at which the item is purchased from a vendor.

purchase_accountstring or nullOptionalformat: "uuid"

References the default account used to record a purchase of the item.

sales_accountstring or nullOptionalformat: "uuid"

References the default account used to record a sale.

remote_updated_atdatetime or nullOptional

When the third party's item note was updated.

Authentication

Path parameters

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Field support by integration