Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 2.6 KB

batch-retrieve-catalog-objects-request.md

File metadata and controls

32 lines (24 loc) · 2.6 KB

Batch Retrieve Catalog Objects Request

Structure

Batch Retrieve Catalog Objects Request

Fields

Name Type Tags Description
object_ids Array<String> Required The IDs of the CatalogObjects to be retrieved.
include_related_objects TrueClass | FalseClass 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
catalog_version Integer 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.
include_deleted_objects TrueClass | FalseClass Optional Indicates whether to include (true) or not (false) in the response deleted objects, namely, those with the is_deleted attribute set to true.
include_category_path_to_root TrueClass | FalseClass Optional Specifies whether or not to include the path_to_root list for each returned category instance. The path_to_root list consists
of CategoryPathToRootNode objects and specifies the path that starts with the immediate parent category of the returned category
and ends with its root category. If the returned category is a top-level category, the path_to_root list is empty and is not returned
in the response payload.

Example (as JSON)

{
  "include_related_objects": true,
  "object_ids": [
    "W62UWFY35CWMYGVWK6TWJDNI",
    "AA27W3M2GGTF3H6AVPNB77CK"
  ],
  "catalog_version": 190,
  "include_deleted_objects": false,
  "include_category_path_to_root": false
}