• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Delete item
V1
Square V1 APIs

We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

Deprecated
Effective November 20th, 2019

Deletes an existing item and all item variations associated with it.

DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty V1DeleteItemRequest object as documented below.

Required permissions: ITEMS_WRITE

Deprecation date

2019-11-20

Retirement date

2020-11-18

Replaced by

DeleteCatalogObject
Migration guide

Path Parameters

Name Description
location_id
string

Required

The ID of the item's associated location.

item_id
string

Required

The ID of the item to modify.

Response Fields

Name Description
id
string

The item's ID. Must be unique among all entity IDs ever provided on behalf of the merchant. You can never reuse an ID. This value can include alphanumeric characters, dashes (-), and underscores (_).

name
string

The item's name.

description
string

The item's description.

type
string

The item's type. This value is NORMAL for almost all items.

color
string

The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6.

abbreviation
string

The text of the item's display label in Square Point of Sale. Only up to the first five characters of the string are used.

visibility
string

Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE.

available_online
boolean

If true, the item can be added to shipping orders from the merchant's online store.

master_image
ItemImage

The item's master image, if any.

category
Category

The category the item belongs to, if any.

variations
Variation [ ]

The item's variations. You must specify at least one variation.

modifier_lists
ModifierList [ ]

The modifier lists that apply to the item, if any.

fees
Fee [ ]

The fees that apply to the item, if any.

taxable
boolean

Deprecated. This field is not used.

category_id
string

The ID of the item's category, if any.

available_for_pickup
boolean

If true, the item can be added to pickup orders from the merchant's online store. Default value: false

v2_id
string

The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.

Examples

You are viewing an old version of the API
DELETE /v1/{location_id}/items/{item_id}
cURL
  • cURL
curl https://connect.squareup.com/v1/location_id0/items/item_id1 \
  -X DELETE \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?