com.squareup.square.api

Interface CatalogApi

All Known Implementing Classes:

DefaultCatalogApi

public interface CatalogApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
BatchDeleteCatalogObjectsResponse	batchDeleteCatalogObjects(BatchDeleteCatalogObjectsRequest body) Deletes a set of [CatalogItem]($m/CatalogItem)s based on the provided list of target IDs and returns a set of successfully deleted IDs in the response.
CompletableFuture<BatchDeleteCatalogObjectsResponse>	batchDeleteCatalogObjectsAsync(BatchDeleteCatalogObjectsRequest body) Deletes a set of [CatalogItem]($m/CatalogItem)s based on the provided list of target IDs and returns a set of successfully deleted IDs in the response.
BatchRetrieveCatalogObjectsResponse	batchRetrieveCatalogObjects(BatchRetrieveCatalogObjectsRequest body) Returns a set of objects based on the provided ID.
CompletableFuture<BatchRetrieveCatalogObjectsResponse>	batchRetrieveCatalogObjectsAsync(BatchRetrieveCatalogObjectsRequest body) Returns a set of objects based on the provided ID.
BatchUpsertCatalogObjectsResponse	batchUpsertCatalogObjects(BatchUpsertCatalogObjectsRequest body) Creates or updates up to 10,000 target objects based on the provided list of objects.
CompletableFuture<BatchUpsertCatalogObjectsResponse>	batchUpsertCatalogObjectsAsync(BatchUpsertCatalogObjectsRequest body) Creates or updates up to 10,000 target objects based on the provided list of objects.
CatalogInfoResponse	catalogInfo() Retrieves information about the Square Catalog API, such as batch size limits that can be used by the `BatchUpsertCatalogObjects` endpoint.
CompletableFuture<CatalogInfoResponse>	catalogInfoAsync() Retrieves information about the Square Catalog API, such as batch size limits that can be used by the `BatchUpsertCatalogObjects` endpoint.
CreateCatalogImageResponse	createCatalogImage(CreateCatalogImageRequest request, FileWrapper imageFile) Uploads an image file to be represented by a [CatalogImage]($m/CatalogImage) object that can be linked to an existing [CatalogObject]($m/CatalogObject) instance.
CompletableFuture<CreateCatalogImageResponse>	createCatalogImageAsync(CreateCatalogImageRequest request, FileWrapper imageFile) Uploads an image file to be represented by a [CatalogImage]($m/CatalogImage) object that can be linked to an existing [CatalogObject]($m/CatalogObject) instance.
DeleteCatalogObjectResponse	deleteCatalogObject(String objectId) Deletes a single [CatalogObject]($m/CatalogObject) based on the provided ID and returns the set of successfully deleted IDs in the response.
CompletableFuture<DeleteCatalogObjectResponse>	deleteCatalogObjectAsync(String objectId) Deletes a single [CatalogObject]($m/CatalogObject) based on the provided ID and returns the set of successfully deleted IDs in the response.
ListCatalogResponse	listCatalog(String cursor, String types, Long catalogVersion) Returns a list of all [CatalogObject]($m/CatalogObject)s of the specified types in the catalog.
CompletableFuture<ListCatalogResponse>	listCatalogAsync(String cursor, String types, Long catalogVersion) Returns a list of all [CatalogObject]($m/CatalogObject)s of the specified types in the catalog.
RetrieveCatalogObjectResponse	retrieveCatalogObject(String objectId, Boolean includeRelatedObjects, Long catalogVersion) Returns a single [CatalogItem]($m/CatalogItem) as a [CatalogObject]($m/CatalogObject) based on the provided ID.
CompletableFuture<RetrieveCatalogObjectResponse>	retrieveCatalogObjectAsync(String objectId, Boolean includeRelatedObjects, Long catalogVersion) Returns a single [CatalogItem]($m/CatalogItem) as a [CatalogObject]($m/CatalogObject) based on the provided ID.
SearchCatalogItemsResponse	searchCatalogItems(SearchCatalogItemsRequest body) 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.
CompletableFuture<SearchCatalogItemsResponse>	searchCatalogItemsAsync(SearchCatalogItemsRequest body) 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.
SearchCatalogObjectsResponse	searchCatalogObjects(SearchCatalogObjectsRequest body) Searches for [CatalogObject]($m/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.
CompletableFuture<SearchCatalogObjectsResponse>	searchCatalogObjectsAsync(SearchCatalogObjectsRequest body) Searches for [CatalogObject]($m/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.
UpdateCatalogImageResponse	updateCatalogImage(String imageId, UpdateCatalogImageRequest request, FileWrapper imageFile) Uploads a new image file to replace the existing one in the specified [CatalogImage]($m/CatalogImage) object.
CompletableFuture<UpdateCatalogImageResponse>	updateCatalogImageAsync(String imageId, UpdateCatalogImageRequest request, FileWrapper imageFile) Uploads a new image file to replace the existing one in the specified [CatalogImage]($m/CatalogImage) object.
UpdateItemModifierListsResponse	updateItemModifierLists(UpdateItemModifierListsRequest body) Updates the [CatalogModifierList]($m/CatalogModifierList) objects that apply to the targeted [CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item.
CompletableFuture<UpdateItemModifierListsResponse>	updateItemModifierListsAsync(UpdateItemModifierListsRequest body) Updates the [CatalogModifierList]($m/CatalogModifierList) objects that apply to the targeted [CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item.
UpdateItemTaxesResponse	updateItemTaxes(UpdateItemTaxesRequest body) Updates the [CatalogTax]($m/CatalogTax) objects that apply to the targeted [CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item.
CompletableFuture<UpdateItemTaxesResponse>	updateItemTaxesAsync(UpdateItemTaxesRequest body) Updates the [CatalogTax]($m/CatalogTax) objects that apply to the targeted [CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item.
UpsertCatalogObjectResponse	upsertCatalogObject(UpsertCatalogObjectRequest body) Creates or updates the target [CatalogObject]($m/CatalogObject).
CompletableFuture<UpsertCatalogObjectResponse>	upsertCatalogObjectAsync(UpsertCatalogObjectRequest body) Creates or updates the target [CatalogObject]($m/CatalogObject).

Method Detail

batchDeleteCatalogObjects

BatchDeleteCatalogObjectsResponse batchDeleteCatalogObjects(BatchDeleteCatalogObjectsRequest body)
                                                     throws ApiException,
                                                            IOException

Deletes a set of [CatalogItem]($m/CatalogItem)s 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]($m/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.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchDeleteCatalogObjectsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

batchDeleteCatalogObjectsAsync

CompletableFuture<BatchDeleteCatalogObjectsResponse> batchDeleteCatalogObjectsAsync(BatchDeleteCatalogObjectsRequest body)

Deletes a set of [CatalogItem]($m/CatalogItem)s 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]($m/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.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchDeleteCatalogObjectsResponse response from the API call

batchRetrieveCatalogObjects

BatchRetrieveCatalogObjectsResponse batchRetrieveCatalogObjects(BatchRetrieveCatalogObjectsRequest body)
                                                         throws ApiException,
                                                                IOException

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

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchRetrieveCatalogObjectsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

batchRetrieveCatalogObjectsAsync

CompletableFuture<BatchRetrieveCatalogObjectsResponse> batchRetrieveCatalogObjectsAsync(BatchRetrieveCatalogObjectsRequest body)

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

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchRetrieveCatalogObjectsResponse response from the API call

batchUpsertCatalogObjects

BatchUpsertCatalogObjectsResponse batchUpsertCatalogObjects(BatchUpsertCatalogObjectsRequest body)
                                                     throws ApiException,
                                                            IOException

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.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchUpsertCatalogObjectsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

batchUpsertCatalogObjectsAsync

CompletableFuture<BatchUpsertCatalogObjectsResponse> batchUpsertCatalogObjectsAsync(BatchUpsertCatalogObjectsRequest body)

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.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchUpsertCatalogObjectsResponse response from the API call

createCatalogImage

CreateCatalogImageResponse createCatalogImage(CreateCatalogImageRequest request,
                                              FileWrapper imageFile)
                                       throws ApiException,
                                              IOException

Uploads an image file to be represented by a [CatalogImage]($m/CatalogImage) object that can be linked to an existing [CatalogObject]($m/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.

Parameters:

request - Optional parameter: Example:

imageFile - Optional parameter: Example:

Returns:

Returns the CreateCatalogImageResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createCatalogImageAsync

CompletableFuture<CreateCatalogImageResponse> createCatalogImageAsync(CreateCatalogImageRequest request,
                                                                      FileWrapper imageFile)

Uploads an image file to be represented by a [CatalogImage]($m/CatalogImage) object that can be linked to an existing [CatalogObject]($m/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.

Parameters:

request - Optional parameter: Example:

imageFile - Optional parameter: Example:

Returns:

Returns the CreateCatalogImageResponse response from the API call

updateCatalogImage

UpdateCatalogImageResponse updateCatalogImage(String imageId,
                                              UpdateCatalogImageRequest request,
                                              FileWrapper imageFile)
                                       throws ApiException,
                                              IOException

Uploads a new image file to replace the existing one in the specified [CatalogImage]($m/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.

Parameters:

imageId - Required parameter: The ID of the `CatalogImage` object to update the encapsulated image file.

request - Optional parameter: Example:

imageFile - Optional parameter: Example:

Returns:

Returns the UpdateCatalogImageResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updateCatalogImageAsync

CompletableFuture<UpdateCatalogImageResponse> updateCatalogImageAsync(String imageId,
                                                                      UpdateCatalogImageRequest request,
                                                                      FileWrapper imageFile)

Uploads a new image file to replace the existing one in the specified [CatalogImage]($m/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.

Parameters:

imageId - Required parameter: The ID of the `CatalogImage` object to update the encapsulated image file.

request - Optional parameter: Example:

imageFile - Optional parameter: Example:

Returns:

Returns the UpdateCatalogImageResponse response from the API call

catalogInfo

CatalogInfoResponse catalogInfo()
                         throws ApiException,
                                IOException

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

Returns:

Returns the CatalogInfoResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

catalogInfoAsync

CompletableFuture<CatalogInfoResponse> catalogInfoAsync()

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

Returns:

Returns the CatalogInfoResponse response from the API call

listCatalog

ListCatalogResponse listCatalog(String cursor,
                                String types,
                                Long catalogVersion)
                         throws ApiException,
                                IOException

Returns a list of all [CatalogObject]($m/CatalogObject)s of the specified types in the catalog. The `types` parameter is specified as a comma-separated list of the [CatalogObjectType]($m/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]($e/Catalog/SearchCatalogObjects) and set the `include_deleted_objects` attribute value to `true`.

Parameters:

cursor - Optional parameter: 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](https://developer.squareup.com/docs/basics/api101/pagination) for more information.

types - Optional parameter: An optional case-insensitive, comma-separated list of object types to retrieve. The valid values are defined in the [CatalogObjectType]($m/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, DINING_OPTION, TAX_EXEMPTION, SERVICE_CHARGE, PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.

catalogVersion - Optional parameter: 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 [CatalogObject]($m/CatalogObject)s' `version` attribute. If not included, results will be from the current version of the catalog.

Returns:

Returns the ListCatalogResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listCatalogAsync

CompletableFuture<ListCatalogResponse> listCatalogAsync(String cursor,
                                                        String types,
                                                        Long catalogVersion)

Returns a list of all [CatalogObject]($m/CatalogObject)s of the specified types in the catalog. The `types` parameter is specified as a comma-separated list of the [CatalogObjectType]($m/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]($e/Catalog/SearchCatalogObjects) and set the `include_deleted_objects` attribute value to `true`.

Parameters:

cursor - Optional parameter: 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](https://developer.squareup.com/docs/basics/api101/pagination) for more information.

types - Optional parameter: An optional case-insensitive, comma-separated list of object types to retrieve. The valid values are defined in the [CatalogObjectType]($m/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, DINING_OPTION, TAX_EXEMPTION, SERVICE_CHARGE, PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.

catalogVersion - Optional parameter: 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 [CatalogObject]($m/CatalogObject)s' `version` attribute. If not included, results will be from the current version of the catalog.

Returns:

Returns the ListCatalogResponse response from the API call

upsertCatalogObject

UpsertCatalogObjectResponse upsertCatalogObject(UpsertCatalogObjectRequest body)
                                         throws ApiException,
                                                IOException

Creates or updates the target [CatalogObject]($m/CatalogObject).

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpsertCatalogObjectResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

upsertCatalogObjectAsync

CompletableFuture<UpsertCatalogObjectResponse> upsertCatalogObjectAsync(UpsertCatalogObjectRequest body)

Creates or updates the target [CatalogObject]($m/CatalogObject).

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpsertCatalogObjectResponse response from the API call

deleteCatalogObject

DeleteCatalogObjectResponse deleteCatalogObject(String objectId)
                                         throws ApiException,
                                                IOException

Deletes a single [CatalogObject]($m/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]($m/CatalogItem) will also delete all of its [CatalogItemVariation]($m/CatalogItemVariation) children.

Parameters:

objectId - Required parameter: 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).

Returns:

Returns the DeleteCatalogObjectResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deleteCatalogObjectAsync

CompletableFuture<DeleteCatalogObjectResponse> deleteCatalogObjectAsync(String objectId)

Deletes a single [CatalogObject]($m/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]($m/CatalogItem) will also delete all of its [CatalogItemVariation]($m/CatalogItemVariation) children.

Parameters:

objectId - Required parameter: 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).

Returns:

Returns the DeleteCatalogObjectResponse response from the API call

retrieveCatalogObject

RetrieveCatalogObjectResponse retrieveCatalogObject(String objectId,
                                                    Boolean includeRelatedObjects,
                                                    Long catalogVersion)
                                             throws ApiException,
                                                    IOException

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

Parameters:

objectId - Required parameter: The object ID of any type of catalog objects to be retrieved.

includeRelatedObjects - Optional parameter: 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`

catalogVersion - Optional parameter: 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 [CatalogObject]($m/CatalogObject)s. If not included, results will be from the current version of the catalog.

Returns:

Returns the RetrieveCatalogObjectResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveCatalogObjectAsync

CompletableFuture<RetrieveCatalogObjectResponse> retrieveCatalogObjectAsync(String objectId,
                                                                            Boolean includeRelatedObjects,
                                                                            Long catalogVersion)

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

Parameters:

objectId - Required parameter: The object ID of any type of catalog objects to be retrieved.

includeRelatedObjects - Optional parameter: 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`

catalogVersion - Optional parameter: 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 [CatalogObject]($m/CatalogObject)s. If not included, results will be from the current version of the catalog.

Returns:

Returns the RetrieveCatalogObjectResponse response from the API call

searchCatalogObjects

SearchCatalogObjectsResponse searchCatalogObjects(SearchCatalogObjectsRequest body)
                                           throws ApiException,
                                                  IOException

Searches for [CatalogObject]($m/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]($e/Catalog/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.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchCatalogObjectsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

searchCatalogObjectsAsync

CompletableFuture<SearchCatalogObjectsResponse> searchCatalogObjectsAsync(SearchCatalogObjectsRequest body)

Searches for [CatalogObject]($m/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]($e/Catalog/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.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchCatalogObjectsResponse response from the API call

searchCatalogItems

SearchCatalogItemsResponse searchCatalogItems(SearchCatalogItemsRequest body)
                                       throws ApiException,
                                              IOException

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.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchCatalogItemsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

searchCatalogItemsAsync

CompletableFuture<SearchCatalogItemsResponse> searchCatalogItemsAsync(SearchCatalogItemsRequest body)

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.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchCatalogItemsResponse response from the API call

updateItemModifierLists

UpdateItemModifierListsResponse updateItemModifierLists(UpdateItemModifierListsRequest body)
                                                 throws ApiException,
                                                        IOException

Updates the [CatalogModifierList]($m/CatalogModifierList) objects that apply to the targeted [CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateItemModifierListsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updateItemModifierListsAsync

CompletableFuture<UpdateItemModifierListsResponse> updateItemModifierListsAsync(UpdateItemModifierListsRequest body)

Updates the [CatalogModifierList]($m/CatalogModifierList) objects that apply to the targeted [CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateItemModifierListsResponse response from the API call

updateItemTaxes

UpdateItemTaxesResponse updateItemTaxes(UpdateItemTaxesRequest body)
                                 throws ApiException,
                                        IOException

Updates the [CatalogTax]($m/CatalogTax) objects that apply to the targeted [CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateItemTaxesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updateItemTaxesAsync

CompletableFuture<UpdateItemTaxesResponse> updateItemTaxesAsync(UpdateItemTaxesRequest body)

Updates the [CatalogTax]($m/CatalogTax) objects that apply to the targeted [CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateItemTaxesResponse response from the API call