ReDoc documentation

shipment/{id}/comments

shipment/{id}/comments

get/V1/shipment/{id}/comments

Lists comments for a specified shipment.

Request
path Parameters
id
required
integer

The shipment ID.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}

shipment/{id}/comments

post/V1/shipment/{id}/comments

Performs persist operations for a specified shipment comment.

Request
path Parameters
id
required
string
Request Body schema:
required
object (sales-data-shipment-comment-interface)

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.

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "entity": {
    }
}
Response samples
{
  • "is_customer_notified": 0,
  • "parent_id": 0,
  • "extension_attributes": { },
  • "comment": "string",
  • "is_visible_on_front": 0,
  • "created_at": "string",
  • "entity_id": 0
}
➔ Next to shipment/{id}/emails