Send Messages - Delivery/Service

POST 
/api/delivery/msg/:serviceCode

Send Message to a Delivery

Request

Path Parameters

serviceCode stringrequired

Header Parameters

apikey stringrequired

Apikey of a company linked to a user

application/json

Body

message stringrequired

Possible values: non-empty

Message to send

Responses

200

List of messages exchanged between carrier and company for a specific shipment.

application/json

Schema

Schema

data object[]
Array [
_id string
authorId string
authorName string
createdAt string
message string
]
status integer

Example (from schema)

{
  "data": [
    {
      "_id": "string",
      "authorId": "string",
      "authorName": "string",
      "createdAt": "string",
      "message": "string"
    }
  ],
  "status": 0
}

example-1

{
  "data": [
    {
      "_id": "645b78512d4b89b4772ef80e",
      "authorId": "6435ad0719bddd15a0cf7b67",
      "authorName": "Name Lastname",
      "createdAt": "2023-05-10T10:56:17.923Z",
      "message": "no"
    },
    {
      "_id": "645b77bcc3e5269681f33fb4",
      "authorId": "63d7907cbe76403b35da63df",
      "authorName": "User 01 Cia 01",
      "createdAt": "2023-05-10T10:53:48.890Z",
      "message": "yes"
    },
    {
      "_id": "645b74fe03a1ee0efeaabe0f",
      "authorId": "6435ad0719bddd15a0cf7b67",
      "authorName": "Name Lastname",
      "createdAt": "2023-05-10T10:42:06.794Z",
      "message": "new message test"
    }
  ],
  "status": 200
}

Loading...