Comments

sales Order Management V1Get Comments List Get

Lists comments for a specified order.

get

/V1/orders/{id}/comments

Path parameters

idstringrequired

(Required) The order ID.

Example: <integer>

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{baseurl}}/V1/orders/{id}/comments'

200

401

500

200

{
  "items": [
    {
      "comment": "sit velit amet",
      "is_customer_notified": -77656477,
      "is_visible_on_front": 1012491,
      "parent_id": 50748784,
      "created_at": "eiusmod cillum enim velit",
      "entity_id": 67790299,
      "entity_name": "consequat aliqua",
      "status": "dolor",
      "extension_attributes": {}
    },
    {
      "comment": "qui in sint",
      "is_customer_notified": 4792751,
      "is_visible_on_front": 15062830,
      "parent_id": -39993758,
      "created_at": "aliqua adipisicing do",
      "entity_id": -72231422,
      "entity_name": "veniam eiusmod do",
      "status": "mollit occaecat anim consequat",
      "extension_attributes": {}
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "sint irure",
            "value": "pariatur ipsum consectetur",
            "condition_type": "esse Lorem reprehenderit ea"
          },
          {
            "field": "qui",
            "value": "Excepteur amet veli",
            "condition_type": "dolore"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "nulla culpa",
            "value": "est id",
            "condition_type": "id magna ut"
          },
          {
            "field": "elit eu",
            "value": "nulla in officia",
            "condition_type": "officia incididunt"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "pariatur magna id ea eu",
        "direction": "dolore ullamco elit"
      },
      {
        "field": "culpa in labore nisi ipsum",
        "direction": "minim id"
      }
    ],
    "page_size": -43864153,
    "current_page": 27757310
  },
  "total_count": 95113004
}

OK

sales Order Management V1Add Comment Post

Adds a comment to a specified order.

post

/V1/orders/{id}/comments

Path parameters

idstringrequired

(Required) The order ID.

Example: <integer>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"statusHistory":{"comment":"magna","is_customer_notified":-85897747,"is_visible_on_front":93007737,"parent_id":-18219341,"created_at":"sunt sint","entity_id":-55065063,"entity_name":"ullamco proident ea","status":"nulla eiusmod","extension_attributes":{}}}

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/orders/{id}/comments' \
  --header 'Content-Type: application/json' \
  --data '{
    "statusHistory": {
      "comment": "magna",
      "is_customer_notified": -85897747,
      "is_visible_on_front": 93007737,
      "parent_id": -18219341,
      "created_at": "sunt sint",
      "entity_id": -55065063,
      "entity_name": "ullamco proident ea",
      "status": "nulla eiusmod",
      "extension_attributes": {}
    }
  }'

200

401

500

200

true

OK