Catalog

catalog_api = client.catalog

Class Name

CatalogApi

Methods

Batch Delete Catalog Objects
Batch Retrieve Catalog Objects
Batch Upsert Catalog Objects
Create Catalog Image
Update Catalog Image
Catalog Info
List Catalog
Upsert Catalog Object
Delete Catalog Object
Retrieve Catalog Object
Search Catalog Objects
Search Catalog Items
Update Item Modifier Lists
Update Item Taxes

Batch Delete Catalog Objects

Deletes a set of CatalogItems based on the provided list of target IDs and returns a set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. For example, deleting a CatalogItem will also delete all of its CatalogItemVariation children.

BatchDeleteCatalogObjects succeeds even if only a portion of the targeted IDs can be deleted. The response will only include IDs that were actually deleted.

def batch_delete_catalog_objects(body:)

Parameters

Parameter	Type	Tags	Description
`body`	`Batch Delete Catalog Objects Request Hash`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Batch Delete Catalog Objects Response Hash

Example Usage

body = {}
body[:object_ids] = ['W62UWFY35CWMYGVWK6TWJDNI', 'AA27W3M2GGTF3H6AVPNB77CK']

result = catalog_api.batch_delete_catalog_objects(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Batch Retrieve Catalog Objects

Returns a set of objects based on the provided ID. Each CatalogItem returned in the set includes all of its child information including: all of its CatalogItemVariation objects, references to its CatalogModifierList objects, and the ids of any CatalogTax objects that apply to it.

def batch_retrieve_catalog_objects(body:)

Parameters

Parameter	Type	Tags	Description
`body`	`Batch Retrieve Catalog Objects Request Hash`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Batch Retrieve Catalog Objects Response Hash

Example Usage

body = {}
body[:object_ids] = ['W62UWFY35CWMYGVWK6TWJDNI', 'AA27W3M2GGTF3H6AVPNB77CK']
body[:include_related_objects] = true

result = catalog_api.batch_retrieve_catalog_objects(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Batch Upsert Catalog Objects

Creates or updates up to 10,000 target objects based on the provided list of objects. The target objects are grouped into batches and each batch is inserted/updated in an all-or-nothing manner. If an object within a batch is malformed in some way, or violates a database constraint, the entire batch containing that item will be disregarded. However, other batches in the same request may still succeed. Each batch may contain up to 1,000 objects, and batches will be processed in order as long as the total object count for the request (items, variations, modifier lists, discounts, and taxes) is no more than 10,000.

def batch_upsert_catalog_objects(body:)

Parameters

Parameter	Type	Tags	Description
`body`	`Batch Upsert Catalog Objects Request Hash`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Batch Upsert Catalog Objects Response Hash

Example Usage

body = {}
body[:idempotency_key] = '789ff020-f723-43a9-b4b5-43b5dc1fa3dc'
body[:batches] = []


body[:batches][0] = {}
body[:batches][0][:objects] = []


body[:batches][0][:objects][0] = {}
body[:batches][0][:objects][0][:type] = 'ITEM'
body[:batches][0][:objects][0][:id] = '#Tea'
body[:batches][0][:objects][0][:present_at_all_locations] = true
body[:batches][0][:objects][0][:item_data] = {}
body[:batches][0][:objects][0][:item_data][:name] = 'Tea'
body[:batches][0][:objects][0][:item_data][:category_id] = '#Beverages'
body[:batches][0][:objects][0][:item_data][:tax_ids] = ['#SalesTax']
body[:batches][0][:objects][0][:item_data][:variations] = []


body[:batches][0][:objects][0][:item_data][:variations][0] = {}
body[:batches][0][:objects][0][:item_data][:variations][0][:type] = 'ITEM_VARIATION'
body[:batches][0][:objects][0][:item_data][:variations][0][:id] = '#Tea_Mug'
body[:batches][0][:objects][0][:item_data][:variations][0][:present_at_all_locations] = true
body[:batches][0][:objects][0][:item_data][:variations][0][:item_variation_data] = {}
body[:batches][0][:objects][0][:item_data][:variations][0][:item_variation_data][:item_id] = '#Tea'
body[:batches][0][:objects][0][:item_data][:variations][0][:item_variation_data][:name] = 'Mug'
body[:batches][0][:objects][0][:item_data][:variations][0][:item_variation_data][:pricing_type] = 'FIXED_PRICING'

body[:batches][0][:objects][0][:item_data][:description_html] = '<p><strong>Hot</strong> Leaf Juice</p>'

body[:batches][0][:objects][1] = {}
body[:batches][0][:objects][1][:type] = 'ITEM'
body[:batches][0][:objects][1][:id] = '#Coffee'
body[:batches][0][:objects][1][:present_at_all_locations] = true
body[:batches][0][:objects][1][:item_data] = {}
body[:batches][0][:objects][1][:item_data][:name] = 'Coffee'
body[:batches][0][:objects][1][:item_data][:category_id] = '#Beverages'
body[:batches][0][:objects][1][:item_data][:tax_ids] = ['#SalesTax']
body[:batches][0][:objects][1][:item_data][:variations] = []


body[:batches][0][:objects][1][:item_data][:variations][0] = {}
body[:batches][0][:objects][1][:item_data][:variations][0][:type] = 'ITEM_VARIATION'
body[:batches][0][:objects][1][:item_data][:variations][0][:id] = '#Coffee_Regular'
body[:batches][0][:objects][1][:item_data][:variations][0][:present_at_all_locations] = true
body[:batches][0][:objects][1][:item_data][:variations][0][:item_variation_data] = {}
body[:batches][0][:objects][1][:item_data][:variations][0][:item_variation_data][:item_id] = '#Coffee'
body[:batches][0][:objects][1][:item_data][:variations][0][:item_variation_data][:name] = 'Regular'
body[:batches][0][:objects][1][:item_data][:variations][0][:item_variation_data][:pricing_type] = 'FIXED_PRICING'

body[:batches][0][:objects][1][:item_data][:variations][1] = {}
body[:batches][0][:objects][1][:item_data][:variations][1][:type] = 'ITEM_VARIATION'
body[:batches][0][:objects][1][:item_data][:variations][1][:id] = '#Coffee_Large'
body[:batches][0][:objects][1][:item_data][:variations][1][:present_at_all_locations] = true
body[:batches][0][:objects][1][:item_data][:variations][1][:item_variation_data] = {}
body[:batches][0][:objects][1][:item_data][:variations][1][:item_variation_data][:item_id] = '#Coffee'
body[:batches][0][:objects][1][:item_data][:variations][1][:item_variation_data][:name] = 'Large'
body[:batches][0][:objects][1][:item_data][:variations][1][:item_variation_data][:pricing_type] = 'FIXED_PRICING'

body[:batches][0][:objects][1][:item_data][:description_html] = '<p>Hot <em>Bean Juice</em></p>'

body[:batches][0][:objects][2] = {}
body[:batches][0][:objects][2][:type] = 'CATEGORY'
body[:batches][0][:objects][2][:id] = '#Beverages'
body[:batches][0][:objects][2][:present_at_all_locations] = true
body[:batches][0][:objects][2][:category_data] = {}
body[:batches][0][:objects][2][:category_data][:name] = 'Beverages'

body[:batches][0][:objects][3] = {}
body[:batches][0][:objects][3][:type] = 'TAX'
body[:batches][0][:objects][3][:id] = '#SalesTax'
body[:batches][0][:objects][3][:present_at_all_locations] = true
body[:batches][0][:objects][3][:tax_data] = {}
body[:batches][0][:objects][3][:tax_data][:name] = 'Sales Tax'
body[:batches][0][:objects][3][:tax_data][:calculation_phase] = 'TAX_SUBTOTAL_PHASE'
body[:batches][0][:objects][3][:tax_data][:inclusion_type] = 'ADDITIVE'
body[:batches][0][:objects][3][:tax_data][:percentage] = '5.0'
body[:batches][0][:objects][3][:tax_data][:applies_to_custom_amounts] = true
body[:batches][0][:objects][3][:tax_data][:enabled] = true



result = catalog_api.batch_upsert_catalog_objects(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Create Catalog Image

Uploads an image file to be represented by a CatalogImage object that can be linked to an existing CatalogObject instance. The resulting CatalogImage is unattached to any CatalogObject if the object_id is not specified.

This CreateCatalogImage endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.

def create_catalog_image(request: nil,
                         image_file: nil)

Parameters

Parameter	Type	Tags	Description
`request`	`Create Catalog Image Request Hash`	Form (JSON-Encoded), Optional	-
`image_file`	`File \| UploadIO`	Form, Optional	-

Response Type

Create Catalog Image Response Hash

Example Usage

request = {}
request[:idempotency_key] = '528dea59-7bfb-43c1-bd48-4a6bba7dd61f86'
request[:object_id] = 'ND6EA5AAJEO5WL3JNNIAQA32'
request[:image] = {}
request[:image][:type] = 'IMAGE'
request[:image][:id] = '#TEMP_ID'
request[:image][:image_data] = {}
request[:image][:image_data][:caption] = 'A picture of a cup of coffee'

result = catalog_api.create_catalog_image(request: request, )

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Update Catalog Image

Uploads a new image file to replace the existing one in the specified CatalogImage object.

This UpdateCatalogImage endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.

def update_catalog_image(image_id:,
                         request: nil,
                         image_file: nil)

Parameters

Parameter	Type	Tags	Description
`image_id`	`String`	Template, Required	The ID of the `CatalogImage` object to update the encapsulated image file.
`request`	`Update Catalog Image Request Hash`	Form (JSON-Encoded), Optional	-
`image_file`	`File \| UploadIO`	Form, Optional	-

Response Type

Update Catalog Image Response Hash

Example Usage

image_id = 'image_id4'
request = {}
request[:idempotency_key] = '528dea59-7bfb-43c1-bd48-4a6bba7dd61f86'

result = catalog_api.update_catalog_image(image_id: image_id, request: request, )

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Catalog Info

Retrieves information about the Square Catalog API, such as batch size limits that can be used by the BatchUpsertCatalogObjects endpoint.

def catalog_info

Response Type

Catalog Info Response Hash

Example Usage

result = catalog_api.catalog_info()

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

List Catalog

Returns a list of all CatalogObjects of the specified types in the catalog.

The types parameter is specified as a comma-separated list of the CatalogObjectType values, for example, "ITEM, ITEM_VARIATION, MODIFIER, MODIFIER_LIST, CATEGORY, DISCOUNT, TAX, IMAGE".

Important: ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use SearchCatalogObjects and set the include_deleted_objects attribute value to true.

def list_catalog(cursor: nil,
                 types: nil,
                 catalog_version: nil)

Parameters

Parameter	Type	Tags	Description
`cursor`	`String`	Query, Optional	The pagination cursor returned in the previous response. Leave unset for an initial request. The page size is currently set to be 100. See Pagination for more information.
`types`	`String`	Query, Optional	An optional case-insensitive, comma-separated list of object types to retrieve. The valid values are defined in the CatalogObjectType enum, for example, `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc. If this is unspecified, the operation returns objects of all the top level types at the version of the Square API used to make the request. Object types that are nested onto other object types are not included in the defaults. At the current API version the default object types are: ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.
`catalog_version`	`Integer`	Query, Optional	The specific version of the catalog objects to be included in the response. This allows you to retrieve historical versions of objects. The specified version value is matched against the CatalogObjects' `version` attribute. If not included, results will be from the current version of the catalog.

Response Type

List Catalog Response Hash

Example Usage

result = catalog_api.list_catalog()

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Upsert Catalog Object

Creates or updates the target CatalogObject.

def upsert_catalog_object(body:)

Parameters

Parameter	Type	Tags	Description
`body`	`Upsert Catalog Object Request Hash`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Upsert Catalog Object Response Hash

Example Usage

body = {}
body[:idempotency_key] = 'af3d1afc-7212-4300-b463-0bfc5314a5ae'
body[:object] = {}
body[:object][:type] = 'ITEM'
body[:object][:id] = '#Cocoa'
body[:object][:item_data] = {}
body[:object][:item_data][:name] = 'Cocoa'
body[:object][:item_data][:abbreviation] = 'Ch'
body[:object][:item_data][:variations] = []


body[:object][:item_data][:variations][0] = {}
body[:object][:item_data][:variations][0][:type] = 'ITEM_VARIATION'
body[:object][:item_data][:variations][0][:id] = '#Small'
body[:object][:item_data][:variations][0][:item_variation_data] = {}
body[:object][:item_data][:variations][0][:item_variation_data][:item_id] = '#Cocoa'
body[:object][:item_data][:variations][0][:item_variation_data][:name] = 'Small'
body[:object][:item_data][:variations][0][:item_variation_data][:pricing_type] = 'VARIABLE_PRICING'

body[:object][:item_data][:variations][1] = {}
body[:object][:item_data][:variations][1][:type] = 'ITEM_VARIATION'
body[:object][:item_data][:variations][1][:id] = '#Large'
body[:object][:item_data][:variations][1][:item_variation_data] = {}
body[:object][:item_data][:variations][1][:item_variation_data][:item_id] = '#Cocoa'
body[:object][:item_data][:variations][1][:item_variation_data][:name] = 'Large'
body[:object][:item_data][:variations][1][:item_variation_data][:pricing_type] = 'FIXED_PRICING'
body[:object][:item_data][:variations][1][:item_variation_data][:price_money] = {}
body[:object][:item_data][:variations][1][:item_variation_data][:price_money][:amount] = 400
body[:object][:item_data][:variations][1][:item_variation_data][:price_money][:currency] = 'USD'

body[:object][:item_data][:description_html] = '<p><strong>Hot</strong> Chocolate</p>'

result = catalog_api.upsert_catalog_object(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Delete Catalog Object

Deletes a single CatalogObject based on the provided ID and returns the set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. For example, deleting a CatalogItem will also delete all of its CatalogItemVariation children.

def delete_catalog_object(object_id:)

Parameters

Parameter	Type	Tags	Description
`object_id`	`String`	Template, Required	The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations).

Response Type

Delete Catalog Object Response Hash

Example Usage

object_id = 'object_id8'

result = catalog_api.delete_catalog_object(object_id: object_id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Retrieve Catalog Object

Returns a single CatalogItem as a CatalogObject based on the provided ID. The returned object includes all of the relevant CatalogItem information including: CatalogItemVariation children, references to its CatalogModifierList objects, and the ids of any CatalogTax objects that apply to it.

def retrieve_catalog_object(object_id:,
                            include_related_objects: false,
                            catalog_version: nil)

Parameters

Parameter	Type	Tags	Description
`object_id`	`String`	Template, Required	The object ID of any type of catalog objects to be retrieved.
`include_related_objects`	`TrueClass\|FalseClass`	Query, Optional	If `true`, the response will include additional objects that are related to the requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field of the response. These objects are put in the `related_objects` field. Setting this to `true` is helpful when the objects are needed for immediate display to a user. This process only goes one level deep. Objects referenced by the related objects will not be included. For example, if the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` Default: `false`
`catalog_version`	`Integer`	Query, Optional	Requests objects as of a specific version of the catalog. This allows you to retrieve historical versions of objects. The value to retrieve a specific version of an object can be found in the version field of CatalogObjects. If not included, results will be from the current version of the catalog.

Response Type

Retrieve Catalog Object Response Hash

Example Usage

object_id = 'object_id8'
include_related_objects = false

result = catalog_api.retrieve_catalog_object(object_id: object_id, include_related_objects: include_related_objects, )

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Search Catalog Objects

Searches for CatalogObject of any type by matching supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query filters.

This (SearchCatalogObjects) endpoint differs from the SearchCatalogItems endpoint in the following aspects:

SearchCatalogItems can only search for items or item variations, whereas SearchCatalogObjects can search for any type of catalog objects.
SearchCatalogItems supports the custom attribute query filters to return items or item variations that contain custom attribute values, where SearchCatalogObjects does not.
SearchCatalogItems does not support the include_deleted_objects filter to search for deleted items or item variations, whereas SearchCatalogObjects does.
The both endpoints have different call conventions, including the query filter formats.

def search_catalog_objects(body:)

Parameters

Parameter	Type	Tags	Description
`body`	`Search Catalog Objects Request Hash`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Search Catalog Objects Response Hash

Example Usage

body = {}
body[:object_types] = ['ITEM']
body[:query] = {}
body[:query][:prefix_query] = {}
body[:query][:prefix_query][:attribute_name] = 'name'
body[:query][:prefix_query][:attribute_prefix] = 'tea'
body[:limit] = 100

result = catalog_api.search_catalog_objects(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Search Catalog Items

Searches for catalog items or item variations by matching supported search attribute values, including custom attribute values, against one or more of the specified query filters.

This (SearchCatalogItems) endpoint differs from the SearchCatalogObjects endpoint in the following aspects:

SearchCatalogItems can only search for items or item variations, whereas SearchCatalogObjects can search for any type of catalog objects.
SearchCatalogItems supports the custom attribute query filters to return items or item variations that contain custom attribute values, where SearchCatalogObjects does not.
SearchCatalogItems does not support the include_deleted_objects filter to search for deleted items or item variations, whereas SearchCatalogObjects does.
The both endpoints use different call conventions, including the query filter formats.

def search_catalog_items(body:)

Parameters

Parameter	Type	Tags	Description
`body`	`Search Catalog Items Request Hash`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Search Catalog Items Response Hash

Example Usage

body = {}
body[:text_filter] = 'red'
body[:category_ids] = ['WINE_CATEGORY_ID']
body[:stock_levels] = ['OUT', 'LOW']
body[:enabled_location_ids] = ['ATL_LOCATION_ID']
body[:limit] = 100
body[:sort_order] = 'ASC'
body[:product_types] = ['REGULAR']
body[:custom_attribute_filters] = []


body[:custom_attribute_filters][0] = {}
body[:custom_attribute_filters][0][:custom_attribute_definition_id] = 'VEGAN_DEFINITION_ID'
body[:custom_attribute_filters][0][:bool_filter] = true

body[:custom_attribute_filters][1] = {}
body[:custom_attribute_filters][1][:custom_attribute_definition_id] = 'BRAND_DEFINITION_ID'
body[:custom_attribute_filters][1][:string_filter] = 'Dark Horse'

body[:custom_attribute_filters][2] = {}
body[:custom_attribute_filters][2][:key] = 'VINTAGE'
body[:custom_attribute_filters][2][:number_filter] = {}
body[:custom_attribute_filters][2][:number_filter][:min] = '2017'
body[:custom_attribute_filters][2][:number_filter][:max] = '2018'

body[:custom_attribute_filters][3] = {}
body[:custom_attribute_filters][3][:custom_attribute_definition_id] = 'VARIETAL_DEFINITION_ID'


result = catalog_api.search_catalog_items(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Update Item Modifier Lists

Updates the CatalogModifierList objects that apply to the targeted CatalogItem without having to perform an upsert on the entire item.

def update_item_modifier_lists(body:)

Parameters

Parameter	Type	Tags	Description
`body`	`Update Item Modifier Lists Request Hash`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Update Item Modifier Lists Response Hash

Example Usage

body = {}
body[:item_ids] = ['H42BRLUJ5KTZTTMPVSLFAACQ', '2JXOBJIHCWBQ4NZ3RIXQGJA6']
body[:modifier_lists_to_enable] = ['H42BRLUJ5KTZTTMPVSLFAACQ', '2JXOBJIHCWBQ4NZ3RIXQGJA6']
body[:modifier_lists_to_disable] = ['7WRC16CJZDVLSNDQ35PP6YAD']

result = catalog_api.update_item_modifier_lists(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Update Item Taxes

Updates the CatalogTax objects that apply to the targeted CatalogItem without having to perform an upsert on the entire item.

def update_item_taxes(body:)

Parameters

Parameter	Type	Tags	Description
`body`	`Update Item Taxes Request Hash`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

Update Item Taxes Response Hash

Example Usage

body = {}
body[:item_ids] = ['H42BRLUJ5KTZTTMPVSLFAACQ', '2JXOBJIHCWBQ4NZ3RIXQGJA6']
body[:taxes_to_enable] = ['4WRCNHCJZDVLSNDQ35PP6YAD']
body[:taxes_to_disable] = ['AQCEGCEBBQONINDOHRGZISEX']

result = catalog_api.update_item_taxes(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Files

catalog.md

Latest commit

History

catalog.md

File metadata and controls

Catalog

Class Name

Methods

Batch Delete Catalog Objects

Parameters

Response Type

Example Usage

Batch Retrieve Catalog Objects

Parameters

Response Type

Example Usage

Batch Upsert Catalog Objects

Parameters

Response Type

Example Usage

Create Catalog Image

Parameters

Response Type

Example Usage

Update Catalog Image

Parameters

Response Type

Example Usage

Catalog Info

Response Type

Example Usage

List Catalog

Parameters

Response Type

Example Usage

Upsert Catalog Object

Parameters

Response Type

Example Usage

Delete Catalog Object

Parameters

Response Type

Example Usage

Retrieve Catalog Object

Parameters

Response Type

Example Usage

Search Catalog Objects

Parameters

Response Type

Example Usage

Search Catalog Items

Parameters

Response Type

Example Usage

Update Item Modifier Lists

Parameters

Response Type

Example Usage

Update Item Taxes

Parameters

Response Type

Example Usage