FileMaster
Search
Toggle Dark Mode
Home
/
.
/
wp-content
/
plugins
/
ameliabooking
/
vendor
/
square
/
square
/
doc
/
models
Edit File: create-catalog-image-response.md
# Create Catalog Image Response ## Structure `CreateCatalogImageResponse` ## Fields | Name | Type | Tags | Description | Getter | Setter | | --- | --- | --- | --- | --- | --- | | `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void | | `image` | [`?CatalogObject`](../../doc/models/catalog-object.md) | Optional | The wrapper object for the catalog entries of a given object type.<br><br>Depending on the `type` attribute value, a `CatalogObject` instance assumes a type-specific data to yield the corresponding type of catalog object.<br><br>For example, if `type=ITEM`, the `CatalogObject` instance must have the ITEM-specific data set on the `item_data` attribute. The resulting `CatalogObject` instance is also a `CatalogItem` instance.<br><br>In general, if `type=<OBJECT_TYPE>`, the `CatalogObject` instance must have the `<OBJECT_TYPE>`-specific data set on the `<object_type>_data` attribute. The resulting `CatalogObject` instance is also a `Catalog<ObjectType>` instance.<br><br>For a more detailed discussion of the Catalog data model, please see the<br>[Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) guide. | getImage(): ?CatalogObject | setImage(?CatalogObject image): void | ## Example (as JSON) ```json { "image": { "id": "KQLFFHA6K6J3YQAQAWDQAL57", "image_data": { "caption": "A picture of a cup of coffee", "url": "https://..." }, "type": "IMAGE", "updated_at": "updated_at2", "version": 100, "is_deleted": false, "custom_attribute_values": { "key0": { "name": "name8", "string_value": "string_value2", "custom_attribute_definition_id": "custom_attribute_definition_id4", "type": "STRING", "number_value": "number_value8" }, "key1": { "name": "name8", "string_value": "string_value2", "custom_attribute_definition_id": "custom_attribute_definition_id4", "type": "STRING", "number_value": "number_value8" } }, "catalog_v1_ids": [ { "catalog_v1_id": "catalog_v1_id4", "location_id": "location_id4" }, { "catalog_v1_id": "catalog_v1_id4", "location_id": "location_id4" }, { "catalog_v1_id": "catalog_v1_id4", "location_id": "location_id4" } ] }, "errors": [ { "category": "MERCHANT_SUBSCRIPTION_ERROR", "code": "MAP_KEY_LENGTH_TOO_LONG", "detail": "detail6", "field": "field4" } ] } ```
Save
Back