Performs persist operations for a specified shipment comment

POST /V1/shipment/{id}/comments

Performs persist operations for a specified shipment comment.

Path parameters

id string Required

Body

entity object Required

Shipment comment interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. A shipment document can contain comments.
Hide entity attributes Show entity attributes object
- is_customer_notified integer Required
  
  Is-customer-notified flag value.
- parent_id integer Required
  
  Parent ID.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentCommentInterface
- comment string Required
  
  Comment.
- is_visible_on_front integer Required
  
  Is-visible-on-storefront flag value.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Invoice ID.

Responses

200

200 Success.
Hide response attributes Show response attributes object
Shipment comment interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. A shipment document can contain comments.
- is_customer_notified integer Required
  
  Is-customer-notified flag value.
- parent_id integer Required
  
  Parent ID.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentCommentInterface
- comment string Required
  
  Comment.
- is_visible_on_front integer Required
  
  Is-visible-on-storefront flag value.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Invoice ID.
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  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 item
  
  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

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  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 item
  
  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
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  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 item
  
  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

POST /V1/shipment/{id}/comments

curl \
 -X POST https://magento2.winkelstraat.mac/rest/all/V1/shipment/{id}/comments \
 -d '{"entity":{"is_customer_notified":42,"parent_id":42,"extension_attributes":{},"comment":"string","is_visible_on_front":42,"created_at":"string","entity_id":42}}'

Request examples

{
  "entity": {
    "is_customer_notified": 42,
    "parent_id": 42,
    "extension_attributes": {},
    "comment": "string",
    "is_visible_on_front": 42,
    "created_at": "string",
    "entity_id": 42
  }
}

Response examples (200)

{
  "is_customer_notified": 42,
  "parent_id": 42,
  "extension_attributes": {},
  "comment": "string",
  "is_visible_on_front": 42,
  "created_at": "string",
  "entity_id": 42
}

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 (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 (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}