Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
14 lines (8 loc) · 1.16 KB

BatchRetrieveCatalogObjectsRequest.md

File metadata and controls

14 lines (8 loc) · 1.16 KB

SquareConnect.BatchRetrieveCatalogObjectsRequest

Description

Properties

Name Type Description Notes
object_ids [String] The IDs of the CatalogObjects to be retrieved.
include_related_objects Boolean If `true`, the response will include additional objects that are related to the requested objects, as follows: 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. [optional]
catalog_version Number 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`s' `version` attribute. [optional] [beta]