lib/square/api/catalog_api.rb
# 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]($e/Catalog/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.
# @param [SearchCatalogItemsRequest] body Required parameter: An object
# containing the fields to POST for the request.  See the corresponding
# object definition for field details.
# @return [SearchCatalogItemsResponse Hash] response from the API call
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.
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 .
def search_catalog_items(body:)
      _query_builder = config.get_base_uri
      _query_builder << '/v2/catalog/search-catalog-items'
      _query_url = APIHelper.clean_url _query_builder
      _headers = {
        'accept' => 'application/json',
        'content-type' => 'application/json; charset=utf-8'
      }
      _request = config.http_client.post(
        _query_url,
        headers: _headers,
        parameters: body.to_json
      )
      OAuth2.apply(config, _request)
      _response = execute_request(_request)
      decoded = APIHelper.json_deserialize(_response.raw_body)
      _errors = APIHelper.map_response(decoded, ['errors'])
      ApiResponse.new(
        _response, data: decoded, errors: _errors
      )
    end
def search_catalog_items ( body : ) _query_builder = config . get_base_uri _query_builder << '/v2/catalog/search-catalog-items' _query_url = APIHelper . clean_url _query_builder _headers = { 'accept' => 'application/json' , 'content-type' => 'application/json; charset=utf-8' } _request = config . http_client . post ( _query_url , headers : _headers , parameters : body . to_json ) OAuth2 . apply ( config , _request ) _response = execute_request ( _request ) decoded = APIHelper . json_deserialize ( _response . raw_body ) _errors = APIHelper . map_response ( decoded , [ 'errors' ] ) ApiResponse . new ( _response , data : decoded , errors : _errors ) end
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.
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 .
# Prepare query url. # Prepare headers. # Prepare and execute HttpRequest. # Return appropriate response type.
response from the API call
response from the API call
SearchCatalogItemsResponse Hash
body
<not_specific>
<not_specific>
body Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.
body Required parameter : An object containing the fields to POST for the request . See the corresponding object definition for field details .