> ## Documentation Index
> Fetch the complete documentation index at: https://docsv4.mile.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Publish order type

> Checks the stored draft and publishes it as the next version. Requires permission `edit/orderType`.
New orders use the latest published version; orders already running keep the version they started with.
Refused with 400 and a `checks` list when the draft has errors, and with 409 when the `draftRevision` is stale or the draft is the same as the published version.



## OpenAPI

````yaml /openapi/public/openapi-flow.json patch /order-type/{id}/publish
openapi: 3.0.0
info:
  title: API - Flow
  version: 3.0.0
  description: API Documentation - RESTful API for field operations management.
servers:
  - url: https://apiweb.mile.app/api/v3
security:
  - bearerAuth: []
tags:
  - name: Flow
    description: >-
      Flow is the mobile field application workflow, setting it correctly is
      critical to the success of the field workers in doing their job
      efficiently. Flow attributes consist of IDs, pages, components,
      configurations, and time. The Flow will be used at Task, Automation, or
      Schedule.


      **To see the details of flow object, please follow [this
      link](#tag/flow_model)**
  - name: Automation
    description: >-
      Automation enables you to set up automation based on tasks' events and
      data source's events. It might help you automate creation of tasks, task
      assignment, task placement, task webhook, data source update, datasource
      creation, and data source webhook. Automation attributes consist of IDs,
      automation name, automation type, automation details, and rules.


      **To see the details of automation object, please follow [this
      link](#tag/automation_model)**
  - name: Order Type
    description: >-
      An order type is the blueprint for orders: the list of steps, which task
      type each step uses, and how an order moves from one step to the next.
      Order types are versioned: you edit a draft, validate or simulate it, then
      publish it. These endpoints are served under `/api/v4`.
paths:
  /order-type/{id}/publish:
    servers:
      - url: https://apiweb.mile.app/api/v4
    patch:
      tags:
        - Order Type
      summary: Publish order type
      description: >-
        Checks the stored draft and publishes it as the next version. Requires
        permission `edit/orderType`.

        New orders use the latest published version; orders already running keep
        the version they started with.

        Refused with 400 and a `checks` list when the draft has errors, and with
        409 when the `draftRevision` is stale or the draft is the same as the
        published version.
      operationId: publishOrderType
      parameters:
        - name: id
          in: path
          required: true
          description: |-
            Unique identifier for the order type that generated by system.
            **Example**: `6710a2f4c1d2e3f4a5b6c7d8`
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderTypePublishRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Status of response.
                  message:
                    description: Message of API response.
                    type: string
                  data:
                    description: Response data.
                    type: object
                    additionalProperties: true
                example:
                  status: true
                  message: Order Type published
                  data:
                    _id: 6710a2f4c1d2e3f4a5b6c7d8
                    publishedVersion: 3
                    state: published
                    hasUnpublishedChanges: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                example:
                  status: false
                  message: Bad request - invalid parameters provided.
        '404':
          description: Data not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                example:
                  status: false
                  message: Data not found
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                example:
                  status: false
                  message: Bad request - invalid parameters provided.
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                example:
                  status: false
                  message: Internal server error, please contact support@mile.app.
      deprecated: false
      security:
        - bearerAuth: []
components:
  schemas:
    OrderTypePublishRequest:
      example:
        draftRevision: 5
        note: Add weight field
      type: object
      properties:
        draftRevision:
          type: integer
          description: |-
            The `draftRevision` you last read.
            **Example**: `5`
        note:
          type: string
          description: Optional note stored with the version. Max 200 characters.
      required:
        - draftRevision
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use a valid Bearer token to authenticate.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.