---
updatedAt: 2025-09-10T21:01:06.000Z
agentTools:
  projectIndex: https://shipcars.readme.io/llms.txt
---

# /notification-manager/v1/recommendations/{id}/mark-as-read

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "User Management",
    "description": "Ship.Cars User Management",
    "contact": {
      "url": "https://ship.cars",
      "email": "support@ship.cars"
    },
    "version": "1.0.0"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "oauth2",
        "flows": {
          "password": {
            "tokenUrl": "https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://ship.cars/api"
    }
  ],
  "paths": {
    "/notification-manager/v1/recommendations/{id}/mark-as-read": {
      "post": {
        "tags": [
          "Recommendations Controller"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-Context",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "create_time": {
                      "format": "date-time",
                      "type": "string",
                      "example": "2022-03-10T16:15:50Z"
                    },
                    "update_time": {
                      "format": "date-time",
                      "type": "string",
                      "example": "2022-03-10T16:15:50Z"
                    },
                    "status": {
                      "enum": [
                        "WAITING",
                        "SENT",
                        "SEEN",
                        "READ"
                      ],
                      "type": "string"
                    },
                    "entity": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "pickup_city": {
                          "type": "string"
                        },
                        "pickup_state": {
                          "type": "string"
                        },
                        "pickup_zip": {
                          "type": "string"
                        },
                        "pickup_requested_date_start": {
                          "format": "date",
                          "type": "string",
                          "example": "2022-03-10"
                        },
                        "pickup_requested_date_start_type": {
                          "type": "string"
                        },
                        "pickup_requested_date_end": {
                          "format": "date",
                          "type": "string",
                          "example": "2022-03-10"
                        },
                        "pickup_requested_date_end_type": {
                          "type": "string"
                        },
                        "pickup_address_location": {
                          "type": "object",
                          "properties": {
                            "lat": {
                              "format": "double",
                              "type": "number"
                            },
                            "lon": {
                              "format": "double",
                              "type": "number"
                            }
                          }
                        },
                        "delivery_city": {
                          "type": "string"
                        },
                        "delivery_state": {
                          "type": "string"
                        },
                        "delivery_zip": {
                          "type": "string"
                        },
                        "delivery_requested_date_start": {
                          "format": "date",
                          "type": "string",
                          "example": "2022-03-10"
                        },
                        "delivery_requested_date_start_type": {
                          "type": "string"
                        },
                        "delivery_requested_date_end": {
                          "format": "date",
                          "type": "string",
                          "example": "2022-03-10"
                        },
                        "delivery_requested_date_end_type": {
                          "type": "string"
                        },
                        "delivery_address_location": {
                          "type": "object",
                          "properties": {
                            "lat": {
                              "format": "double",
                              "type": "number"
                            },
                            "lon": {
                              "format": "double",
                              "type": "number"
                            }
                          }
                        },
                        "vehicles": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string"
                              },
                              "year": {
                                "format": "int32",
                                "type": "integer"
                              },
                              "make": {
                                "type": "string"
                              },
                              "model": {
                                "type": "string"
                              },
                              "type": {
                                "type": "string"
                              },
                              "operable": {
                                "type": "boolean"
                              },
                              "url": {
                                "type": "string"
                              },
                              "specifications_data": {
                                "type": "object",
                                "properties": {
                                  "width": {
                                    "type": "object",
                                    "properties": {
                                      "max": {
                                        "format": "double",
                                        "type": "number"
                                      },
                                      "min": {
                                        "format": "double",
                                        "type": "number"
                                      }
                                    }
                                  },
                                  "height": {
                                    "type": "object",
                                    "properties": {
                                      "max": {
                                        "format": "double",
                                        "type": "number"
                                      },
                                      "min": {
                                        "format": "double",
                                        "type": "number"
                                      }
                                    }
                                  },
                                  "length": {
                                    "type": "object",
                                    "properties": {
                                      "max": {
                                        "format": "double",
                                        "type": "number"
                                      },
                                      "min": {
                                        "format": "double",
                                        "type": "number"
                                      }
                                    }
                                  },
                                  "weight": {
                                    "type": "object",
                                    "properties": {
                                      "max": {
                                        "format": "double",
                                        "type": "number"
                                      },
                                      "min": {
                                        "format": "double",
                                        "type": "number"
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        },
                        "total_payment_to_carrier": {
                          "format": "double",
                          "type": "number"
                        },
                        "posted_at_time": {
                          "format": "date-time",
                          "type": "string",
                          "example": "2022-03-10T16:15:50Z"
                        },
                        "distance_imperial": {
                          "format": "int32",
                          "type": "integer"
                        },
                        "price_per_mile": {
                          "format": "double",
                          "type": "number"
                        },
                        "payment_method": {
                          "type": "string"
                        },
                        "payment_on_delivery": {
                          "format": "double",
                          "type": "number"
                        },
                        "payment_on_delivery_method": {
                          "type": "string"
                        },
                        "payment_on_pickup": {
                          "format": "double",
                          "type": "number"
                        },
                        "payment_on_pickup_method": {
                          "type": "string"
                        },
                        "shipper_name": {
                          "type": "string"
                        },
                        "negotiation_state": {
                          "enum": [
                            "POSTED",
                            "REVIEW",
                            "OFFER"
                          ],
                          "type": "string"
                        },
                        "last_offer_expiration_time": {
                          "format": "date-time",
                          "type": "string",
                          "example": "2022-03-10T16:15:50Z"
                        },
                        "shipper_user_management_id": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string"
                        },
                        "shipper_load_id": {
                          "type": "string"
                        },
                        "shipper_id": {
                          "type": "string"
                        },
                        "enclosed_trailer": {
                          "type": "boolean"
                        },
                        "payment_term_begins": {
                          "type": "string"
                        },
                        "payment_term_business_days": {
                          "type": "string"
                        },
                        "can_be_claimed": {
                          "type": "boolean"
                        },
                        "update_time": {
                          "format": "date-time",
                          "type": "string",
                          "example": "2022-03-10T16:15:50Z"
                        },
                        "create_time": {
                          "format": "date-time",
                          "type": "string",
                          "example": "2022-03-10T16:15:50Z"
                        },
                        "posted_externally_time": {
                          "format": "date-time",
                          "type": "string",
                          "example": "2022-03-10T16:15:50Z"
                        },
                        "exclusivity_expiration_time": {
                          "format": "date-time",
                          "type": "string",
                          "example": "2022-03-10T16:15:50Z"
                        },
                        "premium_exclusivity_expiration_time": {
                          "format": "date-time",
                          "type": "string",
                          "example": "2022-03-10T16:15:50Z"
                        },
                        "virtual_trip": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string"
                            },
                            "carrier_user_management_id": {
                              "type": "string"
                            },
                            "name": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    },
                    "type": {
                      "enum": [
                        "RECOMMENDATION"
                      ],
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```