Create a venue
POST
Creates a new venue, the top-level business location that stores belong to, and returns it directly with HTTP 201. Venue names must be unique.
How to use it
- Send a unique, non-blank name and optionally a status (defaults to ACTIVE).
- The response (HTTP 201) is the venue itself with its new id, not wrapped in the status/message envelope.
- Use the venue id when creating stores that belong to this venue.
BearerAuthheader
AuthorizationBearer <JWT>application/json- body
id?|Venue (site) ID.
Format
int64name*stringVenue name.
status*stringVenue status: ACTIVE, INACTIVE, ARCHIVED or DELETED.
Value in
"ACTIVE""INACTIVE""ARCHIVED""DELETED"modifiedTime*stringWhen the venue was last changed.
Format
date-timeOK
*/*- response
id?|Venue (site) ID.
Format
int64name*stringVenue name.
status*stringVenue status: ACTIVE, INACTIVE, ARCHIVED or DELETED.
Value in
"ACTIVE""INACTIVE""ARCHIVED""DELETED"modifiedTime*stringWhen the venue was last changed.
Format
date-timeExample Request
curl -X POST 'https://beta.iotoms.com/api/v1/catalog/business/venues' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "status": "ACTIVE", "modifiedTime": "2019-08-24T14:15:22Z"}'Example Response
{ "id": 0, "name": "string", "status": "ACTIVE", "modifiedTime": "2019-08-24T14:15:22Z"}