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

# Get Order State

> If there is a problem with a quoteline, the error description shall be placed in the status and reason fields of the quoteline, if there is a problem with the alternative, the error description shall be placed in the status and reason fields of the alternative.

A summary of all the problems (if any) should be placed in the response object. Requires that the Create-Order capability is true.
NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-QuoteAgent.json post /api/v1/Agents/Quote/GetOrderState
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - QuoteAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/Quote/GetOrderState:
    post:
      tags:
        - Quote_Agent
      summary: Get Order State
      description: "If there is a problem with a quoteline, the error description shall be placed in the status and reason fields of the quoteline, if there is a problem with the alternative, the error description shall be placed in the status and reason fields of the alternative.\n\nA summary of all the problems (if any) should be placed in the response object. Requires that the Create-Order capability is true.\r\nNsApiSlow threshold: 5000 ms."
      operationId: v1QuoteAgent_GetOrderState
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetOrderStateRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetOrderStateRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetOrderStateRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetOrderStateRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetOrderStateRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetOrderStateRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetOrderStateRequest
        description: QuoteVersionId
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.PluginUrlResponse
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.PluginUrlResponse
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.PluginUrlResponse
            text/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.PluginUrlResponse
            application/json-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.PluginUrlResponse
            application/merge-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.PluginUrlResponse
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetOrderStateRequest:
      description: >-
        GetOrderState: If there is a problem with a quoteline, the error
        description shall be placed in the status and reason fields of the
        quoteline, if there is a problem with the alternative, the error
        description shall be placed in the status and reason fields of the
        alternative. A summary of all the problems (if any) should be placed in
        the response object. Requires that the Create-Order capability is true.
      type: object
      properties:
        QuoteVersionId:
          format: int32
          type: integer
    SuperOffice.CRM.Services.PluginUrlResponse:
      description: "PluginUrlResponse exists to be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled “Place Order” button. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or http(s)\r\n<para />\r\nCarrier object for PluginUrlResponse.\r\nServices for the PluginUrlResponse Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IQuoteAgent\">Quote Agent</see>."
      type: object
      properties:
        IsOk:
          description: >-
            Answer to the question / An indication if the operation went well. 
            Equivalent to Status != Error
          type: boolean
        UserExplanation:
          description: A localized explanation to the answer.
          type: string
        TechExplanation:
          description: Always in English
          type: string
        ErrorCode:
          description: An error code, if available.
          type: string
        Changes:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.ChangedData'
        Url:
          description: >-
            Url that the GUI should navigato to/open, if non-blank. The GUI
            cannot enforce any rules subsequent to opening the requested url.
          type: string
        Status:
          description: >-
            QuoteStatus = Ok / OkWithInfo / Warn / Error. Error implies IsOk =
            false.
          enum:
            - Ok
            - OkWithInfo
            - Warning
            - Error
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.ChangedData:
      description: "Generic carrier, used in return values to indicate what data NetServer has changed 'behind the scenes' so clients can know what to update\r\n<para />\r\nCarrier object for ChangedData.\r\nServices for the ChangedData Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IQuoteAgent\">Quote Agent</see>."
      type: object
      properties:
        AddedRecords:
          description: Ids of added records.
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.ChangedDataItem'
        UpdatedRecords:
          description: Ids of updated records.
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.ChangedDataItem'
        DeletedRecords:
          description: Ids of deleted records.
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.ChangedDataItem'
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Services.ChangedDataItem:
      description: "Tablename/recordid pair used to refer to records\r\n<para />\r\nCarrier object for ChangedDataItem.\r\nServices for the ChangedDataItem Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IQuoteAgent\">Quote Agent</see>."
      type: object
      properties:
        Tablename:
          description: Name of table, standardized to lowercase
          type: string
        RecordId:
          format: int32
          description: Id of record, should never be 0
          type: integer
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [Placing orders into ERP](/en/api/plugins/quote-connectors/place-order.md)
- [SuperOffice.WebApi.Data.Quote GetOrderStateRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Quote_GetOrderStateRequest.md)
- [OrderResponseInfo](/en/api/plugins/quote-connectors/api/data-carriers/orderresponseinfo.md)
- [IQuoteConnector](/en/api/plugins/quote-connectors/api/iquoteconnector.md)
- [Get Quote Version Workflow Image State](/en/api/reference/restful/agent/quote_agent/get-quote-version-workflow-image-state.md)
- [Get Quote Version Workflow State](/en/api/reference/restful/agent/quote_agent/get-quote-version-workflow-state.md)
