Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 2.54 KB

create-catalog-image-request.md

File metadata and controls

32 lines (24 loc) · 2.54 KB
Raw

Create Catalog Image Request

Structure

CreateCatalogImageRequest

Fields

Name Type Tags Description
idempotencyKey string Required A unique string that identifies this CreateCatalogImage request.
Keys can be any valid string but must be unique for every CreateCatalogImage request.

See Idempotency keys for more information.
Constraints: Minimum Length: 1
objectId string | undefined Optional Unique ID of the CatalogObject to attach this CatalogImage object to. Leave this
field empty to create unattached images, for example if you are building an integration
where an image can be attached to catalog items at a later time.
image CatalogObject Required The wrapper object for the catalog entries of a given object type.

Depending on the type attribute value, a CatalogObject instance assumes a type-specific data to yield the corresponding type of catalog object.

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.

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.

For a more detailed discussion of the Catalog data model, please see the
Design a Catalog guide.
isPrimary boolean | undefined Optional If this is set to true, the image created will be the primary, or first image of the object referenced by object_id.
If the CatalogObject already has a primary CatalogImage, setting this field to true will replace the primary image.
If this is set to false and you use the Square API version 2021-12-15 or later, the image id will be appended to the list of image_ids on the object.

With Square API version 2021-12-15 or later, the default value is false. Otherwise, the effective default value is true.

Example (as JSON)

{
  "idempotency_key": "528dea59-7bfb-43c1-bd48-4a6bba7dd61f86",
  "image": {
    "id": "#TEMP_ID",
    "image_data": {
      "caption": "A picture of a cup of coffee"
    },
    "type": "IMAGE"
  },
  "object_id": "ND6EA5AAJEO5WL3JNNIAQA32"
}