Returns comments for a specified negotiable quote

GET /V1/negotiableQuote/{quoteId}/comments

Returns comments for a specified negotiable quote.

Path parameters

  • quoteId integer Required

    Negotiable Quote ID.

Responses

  • 200 Success.

    Hide response attributes Show response attributes object
    • entity_id integer Required

      Comment ID.

    • parent_id integer Required

      Negotiable quote ID, that this comment belongs to.

    • creator_type integer Required

      The comment creator type.

    • is_decline integer Required

      Is quote was declined by seller.

    • is_draft integer Required

      Is quote draft flag.

    • creator_id integer Required

      Comment creator ID.

    • comment string Required

      Comment.

    • created_at string Required

      Comment created at.

    • extension_attributes object

      ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CommentInterface

    • attachments array[object] Required

      Existing attachments.

      Hide attachments attributes Show attachments attributes object

      Interface for quote comment attachment.

      • attachment_id integer Required

        Attachment ID.

      • comment_id integer Required

        Comment ID.

      • file_name string Required

        File name.

      • file_path string Required

        File path.

      • file_type string Required

        File type.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CommentAttachmentInterface

    Hide response attributes Show response attributes object
    • entity_id integer Required

      Comment ID.

    • parent_id integer Required

      Negotiable quote ID, that this comment belongs to.

    • creator_type integer Required

      The comment creator type.

    • is_decline integer Required

      Is quote was declined by seller.

    • is_draft integer Required

      Is quote draft flag.

    • creator_id integer Required

      Comment creator ID.

    • comment string Required

      Comment.

    • created_at string Required

      Comment created at.

    • extension_attributes object

      ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CommentInterface

    • attachments array[object] Required

      Existing attachments.

      Hide attachments attributes Show attachments attributes object

      Interface for quote comment attachment.

      • attachment_id integer Required

        Attachment ID.

      • comment_id integer Required

        Comment ID.

      • file_name string Required

        File name.

      • file_path string Required

        File path.

      • file_type string Required

        File type.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CommentAttachmentInterface

  • 401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • 400 Bad Request

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

GET /V1/negotiableQuote/{quoteId}/comments
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/negotiableQuote/{quoteId}/comments'
Response examples (200)
[
  {
    "entity_id": 42,
    "parent_id": 42,
    "creator_type": 42,
    "is_decline": 42,
    "is_draft": 42,
    "creator_id": 42,
    "comment": "string",
    "created_at": "string",
    "extension_attributes": {},
    "attachments": [
      {
        "attachment_id": 42,
        "comment_id": 42,
        "file_name": "string",
        "file_path": "string",
        "file_type": "string",
        "extension_attributes": {}
      }
    ]
  }
]
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root type="array">
  <root>
    <entity-id type="integer">42</entity-id>
    <parent-id type="integer">42</parent-id>
    <creator-type type="integer">42</creator-type>
    <is-decline type="integer">42</is-decline>
    <is-draft type="integer">42</is-draft>
    <creator-id type="integer">42</creator-id>
    <comment>string</comment>
    <created-at>string</created-at>
    <extension-attributes>
    </extension-attributes>
    <attachments type="array">
      <attachment>
        <attachment-id type="integer">42</attachment-id>
        <comment-id type="integer">42</comment-id>
        <file-name>string</file-name>
        <file-path>string</file-path>
        <file-type>string</file-type>
        <extension-attributes>
        </extension-attributes>
      </attachment>
    </attachments>
  </root>
</root>
Response examples (401)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (401)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
Response examples (400)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (400)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
Response examples (default)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>