iKentoo API documentation

Rich item REST Service API Guide

Rest URI

Warning

In order to have working URI, when a sku is in the endpoint path ({sku} in this documentation), special values need to be replaced (special words between double underscores) :

Table 1. Sku substitutions
Character to replace replacement

/

__SLASH__

\

__BACKSLASH__

;

__SC__

%

__PC__

Resources

Get allergen list

Get Allergens

GET /allergens

Get all allergens.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

[].code

String

false

IKentoo code of this allergen.

[].translations

Array[Object]

true

List of translations.

[].translations[].locale

String

false

Language locale (eg 'en' or 'en_US').

[].translations[].text

String

true

Translation in the locale language.

Example request

$ curl 'https://apiBaseEndpoint/allergens' -i

Example response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 289

[ {
  "code" : "fish",
  "translations" : [ {
    "locale" : "en",
    "text" : "Fish"
  }, {
    "locale" : "fr",
    "text" : "Poisson"
  } ]
}, {
  "code" : "milk",
  "translations" : [ {
    "locale" : "en",
    "text" : "Milk"
  }, {
    "locale" : "fr",
    "text" : "Lait"
  } ]
} ]

Create or update a rich item

Create Or Update

PUT /richItem/{businessId}/{sku:.+}

Create or update a rich item. The picture is not used here (use PATCH method).

Path parameters

Parameter Type Optional Description

businessId

Integer

false

Id of the business owning items.

sku

String

false

Sku of the item.

Query parameters

No parameters.

Request fields

Path Type Optional Description

businessId

Integer

false

The business id.

sku

String

false

Sku of the item.

pictureUrl

String

true

Url of the picture (read only).

rawPictureUrl

String

true

Url of the raw (before cropping) picture (read only).

fileType

String

true

Image format (eg. 'jpeg' or 'png'). Default: png.

rawPicture

Array[Integer]

true

The raw picture (before cropping): used this field only to update picture (PATCH method).

picture

Array[Integer]

true

The cropped picture: used this field only to update picture (PATCH method).

creationDate

String

true

Creation date of the richItem (read only).

lastUpdateDate

String

true

Last update date of the richItem (read only).

descriptions

Array[Object]

true

List of localized descriptions.

descriptions[].localeCode

String

false

Language code (ISO 639) of the description.

Size must be between 2 and 7 inclusive.

descriptions[].description

String

true

Item description in the provided language.

Size must be between 0 and 4000 inclusive.

descriptions[].displayName

String

true

Display name (for the customer) in the provided language.

allergenCodes

Array[String]

true

Item allergens. Codes only (use /allergens endpoint to get allergen list).

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

Response fields

Path Type Optional Description

businessId

Integer

false

The business id.

sku

String

false

Sku of the item.

pictureUrl

String

true

Url of the picture (read only).

rawPictureUrl

String

true

Url of the raw (before cropping) picture (read only).

fileType

String

true

Image format (eg. 'jpeg' or 'png'). Default: png.

rawPicture

Array[Integer]

true

The raw picture (before cropping): used this field only to update picture (PATCH method).

picture

Array[Integer]

true

The cropped picture: used this field only to update picture (PATCH method).

creationDate

String

true

Creation date of the richItem (read only).

lastUpdateDate

String

true

Last update date of the richItem (read only).

descriptions

Array[Object]

true

List of localized descriptions.

descriptions[].localeCode

String

false

Language code (ISO 639) of the description.

Size must be between 2 and 7 inclusive.

descriptions[].description

String

true

Item description in the provided language.

Size must be between 0 and 4000 inclusive.

descriptions[].displayName

String

true

Display name (for the customer) in the provided language.

allergenCodes

Array[String]

true

Item allergens. Codes only (use /allergens endpoint to get allergen list).

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

Example request

$ curl 'https://apiBaseEndpoint/richItem/1245667/creation' -i -X PUT -H 'Content-Type: application/json' -d '{
  "businessId" : 1245667,
  "sku" : "creation",
  "descriptions" : [ {
    "localeCode" : "en",
    "description" : "description",
    "displayName" : "display"
  } ],
  "links" : [ ]
}'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 264

{
  "businessId" : 1245667,
  "sku" : "creation",
  "creationDate" : "2019-08-15T16:03:08.034",
  "lastUpdateDate" : "2019-08-15T16:03:08.036",
  "descriptions" : [ {
    "localeCode" : "en",
    "description" : "description",
    "displayName" : "display"
  } ]
}

Get a rich item

Get Rich Item

GET /richItem/{businessId}/{sku:.+}

Get a rich item from its sku and the business id.

Path parameters

Parameter Type Optional Description

businessId

Integer

false

Id of the business owning items.

sku

String

false

Sku of the item.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

businessId

Integer

false

The business id.

sku

String

false

Sku of the item.

pictureUrl

String

true

Url of the picture (read only).

rawPictureUrl

String

true

Url of the raw (before cropping) picture (read only).

fileType

String

true

Image format (eg. 'jpeg' or 'png'). Default: png.

rawPicture

Array[Integer]

true

The raw picture (before cropping): used this field only to update picture (PATCH method).

picture

Array[Integer]

true

The cropped picture: used this field only to update picture (PATCH method).

creationDate

String

true

Creation date of the richItem (read only).

lastUpdateDate

String

true

Last update date of the richItem (read only).

descriptions

Array[Object]

true

List of localized descriptions.

descriptions[].localeCode

String

false

Language code (ISO 639) of the description.

Size must be between 2 and 7 inclusive.

descriptions[].description

String

true

Item description in the provided language.

Size must be between 0 and 4000 inclusive.

descriptions[].displayName

String

true

Display name (for the customer) in the provided language.

allergenCodes

Array[String]

true

Item allergens. Codes only (use /allergens endpoint to get allergen list).

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

Example request

$ curl 'https://apiBaseEndpoint/richItem/12/345' -i

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 804

{
  "businessId" : 12,
  "sku" : "345",
  "pictureUrl" : "http://s3-eu-west-1.amazonaws.com/com.ikentoo.dev.rich-content-store/17119739641858_ba8f2b66-49ad-440b-b548-5bfdb01b1a70.jpeg",
  "rawPictureUrl" : "http://s3-eu-west-1.amazonaws.com/com.ikentoo.dev.rich-content-store/17119739641858_ba8f2b66-49ad-440b-b548-5bfdb01b1a70_raw.jpeg",
  "creationDate" : "2019-08-15T16:03:07.194",
  "descriptions" : [ {
    "localeCode" : "en",
    "description" : "description",
    "displayName" : "display"
  }, {
    "localeCode" : "fr",
    "description" : "description2",
    "displayName" : "display2"
  } ],
  "allergenCodes" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://apiBaseEndpoint/richItem/12/345"
    },
    "items" : {
      "href" : "https://apiBaseEndpoint/richItem/12/"
    }
  }
}

Get items by SKUs

Get Rich Items

POST /richItem/{businessId}/itemsBySkus

Get rich items of a business based on their sku.

Path parameters

Parameter Type Optional Description

businessId

Integer

false

Id of the business owning items.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

content

Array[Object]

true

content[].businessId

Integer

false

The business id.

content[].sku

String

false

Sku of the item.

content[].pictureUrl

String

true

Url of the picture (read only).

content[].rawPictureUrl

String

true

Url of the raw (before cropping) picture (read only).

content[].fileType

String

true

Image format (eg. 'jpeg' or 'png'). Default: png.

content[].rawPicture

Array[Integer]

true

The raw picture (before cropping): used this field only to update picture (PATCH method).

content[].picture

Array[Integer]

true

The cropped picture: used this field only to update picture (PATCH method).

content[].creationDate

String

true

Creation date of the richItem (read only).

content[].lastUpdateDate

String

true

Last update date of the richItem (read only).

content[].descriptions

Array[Object]

true

List of localized descriptions.

content[].descriptions[].localeCode

String

false

Language code (ISO 639) of the description.

Size must be between 2 and 7 inclusive.

content[].descriptions[].description

String

true

Item description in the provided language.

Size must be between 0 and 4000 inclusive.

content[].descriptions[].displayName

String

true

Display name (for the customer) in the provided language.

content[].allergenCodes

Array[String]

true

Item allergens. Codes only (use /allergens endpoint to get allergen list).

content[].links

Array[Object]

true

content[].links[].rel

String

true

content[].links[].href

String

true

Example request

$ curl 'https://apiBaseEndpoint/richItem/12/itemsBySkus' -i -X POST -H 'Content-Type: application/hal+json;charset=UTF-8' -d '[ "345", "3452" ]'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1430

{
  "_embedded" : {
    "richItemDtoList" : [ {
      "businessId" : 12,
      "sku" : "345",
      "pictureUrl" : "http://s3-eu-west-1.amazonaws.com/com.ikentoo.dev.rich-content-store/17119739641858_ba8f2b66-49ad-440b-b548-5bfdb01b1a70.jpeg",
      "rawPictureUrl" : "http://s3-eu-west-1.amazonaws.com/com.ikentoo.dev.rich-content-store/17119739641858_ba8f2b66-49ad-440b-b548-5bfdb01b1a70_raw.jpeg",
      "creationDate" : "2019-08-15T16:03:04.852",
      "descriptions" : [ {
        "localeCode" : "en",
        "description" : "description",
        "displayName" : "display"
      }, {
        "localeCode" : "fr",
        "description" : "description2",
        "displayName" : "display2"
      } ],
      "allergenCodes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://apiBaseEndpoint/richItem/12/345"
        },
        "items" : {
          "href" : "https://apiBaseEndpoint/richItem/12/"
        }
      }
    }, {
      "businessId" : 12,
      "sku" : "3452",
      "creationDate" : "2019-08-15T16:03:04.869",
      "descriptions" : [ ],
      "allergenCodes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://apiBaseEndpoint/richItem/12/3452"
        },
        "items" : {
          "href" : "https://apiBaseEndpoint/richItem/12/"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apiBaseEndpoint/richItem/12/itemsBySkus"
    }
  }
}

Get business rich items

Get Rich Items

GET /richItem/{businessId}

Get rich items of a business based on their sku.

Path parameters

Parameter Type Optional Description

businessId

Integer

false

Id of the business owning items.

Query parameters

Supports standard paging query parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

content

Array[Object]

true

content[].businessId

Integer

false

The business id.

content[].sku

String

false

Sku of the item.

content[].pictureUrl

String

true

Url of the picture (read only).

content[].rawPictureUrl

String

true

Url of the raw (before cropping) picture (read only).

content[].fileType

String

true

Image format (eg. 'jpeg' or 'png'). Default: png.

content[].rawPicture

Array[Integer]

true

The raw picture (before cropping): used this field only to update picture (PATCH method).

content[].picture

Array[Integer]

true

The cropped picture: used this field only to update picture (PATCH method).

content[].creationDate

String

true

Creation date of the richItem (read only).

content[].lastUpdateDate

String

true

Last update date of the richItem (read only).

content[].descriptions

Array[Object]

true

List of localized descriptions.

content[].descriptions[].localeCode

String

false

Language code (ISO 639) of the description.

Size must be between 2 and 7 inclusive.

content[].descriptions[].description

String

true

Item description in the provided language.

Size must be between 0 and 4000 inclusive.

content[].descriptions[].displayName

String

true

Display name (for the customer) in the provided language.

content[].allergenCodes

Array[String]

true

Item allergens. Codes only (use /allergens endpoint to get allergen list).

content[].links

Array[Object]

true

content[].links[].rel

String

true

content[].links[].href

String

true

Example request

$ curl 'https://apiBaseEndpoint/richItem/12?size=1&page=0&sort=sku,desc' -i

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 544

{
  "_embedded" : {
    "richItemDtoList" : [ {
      "businessId" : 12,
      "sku" : "3454",
      "creationDate" : "2019-08-15T16:03:07.697",
      "descriptions" : [ ],
      "allergenCodes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://apiBaseEndpoint/richItem/12/3454"
        },
        "items" : {
          "href" : "https://apiBaseEndpoint/richItem/12/"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apiBaseEndpoint/richItem/12?size=1&page=0&sort=sku,desc"
    }
  }
}

Get picture requirements

Get Picture Requirements

GET /richItem/{businessId}/pictureSpec

Gives picture requirements.

Path parameters

Parameter Type Optional Description

businessId

Integer

false

Id of the business owning items.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

requiredAspectRatio

Decimal

true

Image aspect ratio (width divided by length). If not set, there is no aspect ratio check.

minWidth

Integer

true

Image minimum width.

minHeight

Integer

true

Image minimum height.

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

Example request

$ curl 'https://apiBaseEndpoint/richItem/12/pictureSpec' -i

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 180

{
  "requiredAspectRatio" : 1.0,
  "minWidth" : 128,
  "minHeight" : 128,
  "_links" : {
    "self" : {
      "href" : "https://apiBaseEndpoint/richItem/12/pictureSpec"
    }
  }
}

Upload item picture

Update Item Picture

PATCH /richItem/{businessId}/{sku:.+}

Partial update of the item: it only updates picture and rawPicture.

Path parameters

Parameter Type Optional Description

businessId

Integer

false

Id of the business owning items.

sku

String

false

Sku of the item.

Query parameters

No parameters.

Request fields

Path Type Optional Description

businessId

Integer

false

The business id.

sku

String

false

Sku of the item.

pictureUrl

String

true

Url of the picture (read only).

rawPictureUrl

String

true

Url of the raw (before cropping) picture (read only).

fileType

String

true

Image format (eg. 'jpeg' or 'png'). Default: png.

rawPicture

Array[Integer]

true

The raw picture (before cropping): used this field only to update picture (PATCH method).

picture

Array[Integer]

true

The cropped picture: used this field only to update picture (PATCH method).

creationDate

String

true

Creation date of the richItem (read only).

lastUpdateDate

String

true

Last update date of the richItem (read only).

descriptions

Array[Object]

true

List of localized descriptions.

descriptions[].localeCode

String

false

Language code (ISO 639) of the description.

Size must be between 2 and 7 inclusive.

descriptions[].description

String

true

Item description in the provided language.

Size must be between 0 and 4000 inclusive.

descriptions[].displayName

String

true

Display name (for the customer) in the provided language.

allergenCodes

Array[String]

true

Item allergens. Codes only (use /allergens endpoint to get allergen list).

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

Response fields

Path Type Optional Description

businessId

Integer

false

The business id.

sku

String

false

Sku of the item.

pictureUrl

String

true

Url of the picture (read only).

rawPictureUrl

String

true

Url of the raw (before cropping) picture (read only).

fileType

String

true

Image format (eg. 'jpeg' or 'png'). Default: png.

rawPicture

Array[Integer]

true

The raw picture (before cropping): used this field only to update picture (PATCH method).

picture

Array[Integer]

true

The cropped picture: used this field only to update picture (PATCH method).

creationDate

String

true

Creation date of the richItem (read only).

lastUpdateDate

String

true

Last update date of the richItem (read only).

descriptions

Array[Object]

true

List of localized descriptions.

descriptions[].localeCode

String

false

Language code (ISO 639) of the description.

Size must be between 2 and 7 inclusive.

descriptions[].description

String

true

Item description in the provided language.

Size must be between 0 and 4000 inclusive.

descriptions[].displayName

String

true

Display name (for the customer) in the provided language.

allergenCodes

Array[String]

true

Item allergens. Codes only (use /allergens endpoint to get allergen list).

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

Example request

$ curl 'https://apiBaseEndpoint/richItem/12/enimage' -i -X PATCH -H 'Content-Type: application/json' -d '{
  "businessId" : 12,
  "sku" : "enimage",
  "pictureUrl" : "https://google.com",
  "fileType" : "jpeg",
  "picture" : "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBwgHBgkIBwgKCgkLDRYPDQwMDRsUFRAWIB0iIiAdHx8kKDQsJCYxJx8fLT0tMTU3Ojo6Iys/RD84QzQ5OjcBCgoKDQwNGg8PGjclHyU3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3N//AABEIAIAAgAMBIgACEQEDEQH/xAAbAAABBQEBAAAAAAAAAAAAAAAFAQIDBAYAB//EADcQAAEDAgQDBgMHBAMAAAAAAAEAAgMEEQUSITETQVEGIlJhcaEyQoEUFSNicpHRM0PB4TRzgv/EABoBAQEBAQEBAQAAAAAAAAAAAAABAwIFBAb/xAAiEQEAAgICAgIDAQAAAAAAAAAAAQIDERIxBDIiQSFRUhT/2gAMAwEAAhEDEQA/APRikSpFduXJLBKuUDUicksgRInEJEDbJE6yRA1InFIUDCEiemlNhhSFOISWQX0lkq5Ai5KnSOjpoOPPt8jfEf4QI2MubmGjfEdAon1FLFo55kP5dAqFVVyzm8jtOTRoAh1VVw07c0sjWD8xss7ZIhpXHMjRxOBps2AfXVTRYjE/+yz9gsVJj1O59oc0nmBp7qzS4m55vwyPqvmt5dK9y3jxrT9NxFJBJ8UTfopjQU8rbxPcx3R2yz2H1uawK0NNIbBaY/IpfqWd8Nq9woVNLLTn8QaeIbKBaMtEkZa4XBCAVDBDM9l7AGwuV9ETtjMIkhUnDfluWm3VR81UNITSnlNKC8uXLkCsbme1vU2VPtC+1U1h0Y1oyhWx3bOJsAd07HMPdiNIJqUDjNFwL7joub9Oq63+WC7QY82gaYobOnPXZqy8LanEZuLUPe8nXvFRYhDP96yx1bHslDzmY8WIR/DIWBjdNl4vkZbfb18WOIS0WHtY0XbqiUcQYNErTYaJLledNpl9GkzHFuxCKUWIyx/MXA7gndBueiI4fRz1OsbbMB1kdo0LqnPlqnbm/HXya7DKwTwuJNsu9ysvjQNRiIma+wboET4kdNB9npyXX+N5+Yqg9gmqYYg4N4jg0k7C5tdfpMFbRSIv28XLNZt8ejDiUjGBma4A5pkNUHyZr2dzHVa92HYbR0Z4scbGNHekeBc/X/CwVQ+MV0hpgRFn7gPRbOB/lokITYXXiZfeycq5XCmTSsgbd2rjsE6V7YYjI7fZoPVCXPdM8uJvqoJnTPmdqSi1FM4UzQHEOZpdDYIvJEImFrDZFhXxSPDsRaG4pQxzEDSS1nD0IQj7kwdjvwKmeEeFwzBE6vmhUw1WV8OPJ7Q1rlvT1k/7soRr94C3/V/tIKLDWnWpnk8mssq1k9gWP+LB/LufJy/tdYaKHWGkzO8Upze2ykfUyygB57o2aNAFUaFINFvTHSnrGmNr2t3J73Wboqcsw4vopZngNJPRD5JaaTXM5ruZaVo5S1MvEtmkkdl2DnEgel02ip+M8Pd/SG56+ihz0zDc3f8AqKbUYm1jdCAANgoDdRUsHeBsR7roqpr9lha7EZqmQWcWtHIIlS1ro2xlxOrVdjY4o+8vDb8LdAoqeO6fWtP2pwPVS0zQoi1Tx+SvRsFtlFC3RWmBFC6+AscbDRBpmG+y100IlZ5jZBaukLSTl2RQbKntarDobckmWyCPZNe4AJ0hAVKomDQdURDiU+WEtadXaIGbjmVYln47y4G7eXmoHoqF7neIqvISdzdTyFVpSgjvd4HmiFR3I4BzsVBTUT3vZcG5O3QKWseHznL8Le6PoqPR8Ti74lb8LtU2nKvDI5hjk+E8+iqyQOhfY+oPUI5XoTorLSh8L7bq2x+iirQKqVzJBeSNucW7zOZ9FO06Jb3VGanr6NjskkrYn+CTuu/YqnUYhStF+PGP/QWlraOGpZlmjY8fmaCs/VdmcPJLm0kIPlGFADqccpAS2OTiu6RjMfZC6iaetNpBwoecd9X+p6eS0EuCMjFmMsPLRU5MLcNgUAwmwsoXuRN2Gv6H9lzMKc/l+6oDOJJsBcq3RYe97hI8a8h0RqlwlrO9pYbvdsPRQ4jiEFGDDTEOk6nkoKlbI2jYWMN5Xi36QhKV73SOL3uJcdym+SqvV0jpzG3LI3iR9OY9EqZIMwsq5Pi4U3/HkDj4Do4fRSAlpsQQUBrqZw70ZLXdQh5x3EqI2ktMwdd1FbVklwpMyxsPbSlBtUQOjPXkr8Xa3DJP7wH1H8oNESEx7Q5Bh2jw8j+r7JknaTDmi/EJQE5YWlVn0rTyQio7Y4ey4aQ4/rH+ELqu3G4pox9B/KDTGjaBcjKOp0CH1uIYfQsJfI2Rw5A6f7WNrO0GIVpsX5B63Ko2dI7NI4ud1JuhoaxLH56wlkP4cewQu3UkkprW2TwL6IpqliiLzspoKR0h1CLU1CG20ViE22hXLlyukRvYHDVDaygbIDoihSEDomhjK7B73s1BKjCXNJs1ekPha4bKrLh7H/KFNLt5m/D3N+Upn2M+H2XocuEMdyVZ+CNPJTUryYcU3kpWwW5LXHBB09k4YK3p7K8ZTbKNhPRTMpnu2aVqmYQwcvZWY8NY35U4m2Whw+R5GiJ02FW+ILQR0rW8lIIQOS60B0NEGclZbCArWS3JJlRH/9k=",
  "links" : [ ]
}'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 251

{
  "businessId" : 12,
  "sku" : "enimage",
  "pictureUrl" : "12_2182abb4-9390-4bd2-b4fd-fa216a352219.jpeg",
  "rawPictureUrl" : "12_2182abb4-9390-4bd2-b4fd-fa216a352219_raw.jpeg",
  "creationDate" : "2019-08-15T16:03:08.236",
  "descriptions" : [ ]
}

Get business locales

Get Business Locales

GET /locales/{businessId}

Get the locales (language iso code 2 or language and localisation, eg en or en_US) of a business.

Path parameters

Parameter Type Optional Description

businessId

Integer

false

Id of the business.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

Example request

$ curl 'https://apiBaseEndpoint/locales/12' -i

Example response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 14

[ "fr", "en" ]

Update business locales

Update Business Locales

PUT /locales/{businessId}

Set business item languages (language iso code 2 or language and localisation, eg en or en_US).

Path parameters

Parameter Type Optional Description

businessId

Integer

false

Id of the business.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

Example request

$ curl 'https://apiBaseEndpoint/locales/12' -i -X PUT -H 'Content-Type: application/json' -d '[ "en", "fr", "en_US" ]'

Example response

HTTP/1.1 200 OK