openapi: 3.0.1
info:
  title: Documentation ApplicationService
  description: >-
    The Applications namespace has Entities and Operations concerned with the
    Application as such. It contains the Application entity, Stores and other
    lookup data common to an Application.
  version: '1.1'
servers:
  - url: https://demo.storm.io/api/1.1
paths:
  /ApplicationService.svc/rest/GetApplication:
    get:
      tags:
        - Application
      summary: Get current application
      description: >-
        GetApplication gets the current application data based on the provided
        Oauth2 credentials.
      operationId: GetApplication
      parameters:
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
            application/xml:
              schema:
                $ref: '#/components/schemas/Application'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/ListApplicationFlagGroups:
    get:
      tags:
        - Flags
      summary: List application flag groups
      description: >-
        Lists the flag groups available for this application. Flag group can be
        used when listing flags to narrow it down to a specific group.
      operationId: ListApplicationFlagGroups
      parameters:
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IdValue'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IdValue'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/ListApplicationFlags:
    get:
      tags:
        - Flags
      summary: List application flags
      description: >-
        Lists the flags available for this application. Flag group id can be
        used when listing flags to narrow it down to a specific flag. See
        ListApplicationFlagGroups for available groups.
      operationId: ListApplicationFlags
      parameters:
        - name: flagGroupId
          in: query
          description: >-
            Specifies an optional flag group to select flags from. All flags are
            retrieved if flagGroupId is not specified.
          schema:
            type: string
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IdValue'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IdValue'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/ListInfoTypes:
    get:
      tags:
        - InfoTypes
      summary: List info types
      description: Reference list of InfoType values.
      operationId: ListInfoTypes
      parameters:
        - name: groupId
          in: query
          description: >-
            Specifies the groupId of values to retrieve. Only CustomerInfo(1)
            and DivisionInfo(4) are supported.
          schema:
            type: string
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IdNameDescription'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IdNameDescription'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/GetLocationInfoByZipCode:
    get:
      tags:
        - Location
      summary: Get location info by zip code
      description: >-
        Gets the LocationInfo for a given zip code. The mapping of zip codes to
        Locations is done in the StormAdmin if not implemented through
        integration. Returns null if the LocationInfo does not exist.
      operationId: GetLocationInfoByZipCode
      parameters:
        - name: countryCode
          in: query
          description: The ISO 3166-1 alpha-2 is used. SE for Sweden.
          required: true
          schema:
            type: string
        - name: zip
          in: query
          description: The zip code to get a location for.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/LocationInfo'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/GetStore:
    get:
      tags:
        - Stores
      summary: Get store
      description: >-
        Gets a Store by Id. Should be used to display details about a Store or
        when just data for a single Store is needed. Returns null if the Store
        does not exist.
      operationId: GetStore
      parameters:
        - name: id
          in: query
          description: The internal Id of the Store to fetch.
          required: true
          schema:
            type: integer
            format: int32
        - name: longitude
          in: query
          description: >-
            Longitude for current position. Store will calculate the Distance if
            supplied together with latitude. Format: decimal.
          schema:
            type: string
        - name: latitude
          in: query
          description: >-
            Latitude for current position. Store will calculate the Distance if
            supplied together with longitude. Format: decimal.
          schema:
            type: string
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Store'
            application/xml:
              schema:
                $ref: '#/components/schemas/Store'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/GetStoreByUniqueName:
    get:
      tags:
        - Stores
      summary: Get store by unique name
      description: >-
        Gets a Store by its unique url name. Should be used to display details
        about a Store or when just data for a single Store is needed. Returns
        null if the Store does not exist.
      operationId: GetStoreByUniqueName
      parameters:
        - name: uniqueName
          in: query
          description: The unique name of the Store to fetch.
          required: true
          schema:
            type: string
        - name: longitude
          in: query
          description: >-
            Longitude for current position. Store will calculate the Distance if
            supplied together with latitude. Format: decimal.
          schema:
            type: string
        - name: latitude
          in: query
          description: >-
            Latitude for current position. Store will calculate the Distance if
            supplied together with longitude. Format: decimal.
          schema:
            type: string
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Store'
            application/xml:
              schema:
                $ref: '#/components/schemas/Store'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/GetStoreItem:
    get:
      tags:
        - Stores
      summary: Get store item
      description: >-
        Gets a StoreItem by Id. Should be used to display details about a
        StoreItem or when just data for a single StoreItem is needed. Returns
        null if the StoreItem does not exist.
      operationId: GetStoreItem
      parameters:
        - name: id
          in: query
          description: The internal Id of the Store to fetch.
          required: true
          schema:
            type: integer
            format: int32
        - name: partNo
          in: query
          description: >-
            If supplied, the returned StoreItem will have information about
            onHand.
          schema:
            type: string
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreItem'
            application/xml:
              schema:
                $ref: '#/components/schemas/StoreItem'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/GetStoreItemByCountryAndZipCode:
    get:
      tags:
        - Stores
      summary: Get store item by country and zipcode
      description: >-
        Gets a StoreItem by country and zip code. Should be used to display
        details about a StoreItem or when just data for a single StoreItem is
        needed. Returns null if the StoreItem does not exist.
      operationId: GetStoreItemByCountryAndZipCode
      parameters:
        - name: countryId
          in: query
          description: >-
            Specifies in which countryId. If none is supplied, value is resolved
            from Application default. Valid countryIds can be found in
            Application.Countries.
          schema:
            type: string
        - name: zipCode
          in: query
          description: >-
            The zip code of the end user. The StoreItem is resolved by looking
            at deliveryMethod locations as set up in StormAdmin.
          required: true
          schema:
            type: integer
            format: int32
        - name: partNo
          in: query
          description: >-
            If supplied, the returned StoreItem will have information about
            onHand.
          schema:
            type: string
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreItem'
            application/xml:
              schema:
                $ref: '#/components/schemas/StoreItem'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/GetStoreItemByUniqueName:
    get:
      tags:
        - Stores
      summary: Get store item by unique name
      description: >-
        Gets a StoreItem by its unique url name. Should be used to display
        details about a StoreItem or when just data for a single StoreItem is
        needed. Returns null if the StoreItem does not exist.
      operationId: GetStoreItemByUniqueName
      parameters:
        - name: uniqueName
          in: query
          description: The unique name of the Store to fetch.
          required: true
          schema:
            type: string
        - name: partNo
          in: query
          description: >-
            If supplied, the returned StoreItem will have information about
            onHand.
          schema:
            type: string
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreItem'
            application/xml:
              schema:
                $ref: '#/components/schemas/StoreItem'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/ListStoreInfo:
    get:
      tags:
        - Stores
      summary: List store info
      description: Lists StoreInfo as a PagedList. This will list info for all Stores.
      operationId: ListStoreInfo
      parameters:
        - name: pageNo
          in: query
          description: >-
            Page numbers start with 1. Default is 1. If you specify a pageNo
            outside the range of items, an empty list will be returned. PageSize
            is mandatory for pageNo to work.
          schema:
            type: string
        - name: pageSize
          in: query
          description: Number of items to display per page. Mandatory if using pageNo.
          schema:
            type: string
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreInfoPagedList'
            application/xml:
              schema:
                $ref: '#/components/schemas/StoreInfoPagedList'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/ListStoreInfoTypes:
    get:
      tags:
        - Stores
      summary: List store info types
      description: Lists the info types that can be set on the Store.Info property.
      operationId: ListStoreInfoTypes
      parameters:
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IdValue'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IdValue'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/ListStoreItems:
    get:
      tags:
        - Stores
      summary: List store items
      description: Lists StoreItems as a PagedList.
      operationId: ListStoreItems
      parameters:
        - name: partNo
          in: query
          description: >-
            If supplied, the returned StoreItem will have information about
            onHand.
          schema:
            type: string
        - name: longitude
          in: query
          description: >-
            Longitude for current position. StoreItems will calculate the
            Distance if supplied together with latitude. Format: decimal.
          schema:
            type: string
        - name: latitude
          in: query
          description: >-
            Latitude for current position. StoreItems will calculate the
            Distance if supplied together with longitude. Format: decimal.
          schema:
            type: string
        - name: pageNo
          in: query
          description: >-
            Page numbers start with 1. Default is 1. If you specify a pageNo
            outside the range of items, an empty list will be returned. PageSize
            is mandatory for pageNo to work.
          schema:
            type: string
        - name: pageSize
          in: query
          description: Number of items to display per page. Mandatory if using pageNo.
          schema:
            type: string
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreItemPagedList'
            application/xml:
              schema:
                $ref: '#/components/schemas/StoreItemPagedList'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/ListStores:
    get:
      tags:
        - Stores
      summary: List stores [Obsolete("Use ListStoreItems.")]
      description: Lists Stores as a PagedList.
      operationId: ListStores
      parameters:
        - name: partNo
          in: query
          description: >-
            If supplied, the returned StoreItem will have information about
            onHand.
          schema:
            type: string
        - name: longitude
          in: query
          description: >-
            Longitude for current position. StoreItems will calculate the
            Distance if supplied together with latitude. Format: decimal.
          schema:
            type: string
        - name: latitude
          in: query
          description: >-
            Latitude for current position. StoreItems will calculate the
            Distance if supplied together with longitude. Format: decimal.
          schema:
            type: string
        - name: pageNo
          in: query
          description: >-
            Page numbers start with 1. Default is 1. If you specify a pageNo
            outside the range of items, an empty list will be returned. PageSize
            is mandatory for pageNo to work.
          schema:
            type: string
        - name: pageSize
          in: query
          description: Number of items to display per page. Mandatory if using pageNo.
          schema:
            type: string
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreItemPagedList'
            application/xml:
              schema:
                $ref: '#/components/schemas/StoreItemPagedList'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/ListStores2:
    get:
      tags:
        - Stores
      summary: List stores (v2)
      description: >-
        Lists all stores. Any distance calculations should be made by the client
        application for caching reasons or the Distance field will be null.
      operationId: ListStores2
      parameters:
        - name: cultureCode
          in: query
          description: >-
            Specifies in which language to display culture specific information.
            If none is supplied, value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Store'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Store'
        '500':
          description: Internal Server Error
          content: {}
  /ApplicationService.svc/rest/UpdateDivisionInfo:
    post:
      tags:
        - Stores
      summary: Update division information
      description: Updates the given info for a division.
      operationId: UpdateDivisionInfo
      parameters:
        - name: id
          in: query
          description: The internal id of the division.
          required: true
          schema:
            type: integer
            format: int32
        - name: typeId
          in: query
          description: The id of the info type. For reference, use ListInfoTypes.
          required: true
          schema:
            type: integer
            format: int32
        - name: value
          in: query
          description: The value to set.
          required: true
          schema:
            type: string
        - name: updatedBy
          in: query
          description: >-
            The accountId of the user making the update. If none is supplied,
            value is resolved from Application.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content: {}
        '500':
          description: Internal Server Error
          content: {}
components:
  schemas:
    Application:
      type: object
      properties:
        Id:
          type: integer
          description: The system wide unique internal Storm Id for this Application.
          format: int32
          nullable: true
        ParentId:
          type: integer
          description: >-
            Id of the parent application, if any. Will be the same as Id if none
            exists. Applications with the same parentId share products and
            customers. Some content and navigation can differ.
          format: int32
          nullable: true
        Key:
          type: string
          description: The system wide unique Key for this Application.
          format: guid
        Name:
          type: string
          description: 'The Name of this Application. MaxLength: 50.'
        Url:
          type: string
          description: 'The Url to the Application. MaxLength: 255.'
        SenderEmailAddress:
          type: string
          description: >-
            The sender e-mail address for all external communication and
            notifications if Norce Storm email services are used. MaxLength:
            255.
        Client:
          $ref: '#/components/schemas/Client'
        Cultures:
          $ref: '#/components/schemas/Cultures'
        Currencies:
          $ref: '#/components/schemas/Currencies'
        Pricelists:
          $ref: '#/components/schemas/Pricelists'
        SalesAreas:
          $ref: '#/components/schemas/SalesAreas'
        Roles:
          $ref: '#/components/schemas/Roles'
        Countries:
          $ref: '#/components/schemas/Countries'
        Authorizations:
          type: array
          description: >-
            A list of authorizations available for this application. Can be used
            when creating customer accounts.
          items:
            $ref: '#/components/schemas/IdValue'
      format: Application
    Client:
      type: object
      properties:
        Id:
          type: integer
          description: The system wide unique internal Storm Id for the Client.
          format: int32
        Key:
          type: string
          description: The system wide unique Key for the Client.
          format: guid
        Name:
          type: string
          description: 'The Name of the Client. MaxLength: 100.'
      format: Client
    Countries:
      type: object
      properties:
        List:
          type: array
          description: A list of countries.
          items:
            $ref: '#/components/schemas/Country'
        Default:
          $ref: '#/components/schemas/Country'
      format: Countries
    Country:
      type: object
      properties:
        Id:
          type: integer
          description: The internal Storm Id of the country.
          format: int32
        Name:
          type: string
          description: 'The name of the country. MaxLength: 50.'
        Code:
          type: string
          description: >-
            The Code of the country. The ISO 3166-1 alpha-2 is used. SE for
            Sweden. MaxLength: 3.
      format: Country
    Culture:
      type: object
      properties:
        Code:
          type: string
          description: >-
            The Code of the culture. Two letter or five letter codes. sv-SE for
            swedish. MaxLength: 16.
        Name:
          type: string
          description: 'The name of the culture. MaxLength: 50.'
      format: Culture
    Cultures:
      type: object
      properties:
        List:
          type: array
          description: A list of cultures.
          items:
            $ref: '#/components/schemas/Culture'
        Default:
          $ref: '#/components/schemas/Culture'
      format: Cultures
    Currencies:
      type: object
      properties:
        List:
          type: array
          description: A list of currencies.
          items:
            $ref: '#/components/schemas/Currency'
        Default:
          $ref: '#/components/schemas/Currency'
      format: Currencies
    Currency:
      type: object
      properties:
        Id:
          type: integer
          description: The internal Storm Id of the currency.
          format: int32
        Name:
          type: string
          description: 'The name of the currency. MaxLength: 50.'
        Code:
          type: string
          description: >-
            The Code of the currency. ISO 4217 is used. SEK for Swedish kronor.
            MaxLength: 3.
        Prefix:
          type: string
          description: 'The Prefix sign/code if available. MaxLength: 10.'
        Suffix:
          type: string
          description: 'The suffix sign/code if available. MaxLength: 10.'
      format: Currency
    Location:
      type: object
      properties:
        StoreId:
          type: integer
          description: This is the internal Storm ID.
          format: int32
          nullable: true
        StoreCode:
          type: string
          description: >-
            This is a code used to map Store from an external system. MaxLength:
            50.
        WarehouseId:
          type: integer
          description: This is the internal Storm ID.
          format: int32
          nullable: true
        LocationIdId:
          type: integer
          description: This is the internal Storm ID.
          format: int32
          nullable: true
      format: Location
    LocationInfo:
      type: object
      properties:
        CountryCode:
          type: string
          description: 'This is country code for the location. MaxLength: 3.'
        ZipCode:
          type: string
          description: 'This is zip code for the location. MaxLength: 50.'
        Delivery:
          $ref: '#/components/schemas/Location'
        Pickup:
          $ref: '#/components/schemas/Location'
        Payment:
          $ref: '#/components/schemas/Location'
      format: LocationInfo
    Pricelists:
      type: object
      properties:
        Ids:
          type: array
          description: A list of priceList ids.
          items:
            type: integer
            format: int32
        Default:
          type: integer
          description: The default priceList id from the list.
          format: int32
      format: Pricelists
    Role:
      type: object
      properties:
        Id:
          type: integer
          description: The internal Id of the role.
          format: int32
        Name:
          type: string
          description: 'The Name of the role. MaxLength: 50.'
        Description:
          type: string
          description: 'The Description of the role. MaxLength: 500.'
      format: Role
    Roles:
      type: object
      properties:
        List:
          type: array
          description: A list of roles.
          items:
            $ref: '#/components/schemas/Role'
        Default:
          $ref: '#/components/schemas/Role'
      format: Roles
    SalesArea:
      type: object
      properties:
        Id:
          type: integer
          description: The internal Id of the SalesArea.
          format: int32
        Name:
          type: string
          description: 'The Name of the SalesArea. MaxLength: 50.'
        CurrencyId:
          type: integer
          description: The default id of the Currency for this SalesArea.
          format: int32
        VatCodeId:
          type: integer
          description: The default id of the VatCode for this SalesArea.
          format: int32
      format: SalesArea
    SalesAreas:
      type: object
      properties:
        List:
          type: array
          description: A list of SalesAreas.
          items:
            $ref: '#/components/schemas/SalesArea'
        Default:
          $ref: '#/components/schemas/SalesArea'
      format: SalesAreas
    Store:
      type: object
      properties:
        Id:
          type: integer
          description: The internal Id of the Store.
          format: int32
        Name:
          type: string
          description: 'The Name of the Store. MaxLength: 50.'
        Address:
          type: string
          description: 'The Address of the Store. MaxLength: 100.'
        PostalAddress:
          type: string
          description: 'The PostalAddress of the Store. Zip and City. MaxLength: 100.'
        Phone:
          type: string
          description: 'The PhoneNumber to the Store. MaxLength: 50.'
        Fax:
          type: string
          description: 'The FaxNumber to the Store. MaxLength: 50.'
        OpeningWeekdays:
          type: string
          description: >-
            Defines the opening hours for the Store during week days. MaxLength:
            255.
        OpeningSaturdays:
          type: string
          description: >-
            Defines the opening hours for the Store during on Saturdays.
            MaxLength: 255.
        OpeningSundays:
          type: string
          description: >-
            Defines the opening hours for the Store during on Sundays.
            MaxLength: 255.
        Longitude:
          type: number
          description: >-
            The longitude part of the location of the Store. Can be used to
            calculate distances to the Store.
          format: double
          nullable: true
        Latitude:
          type: number
          description: >-
            The latitude part of the location of the Store. Can be used to
            calculate distances to the Store.
          format: double
          nullable: true
        Distance:
          type: number
          description: >-
            Used when fetching Stores and we have a specified current location
            from which to calculate a distance to the Store.
          format: decimal
          nullable: true
        Key:
          type: string
          description: The system wide unique Key for the Store.
          format: guid
        Type:
          type: string
          description: >-
            The Type of the Store. Taken from Storm's Division.GroupName.
            MaxLength: 50.
        SubType:
          type: string
          description: >-
            The SubType of the Store. Taken from Storm's Division.SubGroupName.
            MaxLength: 50.
        Info:
          type: array
          description: >-
            Contains a list of id-value pairs specific to the client for this
            Store. Use ApplicationService.ListStoreInfoTypes(string) for id
            lookup.
          items:
            $ref: '#/components/schemas/IdValue'
        Pricelists:
          $ref: '#/components/schemas/Pricelists'
        Code:
          type: string
          description: 'The external code. Usually the id in the erp system. MaxLength: 50.'
        Description:
          type: string
          description: 'The Description of the Store. MaxLength: max.'
        ImageKey:
          type: string
          description: >-
            A unique id for the image at our image server. Url for images are
            formed like http://[client specific CDN]/{ImageKey}. Preset, height
            and width can be sent as parameters.
          format: guid
          nullable: true
        UniqueName:
          type: string
          description: >-
            A unique name that can be used in Urls and to get this entity.
            GetStore and GetStoreByUniqueName gets the same Store. MaxLength:
            100.
      format: Store
    StoreInfo:
      type: object
      properties:
        Id:
          type: integer
          description: The internal id of the Store.
          format: int32
        Info:
          type: array
          description: >-
            Contains a list of id-value pairs specific to the client for this
            store. Use ApplicationService.ListStoreInfoTypes(string) for id
            lookup.
          items:
            $ref: '#/components/schemas/IdValue'
      format: StoreInfo
    StoreInfoPagedList:
      type: object
      properties:
        ItemCount:
          type: integer
          description: >-
            The total item count. Can be used to manage paging. This will always
            be the total number of available items, regardless of paging. Use
            PageSize to calculate number of pages.
          format: int32
        Items:
          type: array
          description: >-
            Items contains the current list of StoreInfo for the current page if
            paging is used. Otherwise all items will be in the list.
          items:
            $ref: '#/components/schemas/StoreInfo'
      format: StoreInfoPagedList
    StoreItem:
      type: object
      properties:
        Id:
          type: integer
          description: The internal Id of the Store.
          format: int32
        Name:
          type: string
          description: 'The Name of the Store. MaxLength: 50.'
        Address:
          type: string
          description: 'The Address of the Store. MaxLength: 100.'
        PostalAddress:
          type: string
          description: 'The PostalAddress of the Store. Zip and City. MaxLength: 100.'
        OnHandValue:
          type: number
          description: Obsolete! - Use OnHand
          format: decimal
          nullable: true
        IncomingValue:
          type: number
          description: Obsolete! - Use OnHand
          format: decimal
          nullable: true
        NextDeliveryDate:
          type: string
          description: Obsolete! - Use OnHand
          format: date-time
          nullable: true
        Distance:
          type: number
          description: >-
            Used when fetching Stores and we have a specified current location
            from which to calculate a distance to the Store.
          format: decimal
          nullable: true
        Type:
          type: string
          description: >-
            The Type of the Store. Taken from Storm's Division.GroupName.
            MaxLength: 50.
        SubType:
          type: string
          description: >-
            The SubType of the Store. Taken from Storm's Division.SubGroupName.
            MaxLength: 50.
        Code:
          type: string
          description: 'The external code. Usually the id in the erp system. MaxLength: 50.'
        OnHand:
          $ref: '#/components/schemas/ProductsOnHand'
        OnHandDemo:
          $ref: '#/components/schemas/ProductsOnHand'
        UniqueName:
          type: string
          description: >-
            A unique name that can be used in Urls and to get this entity.
            GetStoreItem and GetStoreItemByUniqueName gets the same StoreItem.
            MaxLength: 100.
      format: StoreItem
    StoreItemPagedList:
      type: object
      properties:
        ItemCount:
          type: integer
          description: >-
            The total item count. Can be used to manage paging. This will always
            be the total number of available items, regardless of paging. Use
            PageSize to calculate number of pages.
          format: int32
        Items:
          type: array
          description: >-
            Items contains the current list of StoreItems for the current page
            if paging is used. Otherwise all items will be in the list.
          items:
            $ref: '#/components/schemas/StoreItem'
      format: StoreItemPagedList
    IdNameDescription:
      type: object
      properties:
        Id:
          type: integer
          description: The internal Id of the Entity.
          format: int32
        Name:
          type: string
          description: 'The Name of the Entity. MaxLength: 50.'
        Description:
          type: string
          description: 'The Description of the Entity. MaxLength: 500.'
        ImageKey:
          type: string
          description: >-
            A unique id for the image at our image server. Url for images are
            formed like http://[client specific CDN]/{ImageKey}. Preset, height
            and width can be sent as parameters.
          format: guid
          nullable: true
        Code:
          type: string
          description: 'The Code of the Entity. MaxLength: 50.'
      format: IdNameDescription
    IdValue:
      type: object
      properties:
        Id:
          type: integer
          description: >-
            The internal Id of the Entity. This Id might be different in
            different tiers such as Stage and Production. Use Code if hard
            coding is required.
          format: int32
        Value:
          type: string
          description: 'The Value of the Entity. MaxLength: max.'
        Code:
          type: string
          description: >-
            The Code of the Entity, if existing. Use this value when hard coding
            is required. MaxLength: 255.
      format: IdValue
    ProductsOnHand:
      type: object
      properties:
        Value:
          type: number
          description: >-
            The aggregated value from all warehouses and locations in the
            current context (Web, Supplier or Store).
          format: decimal
        IncomingValue:
          type: number
          description: The incoming quantity on the next delivery.
          format: decimal
        NextDeliveryDate:
          type: string
          description: The next delivery data from supplier to client warehouse.
          format: date-time
          nullable: true
        LeadtimeDayCount:
          type: integer
          description: The number of days it takes to ship from the supplier.
          format: int32
          nullable: true
        LastChecked:
          type: string
          description: When onHand info was last checked. Null if never.
          format: date-time
          nullable: true
        IsActive:
          type: boolean
          description: Indicate if the product is stocked in a store.
        IsReturnable:
          type: boolean
          description: Indicate if the product is returnable in a store.
        Info:
          type: array
          description: >-
            List of IdValues for the OnHand data for this sku warehouse location
            combination. This will always be null unless fetched with any of the
            ProductOnHand methods.
          items:
            $ref: '#/components/schemas/IdValue'
      format: ProductsOnHand
x-original-swagger-version: '2.0'
