| Type |
TypeEnum |
The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below. See CatalogObjectType for all possible values. |
|
| Id |
string |
An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. |
|
| UpdatedAt |
string |
Last modification timestamp in RFC 3339 format, e.g., `"2016-08-15T23:59:33.123Z"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. |
[optional] |
| Version |
long? |
The version of the object. When updating an object, the version supplied by the must match the version in the database, otherwise the write will be rejected as conflicting. |
[optional] |
| IsDeleted |
bool? |
If `true`, the object has been deleted from the database. Must be `false` for new objects being inserted. When deleted, the `updated_at` field will equal the deletion time. |
[optional] |
| CatalogV1Ids |
List<CatalogV1Id> |
The Connect V1 IDs for this object at each [location][#type-location] where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. |
[optional] |
| PresentAtAllLocations |
bool? |
If `true`, this object is present at all locations (including future locations), except where specified in the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), except where specified in the `present_at_location_ids` field. |
[optional] |
| PresentAtLocationIds |
List |
A list of locations where the object is present, even if `present_at_all_locations` is `false`. |
[optional] |
| AbsentAtLocationIds |
List |
A list of locations where the object is not present, even if `present_at_all_locations` is `true`. |
[optional] |
| ItemData |
CatalogItem |
Structured data for a CatalogItem, set for CatalogObjects of type `ITEM`. |
[optional] |
| CategoryData |
CatalogCategory |
Structured data for a CatalogCategory, set for CatalogObjects of type `CATEGORY`. |
[optional] |
| ItemVariationData |
CatalogItemVariation |
Structured data for a CatalogItemVariation, set for CatalogObjects of type `ITEM_VARIATION`. |
[optional] |
| TaxData |
CatalogTax |
Structured data for a CatalogTax, set for CatalogObjects of type `TAX`. |
[optional] |
| DiscountData |
CatalogDiscount |
Structured data for a CatalogDiscount, set for CatalogObjects of type `DISCOUNT`. |
[optional] |
| ModifierListData |
CatalogModifierList |
Structured data for a CatalogModifierList, set for CatalogObjects of type `MODIFIER_LIST`. |
[optional] |
| ModifierData |
CatalogModifier |
Structured data for a CatalogModifier, set for CatalogObjects of type `MODIFIER`. |
[optional] |
