IV1ItemsApi v1ItemsApi = client.V1ItemsApi;
V1ItemsApi
- List Categories
- Create Category
- Delete Category
- Update Category
- List Discounts
- Create Discount
- Delete Discount
- Update Discount
- List Fees
- Create Fee
- Delete Fee
- Update Fee
- List Inventory
- Adjust Inventory
- List Items
- Create Item
- Delete Item
- Retrieve Item
- Update Item
- Remove Fee
- Apply Fee
- Remove Modifier List
- Apply Modifier List
- Create Variation
- Delete Variation
- Update Variation
- List Modifier Lists
- Create Modifier List
- Delete Modifier List
- Retrieve Modifier List
- Update Modifier List
- Create Modifier Option
- Delete Modifier Option
- Update Modifier Option
- List Pages
- Create Page
- Delete Page
- Update Page
- Delete Page Cell
- Update Page Cell
Lists all the item categories for a given location.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
ListCategoriesAsync(string locationId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to list categories for. |
string locationId = "location_id4";
try
{
List<V1Category> result = await v1ItemsApi.ListCategoriesAsync(locationId);
}
catch (ApiException e){};
Creates an item category.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
CreateCategoryAsync(string locationId, Models.V1Category body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to create an item for. |
body |
Models.V1Category |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
var body = new V1Category.Builder()
.Build();
try
{
V1Category result = await v1ItemsApi.CreateCategoryAsync(locationId, body);
}
catch (ApiException e){};
Deletes an existing item category.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
DeleteCategory returns nothing on success but Connect SDKs
map the empty response to an empty V1DeleteCategoryRequest
object
as documented below.
DeleteCategoryAsync(string locationId, string categoryId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
categoryId |
string |
Template, Required | The ID of the category to delete. |
string locationId = "location_id4";
string categoryId = "category_id8";
try
{
V1Category result = await v1ItemsApi.DeleteCategoryAsync(locationId, categoryId);
}
catch (ApiException e){};
Modifies the details of an existing item category.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
UpdateCategoryAsync(string locationId, string categoryId, Models.V1Category body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the category's associated location. |
categoryId |
string |
Template, Required | The ID of the category to edit. |
body |
Models.V1Category |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
string categoryId = "category_id8";
var body = new V1Category.Builder()
.Build();
try
{
V1Category result = await v1ItemsApi.UpdateCategoryAsync(locationId, categoryId, body);
}
catch (ApiException e){};
Lists all the discounts for a given location.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
ListDiscountsAsync(string locationId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to list categories for. |
string locationId = "location_id4";
try
{
List<V1Discount> result = await v1ItemsApi.ListDiscountsAsync(locationId);
}
catch (ApiException e){};
Creates a discount.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
CreateDiscountAsync(string locationId, Models.V1Discount body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to create an item for. |
body |
Models.V1Discount |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
var body = new V1Discount.Builder()
.Build();
try
{
V1Discount result = await v1ItemsApi.CreateDiscountAsync(locationId, body);
}
catch (ApiException e){};
Deletes an existing discount.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
DeleteDiscount returns nothing on success but Connect SDKs
map the empty response to an empty V1DeleteDiscountRequest
object
as documented below.
DeleteDiscountAsync(string locationId, string discountId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
discountId |
string |
Template, Required | The ID of the discount to delete. |
string locationId = "location_id4";
string discountId = "discount_id8";
try
{
V1Discount result = await v1ItemsApi.DeleteDiscountAsync(locationId, discountId);
}
catch (ApiException e){};
Modifies the details of an existing discount.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
UpdateDiscountAsync(string locationId, string discountId, Models.V1Discount body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the category's associated location. |
discountId |
string |
Template, Required | The ID of the discount to edit. |
body |
Models.V1Discount |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
string discountId = "discount_id8";
var body = new V1Discount.Builder()
.Build();
try
{
V1Discount result = await v1ItemsApi.UpdateDiscountAsync(locationId, discountId, body);
}
catch (ApiException e){};
Lists all the fees (taxes) for a given location.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
ListFeesAsync(string locationId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to list fees for. |
string locationId = "location_id4";
try
{
List<V1Fee> result = await v1ItemsApi.ListFeesAsync(locationId);
}
catch (ApiException e){};
Creates a fee (tax).
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
CreateFeeAsync(string locationId, Models.V1Fee body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to create a fee for. |
body |
Models.V1Fee |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
var body = new V1Fee.Builder()
.Build();
try
{
V1Fee result = await v1ItemsApi.CreateFeeAsync(locationId, body);
}
catch (ApiException e){};
Deletes an existing fee (tax).
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
DeleteFee returns nothing on success but Connect SDKs
map the empty response to an empty V1DeleteFeeRequest
object
as documented below.
DeleteFeeAsync(string locationId, string feeId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the fee's associated location. |
feeId |
string |
Template, Required | The ID of the fee to delete. |
string locationId = "location_id4";
string feeId = "fee_id8";
try
{
V1Fee result = await v1ItemsApi.DeleteFeeAsync(locationId, feeId);
}
catch (ApiException e){};
Modifies the details of an existing fee (tax).
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
UpdateFeeAsync(string locationId, string feeId, Models.V1Fee body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the fee's associated location. |
feeId |
string |
Template, Required | The ID of the fee to edit. |
body |
Models.V1Fee |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
string feeId = "fee_id8";
var body = new V1Fee.Builder()
.Build();
try
{
V1Fee result = await v1ItemsApi.UpdateFeeAsync(locationId, feeId, body);
}
catch (ApiException e){};
Provides inventory information for all inventory-enabled item variations.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
ListInventoryAsync(string locationId, int? limit = null, string batchToken = null)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
limit |
int? |
Query, Optional | The maximum number of inventory entries to return in a single response. This value cannot exceed 1000. |
batchToken |
string |
Query, Optional | A pagination cursor to retrieve the next set of results for your original query to the endpoint. |
Task<List<Models.V1InventoryEntry>>
string locationId = "location_id4";
try
{
List<V1InventoryEntry> result = await v1ItemsApi.ListInventoryAsync(locationId, null, null);
}
catch (ApiException e){};
Adjusts the current available inventory of an item variation.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
AdjustInventoryAsync(string locationId, string variationId, Models.V1AdjustInventoryRequest body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
variationId |
string |
Template, Required | The ID of the variation to adjust inventory information for. |
body |
Models.V1AdjustInventoryRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
string variationId = "variation_id2";
var body = new V1AdjustInventoryRequest.Builder()
.Build();
try
{
V1InventoryEntry result = await v1ItemsApi.AdjustInventoryAsync(locationId, variationId, body);
}
catch (ApiException e){};
Provides summary information of all items for a given location.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
ListItemsAsync(string locationId, string batchToken = null)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to list items for. |
batchToken |
string |
Query, Optional | A pagination cursor to retrieve the next set of results for your original query to the endpoint. |
string locationId = "location_id4";
try
{
List<V1Item> result = await v1ItemsApi.ListItemsAsync(locationId, null);
}
catch (ApiException e){};
Creates an item and at least one variation for it.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
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 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.
CreateItemAsync(string locationId, Models.V1Item body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to create an item for. |
body |
Models.V1Item |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
var body = new V1Item.Builder()
.Build();
try
{
V1Item result = await v1ItemsApi.CreateItemAsync(locationId, body);
}
catch (ApiException e){};
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.
DeleteItemAsync(string locationId, string itemId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
itemId |
string |
Template, Required | The ID of the item to modify. |
string locationId = "location_id4";
string itemId = "item_id0";
try
{
V1Item result = await v1ItemsApi.DeleteItemAsync(locationId, itemId);
}
catch (ApiException e){};
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
RetrieveItemAsync(string locationId, string itemId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
itemId |
string |
Template, Required | The item's ID. |
string locationId = "location_id4";
string itemId = "item_id0";
try
{
V1Item result = await v1ItemsApi.RetrieveItemAsync(locationId, itemId);
}
catch (ApiException e){};
Modifies the core details of an existing item.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
UpdateItemAsync(string locationId, string itemId, Models.V1Item body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
itemId |
string |
Template, Required | The ID of the item to modify. |
body |
Models.V1Item |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
string itemId = "item_id0";
var body = new V1Item.Builder()
.Build();
try
{
V1Item result = await v1ItemsApi.UpdateItemAsync(locationId, itemId, body);
}
catch (ApiException e){};
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
RemoveFeeAsync(string locationId, string itemId, string feeId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the fee's associated location. |
itemId |
string |
Template, Required | The ID of the item to add the fee to. |
feeId |
string |
Template, Required | The ID of the fee to apply. |
string locationId = "location_id4";
string itemId = "item_id0";
string feeId = "fee_id8";
try
{
V1Item result = await v1ItemsApi.RemoveFeeAsync(locationId, itemId, feeId);
}
catch (ApiException e){};
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
ApplyFeeAsync(string locationId, string itemId, string feeId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the fee's associated location. |
itemId |
string |
Template, Required | The ID of the item to add the fee to. |
feeId |
string |
Template, Required | The ID of the fee to apply. |
string locationId = "location_id4";
string itemId = "item_id0";
string feeId = "fee_id8";
try
{
V1Item result = await v1ItemsApi.ApplyFeeAsync(locationId, itemId, feeId);
}
catch (ApiException e){};
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
RemoveModifierListAsync(string locationId, string modifierListId, string itemId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
modifierListId |
string |
Template, Required | The ID of the modifier list to remove. |
itemId |
string |
Template, Required | The ID of the item to remove the modifier list from. |
string locationId = "location_id4";
string modifierListId = "modifier_list_id6";
string itemId = "item_id0";
try
{
V1Item result = await v1ItemsApi.RemoveModifierListAsync(locationId, modifierListId, itemId);
}
catch (ApiException e){};
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
ApplyModifierListAsync(string locationId, string modifierListId, string itemId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
modifierListId |
string |
Template, Required | The ID of the modifier list to apply. |
itemId |
string |
Template, Required | The ID of the item to add the modifier list to. |
string locationId = "location_id4";
string modifierListId = "modifier_list_id6";
string itemId = "item_id0";
try
{
V1Item result = await v1ItemsApi.ApplyModifierListAsync(locationId, modifierListId, itemId);
}
catch (ApiException e){};
Creates an item variation for an existing item.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
CreateVariationAsync(string locationId, string itemId, Models.V1Variation body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
itemId |
string |
Template, Required | The item's ID. |
body |
Models.V1Variation |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
string itemId = "item_id0";
var body = new V1Variation.Builder()
.Build();
try
{
V1Variation result = await v1ItemsApi.CreateVariationAsync(locationId, itemId, body);
}
catch (ApiException e){};
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.
DeleteVariationAsync(string locationId, string itemId, string variationId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
itemId |
string |
Template, Required | The ID of the item to delete. |
variationId |
string |
Template, Required | The ID of the variation to delete. |
string locationId = "location_id4";
string itemId = "item_id0";
string variationId = "variation_id2";
try
{
V1Variation result = await v1ItemsApi.DeleteVariationAsync(locationId, itemId, variationId);
}
catch (ApiException e){};
Modifies the details of an existing item variation.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
UpdateVariationAsync(
string locationId,
string itemId,
string variationId,
Models.V1Variation body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
itemId |
string |
Template, Required | The ID of the item to modify. |
variationId |
string |
Template, Required | The ID of the variation to modify. |
body |
Models.V1Variation |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
string itemId = "item_id0";
string variationId = "variation_id2";
var body = new V1Variation.Builder()
.Build();
try
{
V1Variation result = await v1ItemsApi.UpdateVariationAsync(locationId, itemId, variationId, body);
}
catch (ApiException e){};
Lists all the modifier lists for a given location.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
ListModifierListsAsync(string locationId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to list modifier lists for. |
Task<List<Models.V1ModifierList>>
string locationId = "location_id4";
try
{
List<V1ModifierList> result = await v1ItemsApi.ListModifierListsAsync(locationId);
}
catch (ApiException e){};
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
CreateModifierListAsync(string locationId, Models.V1ModifierList body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to create a modifier list for. |
body |
Models.V1ModifierList |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
var body = new V1ModifierList.Builder()
.Build();
try
{
V1ModifierList result = await v1ItemsApi.CreateModifierListAsync(locationId, body);
}
catch (ApiException e){};
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.
DeleteModifierListAsync(string locationId, string modifierListId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
modifierListId |
string |
Template, Required | The ID of the modifier list to delete. |
string locationId = "location_id4";
string modifierListId = "modifier_list_id6";
try
{
V1ModifierList result = await v1ItemsApi.DeleteModifierListAsync(locationId, modifierListId);
}
catch (ApiException e){};
Provides the details for a single modifier list.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
RetrieveModifierListAsync(string locationId, string modifierListId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
modifierListId |
string |
Template, Required | The modifier list's ID. |
string locationId = "location_id4";
string modifierListId = "modifier_list_id6";
try
{
V1ModifierList result = await v1ItemsApi.RetrieveModifierListAsync(locationId, modifierListId);
}
catch (ApiException e){};
Modifies the details of an existing item modifier list.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
UpdateModifierListAsync(string locationId, string modifierListId, Models.V1UpdateModifierListRequest body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
modifierListId |
string |
Template, Required | The ID of the modifier list to edit. |
body |
Models.V1UpdateModifierListRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
string modifierListId = "modifier_list_id6";
var body = new V1UpdateModifierListRequest.Builder()
.Build();
try
{
V1ModifierList result = await v1ItemsApi.UpdateModifierListAsync(locationId, modifierListId, body);
}
catch (ApiException e){};
Creates an item modifier option and adds it to a modifier list.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
CreateModifierOptionAsync(string locationId, string modifierListId, Models.V1ModifierOption body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
modifierListId |
string |
Template, Required | The ID of the modifier list to edit. |
body |
Models.V1ModifierOption |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
string modifierListId = "modifier_list_id6";
var body = new V1ModifierOption.Builder()
.Build();
try
{
V1ModifierOption result = await v1ItemsApi.CreateModifierOptionAsync(locationId, modifierListId, body);
}
catch (ApiException e){};
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.
DeleteModifierOptionAsync(string locationId, string modifierListId, string modifierOptionId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
modifierListId |
string |
Template, Required | The ID of the modifier list to delete. |
modifierOptionId |
string |
Template, Required | The ID of the modifier list to edit. |
string locationId = "location_id4";
string modifierListId = "modifier_list_id6";
string modifierOptionId = "modifier_option_id6";
try
{
V1ModifierOption result = await v1ItemsApi.DeleteModifierOptionAsync(locationId, modifierListId, modifierOptionId);
}
catch (ApiException e){};
Modifies the details of an existing item modifier option.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
UpdateModifierOptionAsync(
string locationId,
string modifierListId,
string modifierOptionId,
Models.V1ModifierOption body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the item's associated location. |
modifierListId |
string |
Template, Required | The ID of the modifier list to edit. |
modifierOptionId |
string |
Template, Required | The ID of the modifier list to edit. |
body |
Models.V1ModifierOption |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
string modifierListId = "modifier_list_id6";
string modifierOptionId = "modifier_option_id6";
var body = new V1ModifierOption.Builder()
.Build();
try
{
V1ModifierOption result = await v1ItemsApi.UpdateModifierOptionAsync(locationId, modifierListId, modifierOptionId, body);
}
catch (ApiException e){};
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
ListPagesAsync(string locationId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to list Favorites pages for. |
string locationId = "location_id4";
try
{
List<V1Page> result = await v1ItemsApi.ListPagesAsync(locationId);
}
catch (ApiException e){};
Creates a Favorites page in Square Point of Sale.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
CreatePageAsync(string locationId, Models.V1Page body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to create an item for. |
body |
Models.V1Page |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
var body = new V1Page.Builder()
.Build();
try
{
V1Page result = await v1ItemsApi.CreatePageAsync(locationId, body);
}
catch (ApiException e){};
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.
DeletePageAsync(string locationId, string pageId)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the Favorites page's associated location. |
pageId |
string |
Template, Required | The ID of the page to delete. |
string locationId = "location_id4";
string pageId = "page_id0";
try
{
V1Page result = await v1ItemsApi.DeletePageAsync(locationId, pageId);
}
catch (ApiException e){};
Modifies the details of a Favorites page in Square Point of Sale.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
UpdatePageAsync(string locationId, string pageId, Models.V1Page body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the Favorites page's associated location |
pageId |
string |
Template, Required | The ID of the page to modify. |
body |
Models.V1Page |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
string pageId = "page_id0";
var body = new V1Page.Builder()
.Build();
try
{
V1Page result = await v1ItemsApi.UpdatePageAsync(locationId, pageId, body);
}
catch (ApiException e){};
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.
DeletePageCellAsync(
string locationId,
string pageId,
string row = null,
string column = null)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the Favorites page's associated location. |
pageId |
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. |
string locationId = "location_id4";
string pageId = "page_id0";
try
{
V1Page result = await v1ItemsApi.DeletePageCellAsync(locationId, pageId, null, null);
}
catch (ApiException e){};
Modifies a cell of a Favorites page in Square Point of Sale.
- Deprecation date: 2019-11-20
- Retirement date: 2020-11-18
- Migration guide
UpdatePageCellAsync(string locationId, string pageId, Models.V1PageCell body)
Parameter | Type | Tags | Description |
---|---|---|---|
locationId |
string |
Template, Required | The ID of the Favorites page's associated location. |
pageId |
string |
Template, Required | The ID of the page the cell belongs to. |
body |
Models.V1PageCell |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
string locationId = "location_id4";
string pageId = "page_id0";
var body = new V1PageCell.Builder()
.Build();
try
{
V1Page result = await v1ItemsApi.UpdatePageCellAsync(locationId, pageId, body);
}
catch (ApiException e){};