openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Ship Rules API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Ship Rules
paths:
  /api/v1/admin/ShipRules:
    get:
      tags:
      - Ship Rules
      summary: Returns the EntitySet ShipRules
      operationId: ShipRules_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:
      - Ship Rules
      summary: Post a new entity to EntitySet ShipRules
      operationId: ShipRules_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.ShipRule'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ShipRules({id}):
    get:
      tags:
      - Ship Rules
      summary: Returns the entity with the key from ShipRules
      operationId: ShipRules_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:
      - Ship Rules
      summary: Replace entity in EntitySet ShipRules
      operationId: ShipRules_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.ShipRule'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Ship Rules
      summary: Delete entity in EntitySet ShipRules
      operationId: ShipRules_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:
      - Ship Rules
      summary: Update entity in EntitySet ShipRules
      operationId: ShipRules_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.ShipRule'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ShipRules/Default.Default():
    get:
      tags:
      - Ship Rules
      summary: Call operation  Default
      operationId: ShipRules_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/shiprules/delete:
    delete:
      tags:
      - Ship Rules
      operationId: ShipRules_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: []
  /api/v1/admin/shiprules({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Ship Rules
      operationId: ShipRules_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: []
components:
  schemas:
    Insite.Data.Entities.ShipRule:
      required:
      - shipRuleType
      - condition
      - termsCode
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        carrierId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        shipViaId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        shipRateId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        postalCode:
          maxLength: 50
          minLength: 0
          type: string
        stateId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        countryId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        minimumAmount:
          format: double
          type: number
        maximumAmount:
          format: double
          type: number
        postalCodeLowerRange:
          maxLength: 50
          minLength: 0
          type: string
        postalCodeUpperRange:
          maxLength: 50
          minLength: 0
          type: string
        customerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        shipRuleType:
          maxLength: 255
          minLength: 0
          type: string
        executionGroup:
          format: int32
          type: integer
        executionOrder:
          format: int32
          type: integer
        condition:
          maxLength: 50
          minLength: 0
          type: string
        categoryId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        productId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        dayOfWeek:
          format: int32
          type: integer
        termsCode:
          maxLength: 150
          minLength: 0
          type: string
        customerType:
          maxLength: 50
          minLength: 0
          type: string
        customRuleName:
          maxLength: 255
          minLength: 0
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query