Download OpenAPI specification:
This API enables the integration of spots managed in external CMSs (i.e., CMSs other than Platinum Map) with those managed in Platinumaps.
When a spot is registered in the external CMS, call the Spot Registration API.
Save the spotId (the spot ID in Platinumaps) returned by the Spot Registration API, mapped to the spot information in the external CMS. This ID will be required when updating or deleting the spot.
To add data in another language (e.g., Chinese) for a registered spot, call the Spot Update API. Specify the language using the locale parameter.
※ Note: Fields that are common across languages (e.g., latitude, longitude) are also subject to update. For fields that you do not wish to update, use the values retrieved via the Spot Details API.
To register or update congestion status for a registered spot, call the Spot Congestion Status Update API.
When a spot is updated in the external CMS, call the Spot Update API.
When a spot is temporarily removed in the external CMS (e.g., if recovery from deletion is possible), you can set the spot to private using the Spot Update API. To make the spot public again, also use the Spot Update API.
When a spot is permanently deleted in the external CMS, call the Spot Deletion API.
A spot has two kinds of description: description in plain text and descriptionHtml in HTML. useDescriptionHtml decides which one the map displays.
useDescriptionHtml is common to all languages. When it is true, the map displays descriptionHtml instead of description in every language. In a language without descriptionHtml, no description is displayed.descriptionHtml is displayed only on maps where HTML descriptions are enabled in the map settings. On other maps, description is displayed even when useDescriptionHtml is true.description and descriptionHtml are set for each language.description is used for spot search and machine translation even while descriptionHtml is displayed. We recommend that you also set the content in plain text in description.descriptionHtml, the server removes elements and attributes that are not allowed. See "Allowed HTML" below. The value returned by the Spot Details API may therefore differ from the value you sent.translationLocales) translates description but not descriptionHtml, and it does not change the descriptionHtml of the target languages. When useDescriptionHtml is true, register descriptionHtml for each language with the Spot Update API or the Spot Partial Update API.p, br, h1, h2, h3, strong, blockquote, pre, code, hr, a, img, div, span, iframe. Other elements are removed, but their content is kept. script, style, template, noscript, title, form controls (textarea, select), and embedded content (object, embed, svg, math, canvas, audio, video, frames) are removed together with their content.href, target, rel, src, alt, title, width, height, and style, are kept. Event handler attributes (such as onclick), id, srcdoc, and data- attributes other than data-spot-id are removed. All attributes of strong and code are removed.class: class names are kept as sent.href, src, and style must use http or https. href may also use mailto or tel. The src of img may also be a Base64 data: URL of a PNG, JPEG, GIF, or WebP image. The src of iframe must be an absolute http or https URL. Other URLs, such as javascript: URLs, are removed.rel always includes noopener and noreferrer.style: CSS properties for text, color, background, border, spacing, and size are kept. position is kept only when its value is relative or absolute. A style attribute that contains a backslash or a line break is removed entirely.a, strong, and code inside the paragraph or heading where you opened them. If such a tag is still open when the paragraph ends, or is closed outside it, HTML parsing repeats the tag in the content that follows, so the request is rejected. A link (a) cannot contain another link.descriptionHtml must be within 500,000 bytes in UTF-8 and 10,000 < characters both as sent and as saved, and each tag can have up to 32 attributes. The saved HTML can be longer than the value you sent, because the server closes unclosed tags, adds rel to links, and writes some characters, such as no-break spaces, as character references. If the saved HTML would exceed the limits, the request is rejected.The Spot Update API also replaces useDescriptionHtml and descriptionHtml. If you omit them, useDescriptionHtml is set to false, and the descriptionHtml of the language specified by locale is removed. To keep an HTML description entered on the Platinumaps admin screen, send the values retrieved via the Spot Details API, or use the Spot Partial Update API and omit these fields.
Returns information for all registered spots on the map.
| Platinumaps-Map-Slug | string Example: yourmapslug Map slug |
{- "spots": [
- {
- "spotId": 123,
- "title": "string",
- "shareType": 1,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}Registers a new spot.
| Platinumaps-Map-Slug | string Example: yourmapslug Map slug |
Information about the spot to be registered
| locale required | integer <int32> (LocaleType) Enum: 1 2 3 4 5 6 7 8 9 10 11 Language specification 1:Japanese | 2:English | 3:Chinese(Simplified) | 4:Korean | 5:Chinese(Traditional) | 6:French | 7:Spanish | 8:Vietnamese | 9:Indonesian | 10:Myanmar | 11:Thai |
| translationLocales | Array of integers <int32> (LocaleType) >= 0 items [ items <int32 > ] Items Enum: 1 2 3 4 5 6 7 8 9 10 11 Language selection for machine translation (optional). |
Array of objects (Banner) <= 10 characters Spot images | |
| logoImageUrl | string (url) <= 2000 characters URL String |
| markerImageUrl | string (url) <= 2000 characters URL String |
| spotMarkupMasterId | integer or null <int64> >= 0 Spot markup master ID (specify an active master available for the current account and map; specify null, 0, or omit for no markup) |
| categoryIds | Array of integers <int64> [ items <int64 > ] Categories |
| pictgramIds | Array of integers <int64> [ items <int64 > ] Pictograms |
| tags | Array of strings Tags |
| shareType required | integer <int32> (ShareType) Default: 1 Publication settings 1:Published | 3:Private | 9:Deleted |
| latitude | number Latitude |
| longitude | number Longitude |
| effectiveFrom | string <date-time> (datetime) Date/Time string(UTC) |
| effectiveTo | string <date-time> (datetime) Date/Time string(UTC) |
| heldFrom | string <date-time> (datetime) Date/Time string(UTC) |
| heldTo | string <date-time> (datetime) Date/Time string(UTC) |
| title required | string <= 500 characters Spot/Facility name |
| titleRuby | string <= 1000 characters Ruby |
| searchKeyword | string <= 200 characters Search keywords |
| titleKana | string <= 200 characters Deprecated Search keywords (use |
| subTitle | string <= 500 characters Subtitle |
| description | string <= 4000 characters Description in plain text. It is also used for spot search and machine translation, even while |
| useDescriptionHtml | boolean Default: false Whether to display |
| descriptionHtml | string or null Description in HTML for the language specified by |
| address | string <= 1000 characters Address |
| phoneNumber | string <= 500 characters Phone number |
| faxNumber | string <= 30 characters FAX number |
| webUrl | string (url) <= 2000 characters URL String |
| businessHour | string <= 2000 characters Business hours (free text) |
object (BusinessHourData) Business hours (Structured data) | |
| holiday | string <= 2000 characters Closed days |
| parking | string <= 2000 characters Parking |
| access | string <= 2000 characters Access |
| fee | string <= 2000 characters Fees |
| paymentMethod | string <= 2000 characters Payment methods |
| remarks | string <= 2000 characters Notes |
Array of objects Detailed item list | |
object (SnsLinks) Links to various social media sites | |
object (FloorOptions) Available for Metamap system only | |
Array of objects (MenuRequest) Menu (price list) information. |
{- "locale": 1,
- "translationLocales": [
- 1
], - "banners": [
- {
- "url": "string",
- "mediaType": 1,
- "caption": "string"
}
], - "logoImageUrl": "string",
- "markerImageUrl": "string",
- "spotMarkupMasterId": 0,
- "categoryIds": [
- 111,
- 222,
- 333
], - "pictgramIds": [
- 444,
- 555,
- 666
], - "tags": [
- "Tempura",
- "Sushi"
], - "shareType": 1,
- "latitude": 0,
- "longitude": 0,
- "effectiveFrom": "2019-08-24T14:15:22Z",
- "effectiveTo": "2019-08-24T14:15:22Z",
- "heldFrom": "2019-08-24T14:15:22Z",
- "heldTo": "2019-08-24T14:15:22Z",
- "title": "string",
- "titleRuby": "string",
- "searchKeyword": "string",
- "titleKana": "string",
- "subTitle": "string",
- "description": "string",
- "useDescriptionHtml": false,
- "descriptionHtml": "string",
- "address": "string",
- "phoneNumber": "string",
- "faxNumber": "string",
- "webUrl": "string",
- "businessHour": "string",
- "businessHourData": {
- "normal": [
- {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}
], - "holiday": {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}
}, - "holiday": "string",
- "parking": "string",
- "access": "string",
- "fee": "string",
- "paymentMethod": "string",
- "remarks": "string",
- "customProperties": [
- {
- "customPropertyId": 0,
- "value": "string"
}
], - "sns": {
- "facebook": "string",
- "x": "string",
- "instagram": "string",
- "youtube": "string",
- "line": "string",
- "weibo": "string",
- "threads": "string"
}, - "floorOptions": {
- "floor": "2F",
- "floorDescription": "2nd floor food court",
- "block": "A123",
- "area": "T1"
}, - "menus": [
- {
- "menuId": 0,
- "name": "string",
- "columnCount": 1,
- "currencyCode": "JPY",
- "withTax": true,
- "sortOrder": 0,
- "shareType": 1,
- "items": [
- {
- "menuItemId": 0,
- "name": "string",
- "description": "string",
- "priceText": "string",
- "imageUrl": "string",
- "useFreePriceText": true,
- "priceTextCommon": "string",
- "sortOrder": 0,
- "shareType": 1
}
]
}
]
}{- "spotId": 0,
- "createdAt": "2019-08-24T14:15:22Z"
}Returns detailed information about the spot.
| spotId required | integer <int64> Example: 123 Spot ID |
| locale | integer <int32> (LocaleType) Enum: 1 2 3 4 5 6 7 8 9 10 11 Example: locale=1 Language specification |
| Platinumaps-Map-Slug | string Example: yourmapslug Map slug |
{- "spotId": 0,
- "locale": 1,
- "originalLocale": 1,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "banners": [
- {
- "url": "string",
- "staticImageUrl": "string",
- "width": 0,
- "height": 0,
- "mediaType": 1,
- "caption": "string"
}
], - "thumbnailImageUrl": "string",
- "logoImageUrl": "string",
- "markerImageUrl": "string",
- "spotMarkupMasterId": 0,
- "markerIconWidth": 0,
- "markerIconHeight": 0,
- "categoryIds": [
- 0
], - "pictgramIds": [
- 0
], - "tags": [
- "string"
], - "shareType": 1,
- "latitude": 0,
- "longitude": 0,
- "effectiveFrom": "2019-08-24T14:15:22Z",
- "effectiveTo": "2019-08-24T14:15:22Z",
- "heldFrom": "2019-08-24T14:15:22Z",
- "heldTo": "2019-08-24T14:15:22Z",
- "title": "string",
- "titleRuby": "string",
- "searchKeyword": "string",
- "titleKana": "string",
- "subTitle": "string",
- "description": "string",
- "useDescriptionHtml": true,
- "descriptionHtml": "string",
- "address": "string",
- "phoneNumber": "string",
- "faxNumber": "string",
- "webUrl": "string",
- "businessHour": "string",
- "holiday": "string",
- "parking": "string",
- "access": "string",
- "fee": "string",
- "paymentMethod": "string",
- "remarks": "string",
- "customProperties": [
- {
- "customPropertyId": 0,
- "label": "string",
- "value": "string",
- "dataType": 1,
- "flagType": 3,
- "isHidden": true,
- "textAlign": 1
}
], - "sns": {
- "facebook": "string",
- "x": "string",
- "instagram": "string",
- "youtube": "string",
- "line": "string",
- "weibo": "string",
- "threads": "string"
}, - "floorOptions": {
- "floor": "2F",
- "floorDescription": "2nd floor food court",
- "block": "A123",
- "area": "T1"
}, - "menus": [
- {
- "menuId": 0,
- "name": "string",
- "columnCount": 0,
- "currencyCode": "JPY",
- "withTax": true,
- "sortOrder": 0,
- "shareType": 1,
- "items": [
- {
- "menuItemId": 0,
- "name": "string",
- "description": "string",
- "priceText": "string",
- "imageUrl": "string",
- "useFreePriceText": true,
- "priceTextCommon": "string",
- "sortOrder": 0,
- "shareType": 1
}
]
}
]
}Updates the information of the specified spot.
| spotId required | integer <int64> Example: 123 Spot ID |
| Platinumaps-Map-Slug | string Example: yourmapslug Map slug |
| spotId required | integer <int64> Spot ID of the spot to be updated |
| locale required | integer <int32> (LocaleType) Enum: 1 2 3 4 5 6 7 8 9 10 11 Language specification 1:Japanese | 2:English | 3:Chinese(Simplified) | 4:Korean | 5:Chinese(Traditional) | 6:French | 7:Spanish | 8:Vietnamese | 9:Indonesian | 10:Myanmar | 11:Thai |
| translationLocales | Array of integers <int32> (LocaleType) >= 0 items [ items <int32 > ] Items Enum: 1 2 3 4 5 6 7 8 9 10 11 Language selection for machine translation (optional). |
Array of objects (Banner) <= 10 characters Spot image (do not include information on banners to be deleted) | |
| logoImageUrl | string (url) <= 2000 characters URL String |
| markerImageUrl | string (url) <= 2000 characters URL String |
| spotMarkupMasterId | integer or null <int64> >= 0 Spot markup master ID (specify an active master available for the current account and map; specify null, 0, or omit to remove the current markup) |
| categoryIds | Array of integers <int64> [ items <int64 > ] Categories |
| pictgramIds | Array of integers <int64> [ items <int64 > ] Pictograms |
| tags | Array of strings Tags |
| shareType required | integer <int32> (ShareType) Default: 1 Publication settings 1:Published | 3:Private | 9:Deleted |
| latitude | number Latitude |
| longitude | number Longitude |
| effectiveFrom | string <date-time> (datetime) Date/Time string(UTC) |
| effectiveTo | string <date-time> (datetime) Date/Time string(UTC) |
| heldFrom | string <date-time> (datetime) Date/Time string(UTC) |
| heldTo | string <date-time> (datetime) Date/Time string(UTC) |
| title required | string <= 500 characters Spot/Facility name |
| titleRuby | string <= 1000 characters Ruby |
| searchKeyword | string <= 200 characters Search keywords |
| titleKana | string <= 200 characters Deprecated Search keywords (use |
| subTitle | string <= 500 characters Subtitle |
| description | string <= 4000 characters Description in plain text. It is also used for spot search and machine translation, even while |
| useDescriptionHtml | boolean Default: false Whether to display |
| descriptionHtml | string or null Description in HTML for the language specified by |
| address | string <= 1000 characters Address |
| phoneNumber | string <= 500 characters Phone number |
| faxNumber | string <= 30 characters FAX number |
| webUrl | string (url) <= 2000 characters URL String |
| businessHour | string <= 2000 characters Business hours (free text) |
object (BusinessHourData) Business hours (Structured data) | |
| holiday | string <= 2000 characters Closed days |
| parking | string <= 2000 characters Parking |
| access | string <= 2000 characters Access |
| fee | string <= 2000 characters Fees |
| paymentMethod | string <= 2000 characters Payment methods |
| remarks | string <= 2000 characters Notes |
Array of objects Detailed item list | |
object (SnsLinks) Links to various social media sites | |
object (FloorOptions) Available for Metamap system only | |
Array of objects (MenuRequest) Menu (price list) information.
If specified, the existing menu information will be completely overwritten by the contents of this array.
To delete all menu groups, specify an empty array |
{- "spotId": 123,
- "locale": 1,
- "translationLocales": [
- 1
], - "banners": [
- {
- "url": "string",
- "mediaType": 1,
- "caption": "string"
}
], - "logoImageUrl": "string",
- "markerImageUrl": "string",
- "spotMarkupMasterId": 0,
- "categoryIds": [
- 111,
- 222,
- 333
], - "pictgramIds": [
- 444,
- 555,
- 666
], - "tags": [
- "Curry",
- "Sushi"
], - "shareType": 1,
- "latitude": 0,
- "longitude": 0,
- "effectiveFrom": "2019-08-24T14:15:22Z",
- "effectiveTo": "2019-08-24T14:15:22Z",
- "heldFrom": "2019-08-24T14:15:22Z",
- "heldTo": "2019-08-24T14:15:22Z",
- "title": "string",
- "titleRuby": "string",
- "searchKeyword": "string",
- "titleKana": "string",
- "subTitle": "string",
- "description": "string",
- "useDescriptionHtml": false,
- "descriptionHtml": "string",
- "address": "string",
- "phoneNumber": "string",
- "faxNumber": "string",
- "webUrl": "string",
- "businessHour": "string",
- "businessHourData": {
- "normal": [
- {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}
], - "holiday": {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}
}, - "holiday": "string",
- "parking": "string",
- "access": "string",
- "fee": "string",
- "paymentMethod": "string",
- "remarks": "string",
- "customProperties": [
- {
- "customPropertyId": 0,
- "value": "string"
}
], - "sns": {
- "facebook": "string",
- "x": "string",
- "instagram": "string",
- "youtube": "string",
- "line": "string",
- "weibo": "string",
- "threads": "string"
}, - "floorOptions": {
- "floor": "2F",
- "floorDescription": "2nd floor food court",
- "block": "A123",
- "area": "T1"
}, - "menus": [
- {
- "menuId": 0,
- "name": "string",
- "columnCount": 1,
- "currencyCode": "JPY",
- "withTax": true,
- "sortOrder": 0,
- "shareType": 1,
- "items": [
- {
- "menuItemId": 0,
- "name": "string",
- "description": "string",
- "priceText": "string",
- "imageUrl": "string",
- "useFreePriceText": true,
- "priceTextCommon": "string",
- "sortOrder": 0,
- "shareType": 1
}
]
}
]
}{- "spotId": 0,
- "updatedAt": "2019-08-24T14:15:22Z"
}Updates only the specified fields of the specified spot's information.
Do not include the key names of items that are not to be updated in the request's JSON structure.
Example: Updating only the address
{
"spotId": 123,
"locale": 1,
"address": "3-9 Nishishinjuku, Shinjuku-ku, Tokyo, Frontier Shinjuku Tower"
}
If a field key name exists, the value will be updated even if it is null.
Example: Deleting the description
{
"spotId": 123,
"locale": 1,
"description": null
}
In the PatchSpot model, top-level items are not updated by omitting their key names. However, for nested items, you must specify all values for the updated fields. Any unspecified nested items will be updated to null.
Example: Updating the URL for X (formerly Twitter) and deleting other URLs (such as Facebook)
{
"spotId": 123,
"locale": 1,
"sns": {
"x": "[https://x.com/BoldrightInc](https://x.com/BoldrightInc)"
}
}
| spotId required | integer <int64> Example: 123 Spot ID |
| Platinumaps-Map-Slug | string Example: yourmapslug Map slug |
| spotId required | integer <int64> Spot ID to be updated |
| locale required | integer <int32> (LocaleType) Enum: 1 2 3 4 5 6 7 8 9 10 11 Language specification 1:Japanese | 2:English | 3:Chinese(Simplified) | 4:Korean | 5:Chinese(Traditional) | 6:French | 7:Spanish | 8:Vietnamese | 9:Indonesian | 10:Myanmar | 11:Thai |
| translationLocales | Array of integers <int32> (LocaleType) >= 0 items [ items <int32 > ] Items Enum: 1 2 3 4 5 6 7 8 9 10 11 Language selection for machine translation (optional). |
Array of objects (Banner) <= 10 characters Spot images | |
| logoImageUrl | string (url) <= 2000 characters URL String |
| markerImageUrl | string (url) <= 2000 characters URL String |
| spotMarkupMasterId | integer or null <int64> >= 0 Spot markup master ID (specify an active master available for the current account and map; omit to preserve the current markup, or specify null or 0 to remove it) |
| categoryIds | Array of integers <int64> [ items <int64 > ] Categories |
| pictgramIds | Array of integers <int64> [ items <int64 > ] Pictograms |
| tags | Array of strings Tags |
| shareType | integer <int32> (ShareType) Default: 1 Publication settings 1:Published | 3:Private | 9:Deleted |
| latitude | number Latitude |
| longitude | number Longitude |
| effectiveFrom | string <date-time> (datetime) Date/Time string(UTC) |
| effectiveTo | string <date-time> (datetime) Date/Time string(UTC) |
| heldFrom | string <date-time> (datetime) Date/Time string(UTC) |
| heldTo | string <date-time> (datetime) Date/Time string(UTC) |
| title | string <= 500 characters Spot/Facility name |
| titleRuby | string <= 1000 characters Ruby |
| searchKeyword | string <= 200 characters Search keywords |
| subTitle | string <= 500 characters Subtitle |
| description | string <= 4000 characters Description in plain text. It is also used for spot search and machine translation, even while |
| useDescriptionHtml | boolean or null Whether to display |
| descriptionHtml | string or null Description in HTML for the language specified by |
| address | string <= 1000 characters Address |
| phoneNumber | string <= 500 characters Phone number |
| faxNumber | string <= 30 characters FAX number |
| webUrl | string (url) <= 2000 characters URL String |
| businessHour | string <= 2000 characters Business hours (free text) |
object (BusinessHourData) Business hours (Structured data) | |
| holiday | string <= 2000 characters Closed days |
| parking | string <= 2000 characters Parking |
| access | string <= 2000 characters Access |
| fee | string <= 2000 characters Fees |
| paymentMethod | string <= 2000 characters Payment methods |
| remarks | string <= 2000 characters Notes |
Array of objects Detailed item list | |
object (SnsLinks) Links to various social media sites | |
object (FloorOptions) Available for Metamap system only | |
Array of objects (PatchMenu) Menu (price list) information.
If specified, the existing menu information will be completely overwritten by the contents of this array.
To delete all menu groups, specify an empty array |
{- "spotId": 123,
- "locale": 1,
- "translationLocales": [
- 1
], - "banners": [
- {
- "url": "string",
- "mediaType": 1,
- "caption": "string"
}
], - "logoImageUrl": "string",
- "markerImageUrl": "string",
- "spotMarkupMasterId": 0,
- "categoryIds": [
- 111,
- 222,
- 333
], - "pictgramIds": [
- 444,
- 555,
- 666
], - "tags": [
- "Curry",
- "Sushi"
], - "shareType": 1,
- "latitude": 0,
- "longitude": 0,
- "effectiveFrom": "2019-08-24T14:15:22Z",
- "effectiveTo": "2019-08-24T14:15:22Z",
- "heldFrom": "2019-08-24T14:15:22Z",
- "heldTo": "2019-08-24T14:15:22Z",
- "title": "string",
- "titleRuby": "string",
- "searchKeyword": "string",
- "subTitle": "string",
- "description": "string",
- "useDescriptionHtml": true,
- "descriptionHtml": "string",
- "address": "string",
- "phoneNumber": "string",
- "faxNumber": "string",
- "webUrl": "string",
- "businessHour": "string",
- "businessHourData": {
- "normal": [
- {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}, - {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}
], - "holiday": {
- "isOpen": true,
- "hours": [
- {
- "open": "stri",
- "close": "stri",
- "lastOrder": "stri"
}
]
}
}, - "holiday": "string",
- "parking": "string",
- "access": "string",
- "fee": "string",
- "paymentMethod": "string",
- "remarks": "string",
- "customProperties": [
- {
- "customPropertyId": 0,
- "value": "string"
}
], - "sns": {
- "facebook": "string",
- "x": "string",
- "instagram": "string",
- "youtube": "string",
- "line": "string",
- "weibo": "string",
- "threads": "string"
}, - "floorOptions": {
- "floor": "2F",
- "floorDescription": "2nd floor food court",
- "block": "A123",
- "area": "T1"
}, - "menus": [
- {
- "menuId": 0,
- "name": "string",
- "columnCount": 1,
- "currencyCode": "JPY",
- "withTax": true,
- "sortOrder": 0,
- "shareType": 1,
- "items": [
- {
- "menuItemId": 0,
- "name": "string",
- "description": "string",
- "priceText": "string",
- "imageUrl": "string",
- "useFreePriceText": true,
- "priceTextCommon": "string",
- "sortOrder": 0,
- "shareType": 1
}
]
}
]
}{- "spotId": 0,
- "updatedAt": "2019-08-24T14:15:22Z"
}Sets the congestion status or wait time for a spot.
| Platinumaps-Map-Slug | string Example: yourmapslug Map slug |
Spot congestion status
| spotId required | integer <int64> Spot ID to configure |
| statusType required | integer <int32> Enum: 0 1 Congestion category 0:Congestion information | 1:Wait time |
| crowdStatusConfigId | integer <int64> Congestion status ID (required when congestion category is 0) |
| crowdStatusLevel | integer <int32> Specifies the level for the Congestion Status ID setting (e.g., 3:Crowded). |
| waitingTimeType | integer <int32> Enum: 0 1 2 Wait time category 0:Minutes | 1:Within minutes | 2:Minutes or more (required when congestion category is 1) |
| waitingTime | integer <int32> Wait time (in minutes) (required when congestion category is 1) |
{- "spotId": 123,
- "statusType": 0,
- "crowdStatusConfigId": 44,
- "crowdStatusLevel": 3,
- "waitingTimeType": null,
- "waitingTime": null
}{ }Returns information for spots whose update time falls within the specified period.
| from required | string <date-time> (datetime) Updated at (From) |
| to | string <date-time> (datetime) Updated at (To) |
| Platinumaps-Map-Slug | string Example: yourmapslug Map slug |
{- "spots": [
- {
- "spotId": 123,
- "shareType": 1,
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}Upload a CSV or Excel file in multipart/form-data format to perform batch registration, updating, or deletion of spot information.
When this API call is complete, only the request is accepted, and the actual registration, update, or deletion process is performed asynchronously.
Please check the processing progress and results from "Excel Data Integration" on the Platinumaps admin screen.
Please refer to the Excel format that can be downloaded from the "Excel Data Integration" section of the Platinumaps admin screen, as well as the help documentation for the settings on the same page.
For CSV files, please insert a header row with the same column names as the Excel format as the first row. Character encoding: UTF-8 Line breaks: LF
| Platinumaps-Map-Slug | string Example: yourmapslug Map slug |
| file required | string <binary> Excel file to upload |
{ }