squareconnect.apis.v1_items_api
All endpoints are relative to Square Connect V2 Documentation
| Method | HTTP request |
|---|---|
| adjust_inventory | POST /v1/{location_id}/inventory/{variation_id} |
| apply_fee | PUT /v1/{location_id}/items/{item_id}/fees/{fee_id} |
| apply_modifier_list | PUT /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} |
| create_category | POST /v1/{location_id}/categories |
| create_discount | POST /v1/{location_id}/discounts |
| create_fee | POST /v1/{location_id}/fees |
| create_item | POST /v1/{location_id}/items |
| create_modifier_list | POST /v1/{location_id}/modifier-lists |
| create_modifier_option | POST /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options |
| create_page | POST /v1/{location_id}/pages |
| create_variation | POST /v1/{location_id}/items/{item_id}/variations |
| delete_category | DELETE /v1/{location_id}/categories/{category_id} |
| delete_discount | DELETE /v1/{location_id}/discounts/{discount_id} |
| delete_fee | DELETE /v1/{location_id}/fees/{fee_id} |
| delete_item | DELETE /v1/{location_id}/items/{item_id} |
| delete_modifier_list | DELETE /v1/{location_id}/modifier-lists/{modifier_list_id} |
| delete_modifier_option | DELETE /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} |
| delete_page | DELETE /v1/{location_id}/pages/{page_id} |
| delete_page_cell | DELETE /v1/{location_id}/pages/{page_id}/cells |
| delete_variation | DELETE /v1/{location_id}/items/{item_id}/variations/{variation_id} |
| list_categories | GET /v1/{location_id}/categories |
| list_discounts | GET /v1/{location_id}/discounts |
| list_fees | GET /v1/{location_id}/fees |
| list_inventory | GET /v1/{location_id}/inventory |
| list_items | GET /v1/{location_id}/items |
| list_modifier_lists | GET /v1/{location_id}/modifier-lists |
| list_pages | GET /v1/{location_id}/pages |
| remove_fee | DELETE /v1/{location_id}/items/{item_id}/fees/{fee_id} |
| remove_modifier_list | DELETE /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} |
| retrieve_item | GET /v1/{location_id}/items/{item_id} |
| retrieve_modifier_list | GET /v1/{location_id}/modifier-lists/{modifier_list_id} |
| update_category | PUT /v1/{location_id}/categories/{category_id} |
| update_discount | PUT /v1/{location_id}/discounts/{discount_id} |
| update_fee | PUT /v1/{location_id}/fees/{fee_id} |
| update_item | PUT /v1/{location_id}/items/{item_id} |
| update_modifier_list | PUT /v1/{location_id}/modifier-lists/{modifier_list_id} |
| update_modifier_option | PUT /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} |
| update_page | PUT /v1/{location_id}/pages/{page_id} |
| update_page_cell | PUT /v1/{location_id}/pages/{page_id}/cells |
| update_variation | PUT /v1/{location_id}/items/{item_id}/variations/{variation_id} |
V1InventoryEntry adjust_inventory(location_id, variation_id, body)
Adjusts an item variation's current available inventory.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| variation_id | str | ||
| body | V1AdjustInventoryRequest |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Item apply_fee(location_id, item_id, fee_id)
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| item_id | str | ||
| fee_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Item apply_modifier_list(location_id, modifier_list_id, item_id)
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| modifier_list_id | str | ||
| item_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Category create_category(location_id, body)
Creates an item category.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| body | V1Category |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Discount create_discount(location_id, body)
Creates a discount.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| body | V1Discount |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Fee create_fee(location_id, body)
Creates a fee (tax).
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| body | V1Fee |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Item create_item(location_id, body)
Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its id. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a user_data string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| body | V1Item |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1ModifierList create_modifier_list(location_id, body)
Creates an item modifier list and at least one modifier option for it.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| body | V1ModifierList |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1ModifierOption create_modifier_option(location_id, modifier_list_id, body)
Creates an item modifier option and adds it to a modifier list.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| modifier_list_id | str | ||
| body | V1ModifierOption |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Page create_page(location_id, body)
Creates a Favorites page in Square Register.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| body | V1Page |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Variation create_variation(location_id, item_id, body)
Creates an item variation for an existing item.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| item_id | str | ||
| body | V1Variation |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Category delete_category(location_id, category_id)
Deletes an existing item category. Note*: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty V1DeleteCategoryRequest object as documented below.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| category_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Discount delete_discount(location_id, discount_id)
Deletes an existing discount. Note*: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty V1DeleteDiscountRequest object as documented below.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| discount_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Fee delete_fee(location_id, fee_id)
Deletes an existing fee (tax). Note*: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty V1DeleteFeeRequest object as documented below.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| fee_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Item delete_item(location_id, item_id)
Deletes an existing item and all item variations associated with it. Note*: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty V1DeleteItemRequest object as documented below.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| item_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1ModifierList delete_modifier_list(location_id, modifier_list_id)
Deletes an existing item modifier list and all modifier options associated with it. Note*: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty V1DeleteModifierListRequest object as documented below.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| modifier_list_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1ModifierOption delete_modifier_option(location_id, modifier_list_id, modifier_option_id)
Deletes an existing item modifier option from a modifier list. Note*: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty V1DeleteModifierOptionRequest object as documented below.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| modifier_list_id | str | ||
| modifier_option_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Page delete_page(location_id, page_id)
Deletes an existing Favorites page and all of its cells. Note*: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty V1DeletePageRequest object as documented below.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| page_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Page delete_page_cell(location_id, page_id, row=row, column=column)
Deletes a cell from a Favorites page in Square Register. Note*: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty V1DeletePageCellRequest object as documented below.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| page_id | str | ||
| row | str | [optional] | |
| column | str | [optional] |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Variation delete_variation(location_id, item_id, variation_id)
Deletes an existing item variation from an item. Note*: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty V1DeleteVariationRequest object as documented below.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| item_id | str | ||
| variation_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[V1Category] list_categories(location_id)
Lists all of a location's item categories.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[V1Discount] list_discounts(location_id)
Lists all of a location's discounts.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[V1Fee] list_fees(location_id)
Lists all of a location's fees (taxes).
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[V1InventoryEntry] list_inventory(location_id, limit=limit, batch_token=batch_token)
Provides inventory information for all of a merchant's inventory-enabled item variations.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| limit | int | [optional] | |
| batch_token | str | [optional] |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[V1Item] list_items(location_id, batch_token=batch_token)
Provides summary information for all of a location's items.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| batch_token | str | [optional] |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[V1ModifierList] list_modifier_lists(location_id)
Lists all of a location's modifier lists.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[V1Page] list_pages(location_id)
Lists all of a location's Favorites pages in Square Register.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Item remove_fee(location_id, item_id, fee_id)
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| item_id | str | ||
| fee_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Item remove_modifier_list(location_id, modifier_list_id, item_id)
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| modifier_list_id | str | ||
| item_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Item retrieve_item(location_id, item_id)
Provides the details for a single item, including associated modifier lists and fees.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| item_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1ModifierList retrieve_modifier_list(location_id, modifier_list_id)
Provides the details for a single modifier list.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| modifier_list_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Category update_category(location_id, category_id, body)
Modifies the details of an existing item category.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| category_id | str | ||
| body | V1Category |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Discount update_discount(location_id, discount_id, body)
Modifies the details of an existing discount.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| discount_id | str | ||
| body | V1Discount |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Fee update_fee(location_id, fee_id, body)
Modifies the details of an existing fee (tax).
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| fee_id | str | ||
| body | V1Fee |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Item update_item(location_id, item_id, body)
Modifies the core details of an existing item.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| item_id | str | ||
| body | V1Item |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1ModifierList update_modifier_list(location_id, modifier_list_id, body)
Modifies the details of an existing item modifier list.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| modifier_list_id | str | ||
| body | V1UpdateModifierListRequest |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1ModifierOption update_modifier_option(location_id, modifier_list_id, modifier_option_id, body)
Modifies the details of an existing item modifier option.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| modifier_list_id | str | ||
| modifier_option_id | str | ||
| body | V1ModifierOption |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Page update_page(location_id, page_id, body)
Modifies the details of a Favorites page in Square Register.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| page_id | str | ||
| body | V1Page |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Page update_page_cell(location_id, page_id, body)
Modifies a cell of a Favorites page in Square Register.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| page_id | str | ||
| body | V1PageCell |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Variation update_variation(location_id, item_id, variation_id, body)
Modifies the details of an existing item variation.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| item_id | str | ||
| variation_id | str | ||
| body | V1Variation |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]