Apply fee
Note We recommend using the Square API (V2) for all new development when possible.
Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale.
Path Parameters
| Name | Description |
|---|---|
location_id
Required
|
The ID of the fee's associated location. |
item_id
Required
|
The ID of the item to add the fee to. |
fee_id
Required
|
The ID of the fee to apply. |
Response Fields
| Name | Description |
|---|---|
id
|
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
|
The item's name. |
description
|
The item's description. |
type
|
The item's type. This value is NORMAL for almost all items. |
color
|
The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. |
abbreviation
|
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
|
Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. |
available_online
|
If true, the item can be added to shipping orders from the merchant's online store. |
master_image
|
The item's master image, if any. |
category
|
The category the item belongs to, if any. |
variations
|
The item's variations. You must specify at least one variation. |
modifier_lists
|
The modifier lists that apply to the item, if any. |
fees
|
The fees that apply to the item, if any. |
taxable
|
Deprecated. This field is not used. |
category_id
|
The ID of the item's category, if any. |
available_for_pickup
|
If true, the item can be added to pickup orders from the merchant's online store. Default value: false |
v2_id
|
The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID. |
Examples
- cURL
curl https://connect.squareup.com/v1/{location_id}/items/{item_id}/fees/{fee_id} \
-X PUT \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json'