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

Latest commit

 

History

History
13 lines (7 loc) · 1.15 KB

RetrieveCatalogObjectRequest.md

File metadata and controls

13 lines (7 loc) · 1.15 KB

SquareConnect.RetrieveCatalogObjectRequest

Description

Properties

Name Type Description Notes
include_related_objects Boolean If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a `CatalogItem`, its associated `CatalogCategory`, `CatalogTax`, `CatalogImage` and `CatalogModifierList` objects will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false` [optional]
catalog_version Number 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`s. [optional] [beta]