Update shop

This request is used to update the shop by its identifier.


        POST


        https://api.eventgoose.com/v1/shops/{id}

Authentication

Authenticate yourself using your organisation api token

Parameters

Note

Unlike the Create shop resource most of the parameters in this resource will be optional. This ensures that individual elements can be updated without including all the parameters over and over.

url

string

optional

A unique url (subdomain) to access the shop.

For example: shopname.eventgoose.com


                        events

array|null

optional

Attach one or multiple events to the shop by their identifier.

This will replace the current events. If you want to delete the current events, set the value to null


                        language

string

optional

The default language the shop will be presented in.

Must be one of the following values: EN NL


                        header_image

file

optional

An image that will be displayed inside the shop.

Desired dimensions are 1140 x 400px and the max file size is 5mb

Set the value to null to remove the current header image.


                        availability

array

optional

Determine when the shop will be available to the public.

This will replace the current availability. If you want to delete the current availability, set the value to null


                                        opens_at

date

required

A datetime in the following format ISO 8601

For example: 2021-07-05T10:00:00.000Z


                                        closes_at

date

required

A datetime in the following format ISO 8601

For example: 2021-07-05T10:00:00.000Z


                        payment_methods

array

optional

The payment methods which the customers can pay with in the shop.

The supported payment methods are: ideal bancontactmrcash paypal creditcard applepay

This will replace the current payment methods if they exist. If you want to delete the current payment methods, set the value to null


                        google_analytics_tag

string

optional

A Google Analytics tag can be added to the shop for tracking purposes.

Set the value to null to remove the current Google Analytics tag.


                        facebook_pixel_id

string

optional

A Facebook Pixel ID can be added to the shop for tracking purposes.

Set the value to null to remove the current Facebook Pixel ID.


                        social

object

optional

Provide the shop with links to your social media.

`facebook` string optional	The Facebook handle of your account.
`twitter` string optional	The Twitter handle of your account.
`instagram` string optional	The Instagram handle of your account.
`linkedin` string optional	The LinkedIn handle of your account.


                        protected

boolean

optional

Determine if the shop is protected or not.


                        queue

object

optional

Setup a queue for the shop.

Set the value to null to remove the current queue object.

`is_active` boolean optional	Determine if the queue activated or not.
`max_visitors` integer optional	The max amount of visitors that are allowed in the shop.
`video_url` string optional	A YouTube video that will be displayed for all the waiting customers.


                        custom_color

string

optional

Customize your shop with a hexadecimal color code.

Set the value to null to remove the current custom color.

Response

200 application/json

    HTTP/1.1 200 OK
Content-Type: application/json
    
{
    "id": "a5KgQw2vqOPlAZJ9",
    "url": "shop1",
    "full_url": "https://shop1.eventgoose.com",
    "banner": null,
    "language": "EN",
    "html": null,
    "css": null,
    "custom_color": null,
    "text": null,
    "protected": false,
    "invoicing": false,
    "availability": [],
    "socials": [],
    "is_available": true
}