Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.29 KB

batch-retrieve-catalog-objects-request.md

File metadata and controls

27 lines (19 loc) · 1.29 KB

Batch Retrieve Catalog Objects Request

Structure

Batch Retrieve Catalog Objects Request

Fields

Name Type Tags Description
object_ids List of string Required The IDs of the CatalogObjects to be retrieved.
include_related_objects bool Optional 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.
catalog_version long|int 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.

Example (as JSON)

{
  "include_related_objects": true,
  "object_ids": [
    "W62UWFY35CWMYGVWK6TWJDNI",
    "AA27W3M2GGTF3H6AVPNB77CK"
  ]
}