openapi: 3.2.0
info:
  title: Optimizely Dealers API
  version: '1.0'
  description: 'Operations tagged Dealers across 2 of this provider''s published API definitions: optimizely-configured-commerce-admin-api-v1-openapi.json, optimizely-configured-commerce-storefront-api-v1-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Dealers
paths:
  /api/v1/admin/Dealers:
    get:
      tags:
      - Dealers
      summary: Returns the EntitySet Dealers
      operationId: Dealers_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Dealers
      summary: Post a new entity to EntitySet Dealers
      operationId: Dealers_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Dealer'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    servers:
    - url: https://dogfood.commerce.insitesandbox.com
  /api/v1/admin/Dealers({id}):
    get:
      tags:
      - Dealers
      summary: Returns the entity with the key from Dealers
      operationId: Dealers_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Dealers
      summary: Replace entity in EntitySet Dealers
      operationId: Dealers_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Dealer'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Dealers
      summary: Delete entity in EntitySet Dealers
      operationId: Dealers_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Dealers
      summary: Update entity in EntitySet Dealers
      operationId: Dealers_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Dealer'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    servers:
    - url: https://dogfood.commerce.insitesandbox.com
  /api/v1/admin/Dealers/Default.Default():
    get:
      tags:
      - Dealers
      summary: Call operation  Default
      operationId: Dealers_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    servers:
    - url: https://dogfood.commerce.insitesandbox.com
  /api/v1/admin/dealers/delete:
    delete:
      tags:
      - Dealers
      operationId: Dealers_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    servers:
    - url: https://dogfood.commerce.insitesandbox.com
  /api/v1/admin/dealers({key})/categories({categoryKey}):
    get:
      tags:
      - Dealers
      operationId: Dealers_GetCategoryByKeyAndCategorykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: categoryKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    servers:
    - url: https://dogfood.commerce.insitesandbox.com
  /api/v1/admin/dealers({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Dealers
      operationId: Dealers_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    servers:
    - url: https://dogfood.commerce.insitesandbox.com
  /api/v1/admin/dealers({key})/products({productKey}):
    get:
      tags:
      - Dealers
      operationId: Dealers_GetProductByKeyAndProductkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: productKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    servers:
    - url: https://dogfood.commerce.insitesandbox.com
  /api/v1/admin/dealers({key})/websites({websiteKey}):
    get:
      tags:
      - Dealers
      operationId: Dealers_GetWebsiteByKeyAndWebsitekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: websiteKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    servers:
    - url: https://dogfood.commerce.insitesandbox.com
  /api/v1/dealers:
    get:
      tags:
      - Dealers
      operationId: DealersV1_GetCollectionAsync
      parameters:
      - name: parameter.useDefaultLocation
        in: query
        required: false
        schema:
          type: boolean
      - name: parameter.latitude
        in: query
        required: false
        schema:
          type: number
          format: double
      - name: parameter.longitude
        in: query
        required: false
        schema:
          type: number
          format: double
      - name: parameter.radius
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: parameter.name
        in: query
        required: false
        schema:
          type: string
      - name: parameter.startPage
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: parameter.page
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: parameter.pageSize
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: parameter.sort
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerCollectionModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerCollectionModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerCollectionModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerCollectionModel'
            text/html:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerCollectionModel'
    servers:
    - url: https://dogfood.commerce.insitesandbox.com
  /api/v1/dealers/{dealerId}:
    get:
      tags:
      - Dealers
      operationId: DealersV1_GetAsync
      parameters:
      - name: dealerId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerModel'
            text/html:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerModel'
    servers:
    - url: https://dogfood.commerce.insitesandbox.com
  /api/v1/dealers/getByPath:
    get:
      tags:
      - Dealers
      operationId: DealersV1_GetByPathAsync
      parameters:
      - name: path
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerModel'
            text/html:
              schema:
                $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerModel'
    servers:
    - url: https://dogfood.commerce.insitesandbox.com
components:
  schemas:
    Insite.Data.Entities.Dealer:
      required:
      - name
      - address1
      - address2
      - city
      - state
      - postalCode
      - phone
      - fax
      - manager
      - websiteUrl
      - urlSegment
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 100
          minLength: 0
          type: string
        address1:
          maxLength: 100
          minLength: 0
          type: string
        address2:
          maxLength: 100
          minLength: 0
          type: string
        city:
          maxLength: 100
          minLength: 0
          type: string
        state:
          maxLength: 50
          minLength: 0
          type: string
        postalCode:
          maxLength: 50
          minLength: 0
          type: string
        phone:
          maxLength: 50
          minLength: 0
          type: string
        fax:
          maxLength: 50
          minLength: 0
          type: string
        manager:
          maxLength: 100
          minLength: 0
          type: string
        countryId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        websiteId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        latitude:
          format: decimal
          type: number
        longitude:
          format: decimal
          type: number
        websiteUrl:
          maxLength: 1024
          minLength: 0
          type: string
        contentManagerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        urlSegment:
          maxLength: 255
          minLength: 0
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
    Insite.Dealers.WebApi.V1.ApiModels.DealerModel:
      type: object
      properties:
        uri:
          type: string
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          type: string
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        countryId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        phone:
          type: string
        fax:
          type: string
        manager:
          type: string
        latitude:
          format: decimal
          type: number
        longitude:
          format: decimal
          type: number
        webSiteUrl:
          type: string
        htmlContent:
          type: string
        distance:
          format: double
          type: number
        detailPagePath:
          type: string
        alternateLanguageUrls:
          type: object
          additionalProperties:
            type: string
        distanceUnitOfMeasure:
          type: string
        properties:
          type: object
          additionalProperties:
            type: string
    Insite.Core.WebApi.SortOptionModel:
      type: object
      properties:
        displayName:
          type: string
        sortType:
          type: string
    Insite.Core.WebApi.PaginationModel:
      type: object
      properties:
        currentPage:
          format: int32
          type: integer
        page:
          format: int32
          type: integer
        pageSize:
          format: int32
          type: integer
        defaultPageSize:
          format: int32
          type: integer
        totalItemCount:
          format: int32
          type: integer
        numberOfPages:
          format: int32
          type: integer
        pageSizeOptions:
          type: array
          items:
            format: int32
            type: integer
        sortOptions:
          type: array
          items:
            $ref: '#/components/schemas/Insite.Core.WebApi.SortOptionModel'
        sortType:
          type: string
        nextPageUri:
          type: string
        prevPageUri:
          type: string
        nextPageToken:
          type: string
    Insite.Dealers.WebApi.V1.ApiModels.DealerCollectionModel:
      type: object
      properties:
        uri:
          type: string
        dealers:
          type: array
          items:
            $ref: '#/components/schemas/Insite.Dealers.WebApi.V1.ApiModels.DealerModel'
        distanceUnitOfMeasure:
          type: string
        pagination:
          $ref: '#/components/schemas/Insite.Core.WebApi.PaginationModel'
        defaultLatitude:
          format: double
          type: number
        defaultLongitude:
          format: double
          type: number
        formattedAddress:
          type: string
        defaultRadius:
          format: int32
          type: integer
        startDealerNumber:
          format: int32
          type: integer
        properties:
          type: object
          additionalProperties:
            type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query
x-refined-from:
- optimizely-configured-commerce-admin-api-v1-openapi.json
- optimizely-configured-commerce-storefront-api-v1-openapi.json