Get picture specifications

GET /i/richItem/{businessId}/pictureSpec

OAuth2

Get rich item picture specifications.

Path parameters

businessId integer(int64) Required

The unique identifier for the business.

Responses

200 application/hal+json;charset=UTF-8

OK
Hide response attributes Show response attributes object
- _links object
  
  Hide _links attribute Show _links attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  Hide * attributes Show * attributes object
  
  deprecation string
  
  href string
  
  hreflang string
  
  name string
  
  profile string
  
  templated boolean
  
  title string
  
  type string
- minHeight integer(int32)
  
  The minimum image height.
- minWidth integer(int32)
  
  The minimum image width.
- requiredAspectRatio number(float)
  
  The image aspect ratio (width divided by length). If not set, there is no aspect ratio check.

GET /i/richItem/{businessId}/pictureSpec

curl \
 -X GET https://api.trial.lsk.lightspeed.app/i/richItem/454335871/pictureSpec \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "_links": {
    "additionalProperty1": {
      "deprecation": "string",
      "href": "string",
      "hreflang": "string",
      "name": "string",
      "profile": "string",
      "templated": true,
      "title": "string",
      "type": "string"
    },
    "additionalProperty2": {
      "deprecation": "string",
      "href": "string",
      "hreflang": "string",
      "name": "string",
      "profile": "string",
      "templated": true,
      "title": "string",
      "type": "string"
    }
  },
  "minHeight": 42,
  "minWidth": 42,
  "requiredAspectRatio": 42.0
}