Create item

Create an invoice item

POST /items

Create item

cURL

curl --request POST \
  --url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/items \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "some string",
  "default_taxable": true,
  "type": "service",
  "default_quantity": 10.25,
  "is_automatic_replenishment_by_purchase_order_enabled": true,
  "auto_reorder_level": 1,
  "replenishment_level": "some string",
  "quantity_available": 1
}
'

201

{
  "error": false,
  "response": {}
}

Body raw (json)

{
  "name",// required | max:400 | unique for the company
  "default_taxable",// required | boolean
  "default_description",// optional | string | max:5000
  "type",// required | string | acceptable_values: service,product,reece-item,
  "sku",// nullable | string | max:255 | unique item sku for the company
  "default_unit_price",// optional | numeric
  "default_unit_cost",// optional | numeric
  "default_quantity",// required | numeric | value example 10.25
  "track_inventory",// optional | boolean
  "is_active",// optional | boolean
  "xero_sales_account",// nullable | optional | integer
  "xero_tax_account",// nullable | optional | integer
  "tax_rate",// optional | string | max:255 | value example "10"
  "vendor_id",// nullable | integer | existing vendor id
  "vendor_type",// nullable | string |acceptable_values: integrated,third_party
  "vendor_name",// nullable | string
  "supplier_item_id",// nullable | string | required, if vendor_type is integrated
  "is_automatic_replenishment_by_purchase_order_enabled",// nullable | boolean
  "auto_reorder_level",// optional | integer | required, if is_automatic_replenishment_by_purchase_order_enabled is true
  "replenishment_level",// nullable | required, if is_automatic_replenishment_by_purchase_order_enabled is true | description: must be greater then auto reorder level
  "minimum_order_quantity",//numeric | nullable
  "price_update_method",// optional | string | acceptable_values: set_price_manually,automatic_markup,use_cmp_pricing
  "automatic_markup_percentage",// nullable | string | required, if price_update_method is automatic_markup
  "inventory_mode",// optional | string | acceptable_values: default,serialized_inventory
  "qbo_sales_tax_code_id",// nullable | optional | integer | existing Quickbooks Tax Code Id
  "qbo_purchase_tax_code_id",// nullable | optional | integer | existing Quickbooks Tax Code Id
  "qbo_income_account_id",// nullable | optional | integer | existing Quickbooks Account Id
  "qbo_expense_account_id",// nullable | optional | integer | existing Quickbooks Account Id
  "qbo_asset_account_id",// nullable | optional | integer | existing Quickbooks Account Id
  "qbo_id",// nullable | optional | integer
  "quantity_available",// optional | numeric
  "unit_measure",// optional | string
  "external_id",// nullable | optional | integer
  "external_type",// nullable | optional | string
  "external_sync_status",// nullable | optional | string
  "upc",// nullable | optional | string
  "unit_cost_per_unit_measure",// optional | numeric
  "unit_price_per_unit_measure",// optional | numeric
  "minimum_dimensional_size",// optional | numeric
  "maximum_dimensional_size",// optional | numeric
  "is_round_up_to_even_dimensional_size",// optional | boolean
  "is_labor_item",// optional | boolean
  "inventory_hub_items": [//nullable | array
    {
      "inventory_hub_id",// required | existing inventory hub id
      "is_automatic_replenishment_by_purchase_order_enabled",// required | boolean
      "auto_reorder_level",// required | integer | description: should be greater or equal to 0
      "replenishment_level",// required | integer | description: should be greater or equal to 0
      "quantity_available"// required | numeric
    },
    {
      "inventory_hub_id",// required | existing inventory hub id
      "is_automatic_replenishment_by_purchase_order_enabled",// required | boolean
      "auto_reorder_level",// required | integer | description: should be greater or equal to 0
      "replenishment_level",// required | integer | description: should be greater or equal to 0
      "quantity_available"// required | numeric
    }
  ],
  "item_links": [// optional | array
    {
      "item_id",// nullable | integer | existing item id
      "name",// required | string | max:255
      "url"// required | string | max:255
    },
    {
      "item_id",// nullable | integer | existing item id
      "name",// required | string | max:255
      "url"// required | string | max:255
    }
  ],
  "serialized_inventories": [// nullable | optional | array
    {
      "serial_number",// required | max:255 | unique for the comapny serialized inventories
      "reference_number",// optional | string | max:255
      "asset_template_id",// nullable | integer | existing asset id
      "invoice_id",// required | integer | existing invoice id
      "hub_id",// required | integer | existing inventory hub id
      "id_number",// nullable | string
      "default_unit_cost"// optional | string | max:255
    },
    {
      "serial_number",// required | max:255 | unique for the comapny serialized inventories
      "reference_number",// optional | string | max:255
      "asset_template_id",// nullable | integer | existing asset id
      "invoice_id",// required | integer | existing invoice id
      "hub_id",// required | integer | existing inventory hub id
      "id_number",// nullable | string
      "default_unit_cost"// optional | string | max:255
    }
  ],
  "item_price_tiers": [// nullable | optional | array
    {
      "tier_id",// required | integer | existing Price Tier Id
      "adjustment_property",// required | string | acceptable values: unit_cost, unit_price, list_price
      "adjustment_value"// optional | numeric
    },
    {
      "tier_id",// required | integer | existing Price Tier Id
      "adjustment_property",// required | string | acceptable values: unit_cost, unit_price, list_price
      "adjustment_value"// optional | numeric
    }
  ],
  "customfields": [ // nullable | optional | array | description: array of custom fleds
    {
        "id", // optional | nullable | required if field_instance_id is not set | integer | custom field id
        "field_instance_id", // optional | nullable | required if id is not set | integer | custom field instance id
        "value" // required | string | custom value
    },
    {
        "id", // optional | nullable | required if field_instance_id is not set | integer | custom field id
        "field_instance_id", // optional | nullable | required if id is not set | integer | custom field instance id
        "value" // required | string | custom value
    }
  ],
  "tags"// nullable | optional | array | array of tag ids
}

Authorizations

x-api-key · string · header · required

Body

application/json

name · string · required

Unique for the company.

Maximum string length: 400

default_taxable · boolean · required

type · enum<string> · required

Available options: service, product, reece-item

default_quantity · number · required

default_description · string

Maximum string length: 5000

sku · string | null

Unique item sku for the company.

Maximum string length: 255

default_unit_price · number

default_unit_cost · number

track_inventory · boolean

is_active · boolean

xero_sales_account · integer | null

xero_tax_account · integer | null

tax_rate · string

Maximum string length: 255

vendor_id · integer | null

Existing vendor id.

vendor_type · enum<string> | null

Available options: integrated, third_party

vendor_name · string | null

supplier_item_id · string | null

Required if vendor_type is integrated.

is_automatic_replenishment_by_purchase_order_enabled · boolean | null

auto_reorder_level · integer

Required if is_automatic_replenishment_by_purchase_order_enabled is true.

replenishment_level · string | null

Must be greater then auto reorder level. Required if is_automatic_replenishment_by_purchase_order_enabled is true.

minimum_order_quantity · number | null

price_update_method · enum<string>

Available options: set_price_manually, automatic_markup, use_cmp_pricing

automatic_markup_percentage · string | null

Required if price_update_method is automatic_markup.

inventory_mode · enum<string>

Available options: default, serialized_inventory

qbo_sales_tax_code_id · integer | null

Existing Quickbooks Tax Code Id.

qbo_purchase_tax_code_id · integer | null

Existing Quickbooks Tax Code Id.

qbo_income_account_id · integer | null

Existing Quickbooks Account Id.

qbo_expense_account_id · integer | null

Existing Quickbooks Account Id.

qbo_asset_account_id · integer | null

Existing Quickbooks Account Id.

qbo_id · integer | null

quantity_available · number

unit_measure · string

external_id · integer | null

external_type · string | null

external_sync_status · string | null

upc · string | null

unit_cost_per_unit_measure · number

unit_price_per_unit_measure · number

minimum_dimensional_size · number

maximum_dimensional_size · number

is_round_up_to_even_dimensional_size · boolean

is_labor_item · boolean

inventory_hub_items · object[] | null

Hide child attributes

inventory_hub_items. inventory_hub_id · string · required

Existing inventory hub id.

inventory_hub_items. is_automatic_replenishment_by_purchase_order_enabled · boolean · required

inventory_hub_items. auto_reorder_level · integer · required

Should be greater or equal to 0.

inventory_hub_items. replenishment_level · integer · required

Should be greater or equal to 0.

inventory_hub_items. quantity_available · number · required

item_links · object[]

Hide child attributes

item_links. name · string · required

Maximum string length: 255

item_links. url · string · required

Maximum string length: 255

item_links. item_id · integer | null

Existing item id.

serialized_inventories · object[] | null

Hide child attributes

serialized_inventories. serial_number · string · required

Unique for the company serialized inventories.

Maximum string length: 255

serialized_inventories. invoice_id · integer · required

Existing invoice id.

serialized_inventories. hub_id · integer · required

Existing inventory hub id.

serialized_inventories. reference_number · string

Maximum string length: 255

serialized_inventories. asset_template_id · integer | null

Existing asset id.

serialized_inventories. id_number · string | null

serialized_inventories. default_unit_cost · string

Maximum string length: 255

item_price_tiers · object[] | null

Hide child attributes

item_price_tiers. tier_id · integer · required

Existing Price Tier Id.

item_price_tiers. adjustment_property · enum<string> · required

Available options: unit_cost, unit_price, list_price

item_price_tiers. adjustment_value · number

customfields · object[] | null

Array of custom fields.

Hide child attributes

customfields. value · string · required

Custom value.

customfields. id · integer | null

Required if field_instance_id is not set. Custom field id.

customfields. field_instance_id · integer | null

Required if id is not set. Custom field instance id.

tags · integer[] | null

Array of tag ids.

Response

201

application/json

Created

error · boolean

false when the request succeeds.

Example:

false

response · object

The created record.