Search code, repositories, users, issues, pull requests...

Example Usage

location_id = 'location_id4'
body = {}

result = v1_items_api.create_item(location_id, body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Delete Item

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

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

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

def delete_item(self,
               location_id,
               item_id)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`item_id`	`string`	Template, Required	The ID of the item to modify.

Response Type

Example Usage

location_id = 'location_id4'
item_id = 'item_id0'

result = v1_items_api.delete_item(location_id, item_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Retrieve Item

Provides the details for a single item, including associated modifier lists and fees.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def retrieve_item(self,
                 location_id,
                 item_id)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`item_id`	`string`	Template, Required	The item's ID.

Response Type

Example Usage

location_id = 'location_id4'
item_id = 'item_id0'

result = v1_items_api.retrieve_item(location_id, item_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Update Item

Modifies the core details of an existing item.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def update_item(self,
               location_id,
               item_id,
               body)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`item_id`	`string`	Template, Required	The ID of the item to modify.
`body`	`V1 Item`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Example Usage

location_id = 'location_id4'
item_id = 'item_id0'
body = {}

result = v1_items_api.update_item(location_id, item_id, body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Remove Fee

Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def remove_fee(self,
              location_id,
              item_id,
              fee_id)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the fee's associated location.
`item_id`	`string`	Template, Required	The ID of the item to add the fee to.
`fee_id`	`string`	Template, Required	The ID of the fee to apply.

Response Type

Example Usage

location_id = 'location_id4'
item_id = 'item_id0'
fee_id = 'fee_id8'

result = v1_items_api.remove_fee(location_id, item_id, fee_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Apply Fee

Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def apply_fee(self,
             location_id,
             item_id,
             fee_id)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the fee's associated location.
`item_id`	`string`	Template, Required	The ID of the item to add the fee to.
`fee_id`	`string`	Template, Required	The ID of the fee to apply.

Response Type

Example Usage

location_id = 'location_id4'
item_id = 'item_id0'
fee_id = 'fee_id8'

result = v1_items_api.apply_fee(location_id, item_id, fee_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Remove Modifier List

Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def remove_modifier_list(self,
                        location_id,
                        modifier_list_id,
                        item_id)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`modifier_list_id`	`string`	Template, Required	The ID of the modifier list to remove.
`item_id`	`string`	Template, Required	The ID of the item to remove the modifier list from.

Response Type

Example Usage

location_id = 'location_id4'
modifier_list_id = 'modifier_list_id6'
item_id = 'item_id0'

result = v1_items_api.remove_modifier_list(location_id, modifier_list_id, item_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Apply Modifier List

Associates a modifier list with an item so the associated modifier options can be applied to the item.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def apply_modifier_list(self,
                       location_id,
                       modifier_list_id,
                       item_id)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`modifier_list_id`	`string`	Template, Required	The ID of the modifier list to apply.
`item_id`	`string`	Template, Required	The ID of the item to add the modifier list to.

Response Type

List of V1 Modifier List

Example Usage

location_id = 'location_id4'
modifier_list_id = 'modifier_list_id6'
item_id = 'item_id0'

result = v1_items_api.apply_modifier_list(location_id, modifier_list_id, item_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Create Variation

Creates an item variation for an existing item.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def create_variation(self,
                    location_id,
                    item_id,
                    body)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`item_id`	`string`	Template, Required	The item's ID.
`body`	`V1 Variation`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

V1 Variation

Example Usage

location_id = 'location_id4'
item_id = 'item_id0'
body = {}

result = v1_items_api.create_variation(location_id, item_id, body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Delete Variation

Deletes an existing item variation from an item.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

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

def delete_variation(self,
                    location_id,
                    item_id,
                    variation_id)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`item_id`	`string`	Template, Required	The ID of the item to delete.
`variation_id`	`string`	Template, Required	The ID of the variation to delete.

Response Type

V1 Variation

Example Usage

location_id = 'location_id4'
item_id = 'item_id0'
variation_id = 'variation_id2'

result = v1_items_api.delete_variation(location_id, item_id, variation_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Update Variation

Modifies the details of an existing item variation.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def update_variation(self,
                    location_id,
                    item_id,
                    variation_id,
                    body)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`item_id`	`string`	Template, Required	The ID of the item to modify.
`variation_id`	`string`	Template, Required	The ID of the variation to modify.
`body`	`V1 Variation`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

V1 Variation

Example Usage

location_id = 'location_id4'
item_id = 'item_id0'
variation_id = 'variation_id2'
body = {}

result = v1_items_api.update_variation(location_id, item_id, variation_id, body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

List Modifier Lists

Lists all the modifier lists for a given location.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def list_modifier_lists(self,
                       location_id)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the location to list modifier lists for.

Response Type

Example Usage

location_id = 'location_id4'

result = v1_items_api.list_modifier_lists(location_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Create Modifier List

Creates an item modifier list and at least 1 modifier option for it.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def create_modifier_list(self,
                        location_id,
                        body)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the location to create a modifier list for.
`body`	`V1 Modifier List`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Example Usage

location_id = 'location_id4'
body = {}

result = v1_items_api.create_modifier_list(location_id, body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Delete Modifier List

Deletes an existing item modifier list and all modifier options associated with it.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

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

def delete_modifier_list(self,
                        location_id,
                        modifier_list_id)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`modifier_list_id`	`string`	Template, Required	The ID of the modifier list to delete.

Response Type

Example Usage

location_id = 'location_id4'
modifier_list_id = 'modifier_list_id6'

result = v1_items_api.delete_modifier_list(location_id, modifier_list_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Retrieve Modifier List

Provides the details for a single modifier list.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def retrieve_modifier_list(self,
                          location_id,
                          modifier_list_id)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`modifier_list_id`	`string`	Template, Required	The modifier list's ID.

Response Type

Example Usage

location_id = 'location_id4'
modifier_list_id = 'modifier_list_id6'

result = v1_items_api.retrieve_modifier_list(location_id, modifier_list_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Update Modifier List

Modifies the details of an existing item modifier list.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def update_modifier_list(self,
                        location_id,
                        modifier_list_id,
                        body)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`modifier_list_id`	`string`	Template, Required	The ID of the modifier list to edit.
`body`	`V1 Update Modifier List Request`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Example Usage

location_id = 'location_id4'
modifier_list_id = 'modifier_list_id6'
body = {}

result = v1_items_api.update_modifier_list(location_id, modifier_list_id, body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Create Modifier Option

Creates an item modifier option and adds it to a modifier list.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def create_modifier_option(self,
                          location_id,
                          modifier_list_id,
                          body)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`modifier_list_id`	`string`	Template, Required	The ID of the modifier list to edit.
`body`	`V1 Modifier Option`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

V1 Modifier Option

Example Usage

location_id = 'location_id4'
modifier_list_id = 'modifier_list_id6'
body = {}

result = v1_items_api.create_modifier_option(location_id, modifier_list_id, body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Delete Modifier Option

Deletes an existing item modifier option from a modifier list.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty V1DeleteModifierOptionRequest object.

def delete_modifier_option(self,
                          location_id,
                          modifier_list_id,
                          modifier_option_id)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`modifier_list_id`	`string`	Template, Required	The ID of the modifier list to delete.
`modifier_option_id`	`string`	Template, Required	The ID of the modifier list to edit.

Response Type

V1 Modifier Option

Example Usage

location_id = 'location_id4'
modifier_list_id = 'modifier_list_id6'
modifier_option_id = 'modifier_option_id6'

result = v1_items_api.delete_modifier_option(location_id, modifier_list_id, modifier_option_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Update Modifier Option

Modifies the details of an existing item modifier option.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def update_modifier_option(self,
                          location_id,
                          modifier_list_id,
                          modifier_option_id,
                          body)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the item's associated location.
`modifier_list_id`	`string`	Template, Required	The ID of the modifier list to edit.
`modifier_option_id`	`string`	Template, Required	The ID of the modifier list to edit.
`body`	`V1 Modifier Option`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

V1 Modifier Option

Example Usage

location_id = 'location_id4'
modifier_list_id = 'modifier_list_id6'
modifier_option_id = 'modifier_option_id6'
body = {}

result = v1_items_api.update_modifier_option(location_id, modifier_list_id, modifier_option_id, body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

List Pages

Lists all Favorites pages (in Square Point of Sale) for a given location.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def list_pages(self,
              location_id)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the location to list Favorites pages for.

Response Type

List of V1 Page

Example Usage

location_id = 'location_id4'

result = v1_items_api.list_pages(location_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Create Page

Creates a Favorites page in Square Point of Sale.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def create_page(self,
               location_id,
               body)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the location to create an item for.
`body`	`V1 Page`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Example Usage

location_id = 'location_id4'
body = {}

result = v1_items_api.create_page(location_id, body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Delete Page

Deletes an existing Favorites page and all of its cells.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

DeletePage returns nothing on success but Connect SDKs map the empty response to an empty V1DeletePageRequest object.

def delete_page(self,
               location_id,
               page_id)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the Favorites page's associated location.
`page_id`	`string`	Template, Required	The ID of the page to delete.

Response Type

Example Usage

location_id = 'location_id4'
page_id = 'page_id0'

result = v1_items_api.delete_page(location_id, page_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Update Page

Modifies the details of a Favorites page in Square Point of Sale.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def update_page(self,
               location_id,
               page_id,
               body)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the Favorites page's associated location
`page_id`	`string`	Template, Required	The ID of the page to modify.
`body`	`V1 Page`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Example Usage

location_id = 'location_id4'
page_id = 'page_id0'
body = {}

result = v1_items_api.update_page(location_id, page_id, body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Delete Page Cell

Deletes a cell from a Favorites page in Square Point of Sale.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

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

def delete_page_cell(self,
                    location_id,
                    page_id,
                    row=None,
                    column=None)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the Favorites page's associated location.
`page_id`	`string`	Template, Required	The ID of the page to delete.
`row`	`string`	Query, Optional	The row of the cell to clear. Always an integer between 0 and 4, inclusive. Row 0 is the top row.
`column`	`string`	Query, Optional	The column of the cell to clear. Always an integer between 0 and 4, inclusive. Column 0 is the leftmost column.

Response Type

Example Usage

location_id = 'location_id4'
page_id = 'page_id0'

result = v1_items_api.delete_page_cell(location_id, page_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.body)

Update Page Cell

Modifies a cell of a Favorites page in Square Point of Sale.

Deprecation date: 2019-11-20
Retirement date: 2020-11-18
Migration guide

def update_page_cell(self,
                    location_id,
                    page_id,
                    body)

Parameters

Parameter	Type	Tags	Description
`location_id`	`string`	Template, Required	The ID of the Favorites page's associated location.
`page_id`	`string`	Template, Required	The ID of the page the cell belongs to.
`body`	`V1 Page Cell`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type