Square · Example Payload

Catalog Item Example

Sample Square record.

RestaurantBookingsCatalogCheckoutCustomersDisputesEcommerceFinancial TechnologyGift CardsInventoryInvoicingLaborLocationsLoyaltyMerchantsOrdersPaymentsPoint of SaleRefundsRetailSubscriptionsTeamTerminalWebhooks

Catalog Item Example is an example object payload from Square, with 19 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

namedescriptiondescription_htmlabbreviationlabel_coloris_taxablecategory_idcategoriestax_idsmodifier_list_infovariationsproduct_typeskip_modifier_screenitem_optionsimage_idssort_namereporting_categorychannelsis_archived

Example Payload

Raw ↑ 
{
  "name": "Annie\u2019s Hot Sauce",
  "description": "Sample Square record.",
  "description_html": "Sample Square record.",
  "abbreviation": "SAMPLESAMPLE",
  "label_color": "sample-value",
  "is_taxable": true,
  "category_id": "A1B2C3D4E5F6",
  "categories": [
    {
      "id": "A1B2C3D4E5F6",
      "ordinal": 677
    },
    {
      "id": "A1B2C3D4E5F6",
      "ordinal": 314
    }
  ],
  "tax_ids": [
    "sample-value"
  ],
  "modifier_list_info": [
    {
      "modifier_list_id": "A1B2C3D4E5F6",
      "min_selected_modifiers": 50,
      "max_selected_modifiers": 658,
      "enabled": true
    },
    {
      "modifier_list_id": "A1B2C3D4E5F6",
      "min_selected_modifiers": 389,
      "max_selected_modifiers": 8,
      "enabled": false
    }
  ],
  "variations": [
    {
      "id": "A1B2C3D4E5F6",
      "type": "ITEM_VARIATION",
      "item_variation_data": {
        "item_id": "A1B2C3D4E5F6",
        "name": "Annie\u2019s Hot Sauce",
        "sku": "sample-value",
        "upc": "sample-value",
        "pricing_type": "VARIABLE_PRICING",
        "price_money": {
          "amount": 45125,
          "currency": "USD"
        },
        "track_inventory": true,
        "sellable": false,
        "stockable": true
      }
    },
    {
      "id": "A1B2C3D4E5F6",
      "type": "ITEM_VARIATION",
      "item_variation_data": {
        "item_id": "A1B2C3D4E5F6",
        "name": "Annie\u2019s Hot Sauce",
        "sku": "sample-value",
        "upc": "sample-value",
        "pricing_type": "FIXED_PRICING",
        "price_money": {
          "amount": 26383,
          "currency": "USD"
        },
        "track_inventory": false,
        "sellable": true,
        "stockable": true
      }
    }
  ],
  "product_type": "GIFT_CARD",
  "skip_modifier_screen": false,
  "item_options": [
    {
      "item_option_id": "A1B2C3D4E5F6"
    }
  ],
  "image_ids": [
    "sample-value"
  ],
  "sort_name": "sample-value",
  "reporting_category": {
    "id": "A1B2C3D4E5F6",
    "ordinal": 93
  },
  "channels": [
    "sample-value",
    "sample-value"
  ],
  "is_archived": false
}