Orders

Create a comment on an order

post/api/v2/partner/orders/{order_id}/comments

Request

  • Base URL: http://localhost:5100
  • URL: http://localhost:5100/api/v2/partner/orders/{order_id}/comments
  • Auth: API key in header Authorization

Path parameters

order_idinteger required

ID of the order

Query parameters

actor_identifierstring required

Identifier of the admin user who is making the comment. For this endpoint this parameter is required, and us used to associate the comment with the right user (unlike elsewhere in the API where this paramater is optionally passed just for audit purposes). The value must correspond to the "parter user identifier" of a suitable admin user. Parter user identifiers are a pre-agreed scheme of unique identifiers, as used by the partner, and set or transferred to vivup via a mechanism such as SSO

Request body

Example request

{
  "organisation_comment_log": {
    "body": "The employee cancelled the order because",
    "comment_sent_to_employee": true
  }
}

Response

Comment added successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "The comment has been successfully added to the order."
}

Changes

No recorded changes to this operation across all 1 revision of this API.