Comments

sales Shipment Management V1Get Comments List Get

get

Lists comments for a specified shipment.

Path parameters

idstringRequired

(Required) The shipment ID.

Example: <integer>

Responses

200

OK

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/V1/shipment/{id}/comments

HTTPcURLJavaScriptPython

GET /V1/shipment/{id}/comments HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "items": [
    {
      "is_customer_notified": "<integer>",
      "parent_id": "<integer>",
      "comment": "<string>",
      "is_visible_on_front": "<integer>",
      "extension_attributes": "<object>",
      "created_at": "<string>",
      "entity_id": "<integer>"
    },
    {
      "is_customer_notified": "<integer>",
      "parent_id": "<integer>",
      "comment": "<string>",
      "is_visible_on_front": "<integer>",
      "extension_attributes": "<object>",
      "created_at": "<string>",
      "entity_id": "<integer>"
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "aute cillum",
            "value": "in nisi et",
            "condition_type": "culpa in velit id"
          },
          {
            "field": "dolor irure Duis ullamco",
            "value": "",
            "condition_type": "quis ea"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "magna aute officia ea dolore",
            "value": "deserunt dolore labore irure",
            "condition_type": "est"
          },
          {
            "field": "officia minim voluptate qui",
            "value": "consequat occaecat",
            "condition_type": "laborum ad"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "nostrud",
        "direction": "cupidatat sunt"
      },
      {
        "field": "dolor non Excepteur esse cupidatat",
        "direction": "dolor do"
      }
    ],
    "page_size": -53397026,
    "current_page": -24990883
  },
  "total_count": 98418172
}

sales Shipment Comment Repository V1Save Post

post

Performs persist operations for a specified shipment comment.

Path parameters

idstringRequired

(Required)

Example: <string>

Header parameters

Content-TypestringOptionalExample: application/json

Body

application/json

objectOptionalExample: {"entity":{"is_customer_notified":"<integer>","parent_id":"<integer>","comment":"<string>","is_visible_on_front":"<integer>","extension_attributes":"<object>","created_at":"<string>","entity_id":"<integer>"}}

Responses

200

OK

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/V1/shipment/{id}/comments

HTTPcURLJavaScriptPython

POST /V1/shipment/{id}/comments HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 208

{
  "entity": {
    "is_customer_notified": "<integer>",
    "parent_id": "<integer>",
    "comment": "<string>",
    "is_visible_on_front": "<integer>",
    "extension_attributes": "<object>",
    "created_at": "<string>",
    "entity_id": "<integer>"
  }
}

{
  "is_customer_notified": "<integer>",
  "parent_id": "<integer>",
  "comment": "<string>",
  "is_visible_on_front": "<integer>",
  "extension_attributes": "<object>",
  "created_at": "<string>",
  "entity_id": "<integer>"
}