Webshop

Get Webshop Items

Returns a list of webshop items.

Request

GET /v2/webshop

Parameters

Name	Description
contractId	Identifier of the contract id that helps to determine what webshop items will be listed and to which possible spaces. Id is a GUID. See guid.md for the requirements the API has on GUID'S. Required

Response

Example

{
  "items": [
    {
      "id": "y4hd7Xhwyc97FrQd9KkfkXb4",
      "displayName": "Köksluckor",
      "description": "Att byta köksluckor är det perfekta sättet att ge ditt kök ett nytt liv utan att behöva genomföra en dyr och tidskrävande totalrenovering. Med ett brett utbud av vackra luckor i olika stilar, material och färger kan du enkelt anpassa ditt kök efter din personliga smak och de senaste trenderna. Oavsett om du drömmer om en modern, skandinavisk design eller en klassisk, lantlig charm, finns det något för alla. Uppgradera ditt kök snabbt och enkelt – en investering som gör stor skillnad både visuellt och funktionellt.",
      "helptext": "Efter beställning av köksluckor kontaktar vi dig för att hitta en passande tid att utföra arbetet.",
      "externalUrl": "https://www.momentum.se",
      "start": "2024-01-01T00:00:00+02:00",
      "end": "2024-12-31T00:00:00+02:00",
      "pricing": [
        {
          "priceRecurring": "",
          "priceOneTime": "9500.0000"
        }
      ]
      "attachments": [
        {
          "id": "2C0hECUjRuS20YOWFYKqvXIBE1xmFL3oIVF5sfZZYMErCV",
          "displayName": "Köksluckor",
          "contentType": "image/jpeg",
          "order": "10"
        }
      ]
      "spaces": [
        {
          "id": "eb17bb3e30bb4aefa57a12b8b65647c4",
          "displayName": "Kök",
          "pricing":
           {
             "priceRecurring": "117.0000",
             "priceOneTime": ""
           }
        }
      ]
    }
  ]
}

Name	Description
items	A list of webshop items.
pricing	A list of a webshop item pricing.
attachments	A list of a webshop item attachments.
spaces	A list of a webshop item spaces.
pricing	A webshop item pricing for a particular space.

.items

Name	Description
id	Unique identifier of the webshop item. Id is a GUID.
displayName	The name of the webshop item.
description	A text that describes the webshop item.
helptext	A text that is intended to describe what it means to order this webshop item.
start	The start date for the webshop item to be published.
end	The end date for the webshop item to be published.
attachments	Attachments uploaded with the webshop item, e.g. a picture.

.pricing

Name	Description
priceRecurring	The monthly recurring price of the webshop item that is to be added to the rent.
priceOneTime	The price that is to be payed one time from an invoice.

.attachments

Name	Description
id	Unique identifier of the errand message attachment. Id is a GUID.
displayName	The name/description given when the attachment was uploaded.
contentType	The MIME media type of the attachment, e.g. image/jpeg.
order	In what order the attachments are to be displayed.

.spaces

Name	Description
id	Unique identifier of the space. Id is a GUID.
displayName	The name of the space.

.pricing

Name	Description
priceRecurring	The monthly recurring price of the webshop item that is to be added to the rent of this particular space.
priceOneTime	The price that is to be payed one time from an invoice of this particular space.

Put Webshop

Creates an order from the webshop item.

Request

PUT /v2/webshop/{id}

Parameters

Name	Description
id	Unique identifier of the webshop item. id is a GUID. Required. If the webshop item doesn't exist, you will get an error message.
nodeId	The identifier of the customer's rental object. Required. nodeId is a GUID.
classIds	A list of identifiers of the content in the customer's rental object. The content is preferably spaces but could be something else that the object contains.
specification	A text with additional information that describes the webshop order. The text will be added as a specification field on the internal order created.