Follow

Create External Venue

Create a new externalVenue. If a venue with the same ID already exists then it will be replaced. 

 

Attributes 

Attribute

Value

Path

/v3/organisations/{orgnisationID}/externalVenues

Support Formats

JSON, XML

HTTP Method

POST

Secure

Yes

Rate Limited

No

Cache Timeout

TBC

HTTP Codes

·        201 - Created

·        204 - No Content

·        400 - Bad Request

·        500 - Internal Server Error

 

Request

The following table contains the details of a typical HTTP request for this service:

Type

Value

Header

POST /v3/orgnisations/123/externalVenues HTTP/1.1

Host: merchant.api.vmob.co

Content-Type: application/json

Accept-Language: en-US

x-vmob-authorization: dm1vYi53aW5kb3dzLjE6

Body 

{

    "id": "12345",

    "systemType": "5",

    "venueTypeCode": "PHYSICAL",

    "name": "Kingsland TyrePower",

    "alternativeName": null,

    "addressLine1": "2232 Great North Rd",

    "addressLine2": Kingsland,

    "addressLine3": Auckland,

    "alternativeAddressLine1": null,

    "alternativeAddressLine2": null,

    "alternativeAddressLine3": null,

    "postCode": "90210",

    "phone": null,

    "email": "ben@vmob.co",

    "web": null,

    "latitude": null,

    "longitude": null,

    "organisationId": 575,

    "isHidden": false,

    "openHours": [

        {

            "day":"mon",

            "start":"08:00",

            "end":"18:00",

            "note":"Test Note"

        },

        {

            "day":"wed",

            "start":"08:00",

            "end":"20:00",

            "note":""

        }

    ],

    "features":[

        "Wi-Fi",

        "Parking"

    ],

    "contentTagReferenceCodes":[

      "Wynyard",

      "Viaduct"

    ],

}

 Notes:

  • None

 

Successful Response

The following table contains the details of a typical successful HTTP request for this service.

Type

Value

Header

HTTP/1.1 201 CREATED

Content-Type: application/json

Cache-Control: no-store

Pragma: no-cache


Notes:

  • The returned status code indicates whether an update or create has occurred.
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.