v1

latestOpenAPI 3.0.0Apache 2.02026-07-134699335.3 KB

Items

Create Item

post/pos/items

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

idstring

idempotency_keystring

A value you specify that uniquely identifies this request among requests you have sent.

namestring required

descriptionstring

abbreviationstring

product_type'regular' | 'other'

price_amountnumber

pricing_type'fixed' | 'variable' | 'per_unit' | 'other'

price_currency'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH' nullable

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

costnumber

tax_idsstring[]

A list of Tax IDs for the product.

is_revenueboolean

True if this item should be counted as revenue. For example, gift cards and donations would not be counted as revenue.

use_default_tax_ratesboolean

absent_at_location_idsstring[]

A list of locations where the object is not present, even if present_at_all_locations is true. This can include locations that are deactivated.

present_at_all_locationsboolean

available_for_pickupboolean

available_onlineboolean

skustring

SKU of the item

codestring

Product code, e.g. UPC or EAN

availableboolean nullable

hiddenboolean nullable

versionstring nullable

The user who last updated the object.

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

deletedboolean nullable

Flag to indicate if the object is deleted.

updated_bystring nullable

The user who last updated the object.

created_bystring nullable

The user who created the object.

updated_atstring date-time nullable

The date and time when the object was last updated.

created_atstring date-time nullable

The date and time when the object was created.

Example request

{
  "id": "#cocoa",
  "idempotency_key": "random_string",
  "name": "Cocoa",
  "description": "Hot Chocolate",
  "abbreviation": "Ch",
  "product_type": "regular",
  "price_amount": 10,
  "pricing_type": "fixed",
  "price_currency": "USD",
  "cost": 2,
  "tax_ids": [
    "12345",
    "67890"
  ],
  "absent_at_location_ids": [
    "12345",
    "67890"
  ],
  "sku": "11910345",
  "code": "11910345",
  "categories": [
    {
      "id": "12345",
      "name": "Food",
      "image_ids": [
        "12345",
        "67890"
      ]
    }
  ],
  "options": [
    {
      "id": "12345",
      "name": "Option 1",
      "attribute_id": "12345"
    }
  ],
  "variations": [
    {
      "id": "12345",
      "name": "Food",
      "sku": "11910345",
      "item_id": "12345",
      "sequence": 0,
      "pricing_type": "fixed",
      "price_amount": 10,
      "price_currency": "USD",
      "image_ids": [
        "12345",
        "67890"
      ]
    }
  ],
  "modifier_groups": [
    {
      "id": "12345"
    }
  ],
  "available": true,
  "hidden": true,
  "version": "12345",
  "deleted": true,
  "updated_by": "12345",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

Items

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Items",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}